Deploy docs for version 1.1.1-dev.2

iavofficial · Jan 16, 2025 · 71487d4 · 71487d4
1 parent 16b975b
commit 71487d4
Show file tree

Hide file tree

Showing 29 changed files with 3,402 additions and 0 deletions.
diff --git a/1.1.1-dev.2/assets/color-settings/custom-coloring.png b/1.1.1-dev.2/assets/color-settings/custom-coloring.png
diff --git a/1.1.1-dev.2/assets/content-area/content-area.png b/1.1.1-dev.2/assets/content-area/content-area.png
diff --git a/1.1.1-dev.2/assets/index/login.png b/1.1.1-dev.2/assets/index/login.png
diff --git a/1.1.1-dev.2/assets/index/menu.png b/1.1.1-dev.2/assets/index/menu.png
diff --git a/1.1.1-dev.2/assets/information/iav-frontend-framework-darkmode.png b/1.1.1-dev.2/assets/information/iav-frontend-framework-darkmode.png
diff --git a/1.1.1-dev.2/assets/information/styleguide-additional-info.png b/1.1.1-dev.2/assets/information/styleguide-additional-info.png
diff --git a/1.1.1-dev.2/assets/information/styleguide.png b/1.1.1-dev.2/assets/information/styleguide.png
diff --git a/1.1.1-dev.2/assets/information/terminology-definition.png b/1.1.1-dev.2/assets/information/terminology-definition.png
diff --git a/1.1.1-dev.2/color-settings-and-dark-mode.html b/1.1.1-dev.2/color-settings-and-dark-mode.html
diff --git a/1.1.1-dev.2/content-area.html b/1.1.1-dev.2/content-area.html
diff --git a/1.1.1-dev.2/example-project.html b/1.1.1-dev.2/example-project.html
@@ -0,0 +1,54 @@
+<!--
+ Copyright © 2024 IAV GmbH Ingenieurgesellschaft Auto und Verkehr, All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ SPDX-License-Identifier: Apache-2.0
+-->
+
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta content="width=device-width, initial-scale=1.0" name="viewport" />
+    <title>Main Components</title>
+    <script src="./pages/script/nav.js" type="application/javascript"></script>
+    <link href="./pages/styles/styles.css" rel="stylesheet" />
+    <link href="./pages/styles/pages.css" rel="stylesheet" />
+  </head>
+  <body>
+    <h1 id="starting-the-example-project">Starting the Example Project</h1>
+
+    <p class="cell">
+      The framework&#39;s repository contains an example project which is used
+      for development purposes and to present a basic example for framework
+      usage. If you want to start the example project, first you have to clone
+      the framework&#39;s repository.
+    </p>
+    <p class="cell">
+      You can start the example project by executing the command inside the
+      repository&#39;s root folder.
+    </p>
+    <pre class="cell"><code class="lang-bash">npm run run-example
+</code></pre>
+    <p class="cell">
+      The example project does not use a pulled version of the framework.
+      Instead it uses a locally build version of the framework. The mentioned
+      command triggers a new build of the framework and starts the example
+      project using this build. However, changes you make to the framework
+      itself won&#39;t have any effect since the build is just executed once. If
+      you want to play with the framework and see the consequences of your
+      changes in the example project this page is of interest for you.
+    </p>
+  </body>
+</html>
diff --git a/1.1.1-dev.2/faq.html b/1.1.1-dev.2/faq.html
@@ -0,0 +1,67 @@
+<!--
+ Copyright © 2024 IAV GmbH Ingenieurgesellschaft Auto und Verkehr, All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ SPDX-License-Identifier: Apache-2.0
+-->
+
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta content="width=device-width, initial-scale=1.0" name="viewport" />
+    <title>Main Components</title>
+    <script src="./pages/script/nav.js" type="application/javascript"></script>
+    <link href="./pages/styles/styles.css" rel="stylesheet" />
+    <link href="./pages/styles/pages.css" rel="stylesheet" />
+  </head>
+  <body>
+    <h1 id="faq">FAQ</h1>
+    <p class="cell">
+      This page lists common questions and problems and links corresponding
+      issues.
+    </p>
+
+    <h2 id="problems-using-the-svg-format-as-react-component-with-vite">
+      Problems using the SVG format as React Component with Vite
+    </h2>
+    <p class="cell">
+      In a few scenarios, the framework requires the use of SVG Files (e.g.,
+      Icons). To be able to set the color of the SVG inside the Framework, the
+      Icons must be imported as React Components.
+    </p>
+    <p class="cell">
+      Use the following steps to solve issues regarding the SVG import as React
+      Components:
+    </p>
+    <p class="cell">
+      Install the vite-plugin-svgr with the command "npm i vite-plugin-svgr" and
+      configure it as shown
+      <a href="https://www.npmjs.com/package/vite-plugin-svgr">here</a>. If this
+      doesn’t help, further possible solutions can be found
+      <a
+        href="https://stackoverflow.com/questions/74720726/type-definition-for-vite-plugin-svgr"
+        >here</a
+      >.
+    </p>
+
+    <h2 id="can-this-be-used-with-angular">
+      Can the IAV Frontend Framework be used with Angular?
+    </h2>
+    <p class="cell">
+      No, the IAV Frontend Framework only supports React Components and is
+      therefore only suitable for React-based projects.
+    </p>
+  </body>
+</html>