fix(docs/general): improvements (#1307)

siemens · Jul 30, 2024 · db678ea · db678ea
1 parent b4a306e
commit db678ea
Show file tree

Hide file tree

Showing 99 changed files with 1,427 additions and 820 deletions.
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2022 Siemens AG
+ * SPDX-FileCopyrightText: 2024 Siemens AG
  *
  * SPDX-License-Identifier: MIT
  *

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -2,6 +2,9 @@
 SPDX-FileCopyrightText: 2024 Siemens AG
 
 SPDX-License-Identifier: MIT
+
+This source code is licensed under the MIT license found in the
+LICENSE file in the root directory of this source tree.
 -->
 
 # Code of Conduct

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,6 +2,9 @@
 SPDX-FileCopyrightText: 2024 Siemens AG
 
 SPDX-License-Identifier: MIT
+
+This source code is licensed under the MIT license found in the
+LICENSE file in the root directory of this source tree.
 -->
 
 

diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -2,6 +2,9 @@
 SPDX-FileCopyrightText: 2024 Siemens AG
 
 SPDX-License-Identifier: MIT
+
+This source code is licensed under the MIT license found in the
+LICENSE file in the root directory of this source tree.
 -->
 
 Lukas Maurer <[email protected]>

diff --git a/RELEASE-READINESS.md b/RELEASE-READINESS.md
@@ -2,6 +2,9 @@
 SPDX-FileCopyrightText: 2024 Siemens AG
 
 SPDX-License-Identifier: MIT
+
+This source code is licensed under the MIT license found in the
+LICENSE file in the root directory of this source tree.
 -->
 
 All features/fixes satisfy their respective DoD

diff --git a/SECURITY.md b/SECURITY.md
@@ -2,6 +2,9 @@
 SPDX-FileCopyrightText: 2024 Siemens AG
 
 SPDX-License-Identifier: MIT
+
+This source code is licensed under the MIT license found in the
+LICENSE file in the root directory of this source tree.
 -->
 
 # Reporting Security Issues

diff --git a/packages/angular-test-app/src/app/app-routing.module.ts b/packages/angular-test-app/src/app/app-routing.module.ts
@@ -121,6 +121,7 @@ import Toast from 'src/preview-examples/toast';
 import ToastCustom from 'src/preview-examples/toast-custom';
 import ToastPosition from 'src/preview-examples/toast-position';
 import Toggle from 'src/preview-examples/toggle';
+import ToggleButtonPrimary from 'src/preview-examples/toggle-button-primary';
 import ToggleButtonPrimaryGhost from 'src/preview-examples/toggle-button-primary-ghost';
 import ToggleButtonPrimaryOutline from 'src/preview-examples/toggle-button-primary-outline';
 import ToggleButtonSecondary from 'src/preview-examples/toggle-button-secondary';
@@ -371,6 +372,7 @@ const routes: Routes = [
       { path: 'theme-switcher', component: ThemeService },
       { path: 'tile', component: Tile },
       { path: 'timepicker', component: Timepicker },
+      { path: 'toggle-button-primary', component: ToggleButtonPrimary },
       { path: 'toggle-button-secondary', component: ToggleButtonSecondary },
       {
         path: 'toggle-button-secondary-ghost',

diff --git a/packages/angular-test-app/src/app/app.module.ts b/packages/angular-test-app/src/app/app.module.ts
@@ -130,6 +130,7 @@ import Toast from 'src/preview-examples/toast';
 import ToastCustom from 'src/preview-examples/toast-custom';
 import ToastPosition from 'src/preview-examples/toast-position';
 import Toggle from 'src/preview-examples/toggle';
+import ToggleButtonPrimary from 'src/preview-examples/toggle-button-primary';
 import ToggleButtonPrimaryGhost from 'src/preview-examples/toggle-button-primary-ghost';
 import ToggleButtonPrimaryOutline from 'src/preview-examples/toggle-button-primary-outline';
 import ToggleButtonSecondary from 'src/preview-examples/toggle-button-secondary';
@@ -241,6 +242,7 @@ import Echarts from 'src/preview-examples/echarts';
     ThemeSwitcherExample,
     Tile,
     Timepicker,
+    ToggleButtonPrimary,
     ToggleButtonPrimaryGhost,
     ToggleButtonPrimaryOutline,
     ToggleButtonSecondary,

diff --git a/packages/angular-test-app/src/preview-examples/toggle-button-primary.ts b/packages/angular-test-app/src/preview-examples/toggle-button-primary.ts
@@ -0,0 +1,26 @@
+/*
+ * SPDX-FileCopyrightText: 2024 Siemens AG
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { Component } from '@angular/core';
+
+@Component({
+  selector: 'app-example',
+  template: `
+    <ix-toggle-button variant="Primary">Normal</ix-toggle-button>
+    <ix-toggle-button variant="Primary" Pressed> Pressed </ix-toggle-button>
+    <ix-toggle-button variant="Primary" disabled> Disabled </ix-toggle-button>
+    <ix-toggle-button variant="Primary" disabled loading> Loading </ix-toggle-button>
+  `,
+  styles: [
+    `
+      @import 'example-styles/dist/toggle-buttons.css';
+    `,
+  ],
+})
+export default class Buttons {}
diff --git a/packages/angular/src/components.ts b/packages/angular/src/components.ts
@@ -368,7 +368,7 @@ import type { FilterState as IIxCategoryFilterFilterState } from '@siemens/ix';
 
 export declare interface IxCategoryFilter extends Components.IxCategoryFilter {
   /**
-   * Event dispatched whenever the a category gets selected in the dropdown
+   * Event dispatched whenever a category gets selected in the dropdown
    */
   categoryChanged: EventEmitter<CustomEvent<string>>;
   /**

diff --git a/packages/core/component-doc.json b/packages/core/component-doc.json
@@ -2079,7 +2079,7 @@
           },
           "mutable": false,
           "reflectToAttr": false,
-          "docs": "Configuration object hash used to populate the dropwdown menu for typeahead and quick selection functionality.\nEach ID maps to an object with a label and an array of options to select from.",
+          "docs": "Configuration object hash used to populate the dropdown menu for type-ahead and quick selection functionality.\nEach ID maps to an object with a label and an array of options to select from.",
           "docsTags": [],
           "values": [
             {
@@ -2299,7 +2299,7 @@
           "mutable": false,
           "attr": "repeat-categories",
           "reflectToAttr": false,
-          "docs": "If set to true allows that a single category can be set more than once.\nAn already set category will not appear in the category dropdown if set to false.\n\nDefaults to true",
+          "docs": "If set to true, allows that a single category can be set more than once.\nAn already set category will not appear in the category dropdown if set to false.\n\nDefaults to true",
           "docsTags": [],
           "default": "true",
           "values": [
@@ -2355,7 +2355,7 @@
           },
           "mutable": false,
           "reflectToAttr": false,
-          "docs": "A list of strings that will be supplied as typeahead suggestions not tied to any categories.",
+          "docs": "A list of strings that will be supplied as type-ahead suggestions not tied to any categories.",
           "docsTags": [],
           "values": [
             {
@@ -2379,7 +2379,7 @@
           },
           "cancelable": true,
           "composed": true,
-          "docs": "Event dispatched whenever the a category gets selected in the dropdown",
+          "docs": "Event dispatched whenever a category gets selected in the dropdown",
           "docsTags": []
         },
         {

diff --git a/packages/core/src/components.d.ts b/packages/core/src/components.d.ts
@@ -359,7 +359,7 @@ export namespace Components {
     }
     interface IxCategoryFilter {
         /**
-          * Configuration object hash used to populate the dropwdown menu for typeahead and quick selection functionality. Each ID maps to an object with a label and an array of options to select from.
+          * Configuration object hash used to populate the dropdown menu for type-ahead and quick selection functionality. Each ID maps to an object with a label and an array of options to select from.
          */
         "categories": {
     [id: string]: {
@@ -406,7 +406,7 @@ export namespace Components {
          */
         "readonly": boolean;
         /**
-          * If set to true allows that a single category can be set more than once. An already set category will not appear in the category dropdown if set to false.  Defaults to true
+          * If set to true, allows that a single category can be set more than once. An already set category will not appear in the category dropdown if set to false.  Defaults to true
          */
         "repeatCategories": boolean;
         /**
@@ -415,7 +415,7 @@ export namespace Components {
          */
         "staticOperator"?: LogicalFilterOperator;
         /**
-          * A list of strings that will be supplied as typeahead suggestions not tied to any categories.
+          * A list of strings that will be supplied as type-ahead suggestions not tied to any categories.
          */
         "suggestions": string[];
         "tmpDisableScrollIntoView": boolean;
@@ -4411,7 +4411,7 @@ declare namespace LocalJSX {
     }
     interface IxCategoryFilter {
         /**
-          * Configuration object hash used to populate the dropwdown menu for typeahead and quick selection functionality. Each ID maps to an object with a label and an array of options to select from.
+          * Configuration object hash used to populate the dropdown menu for type-ahead and quick selection functionality. Each ID maps to an object with a label and an array of options to select from.
          */
         "categories"?: {
     [id: string]: {
@@ -4450,7 +4450,7 @@ declare namespace LocalJSX {
     [id: string]: string;
   };
         /**
-          * Event dispatched whenever the a category gets selected in the dropdown
+          * Event dispatched whenever a category gets selected in the dropdown
          */
         "onCategoryChanged"?: (event: IxCategoryFilterCustomEvent<string>) => void;
         /**
@@ -4470,7 +4470,7 @@ declare namespace LocalJSX {
          */
         "readonly"?: boolean;
         /**
-          * If set to true allows that a single category can be set more than once. An already set category will not appear in the category dropdown if set to false.  Defaults to true
+          * If set to true, allows that a single category can be set more than once. An already set category will not appear in the category dropdown if set to false.  Defaults to true
          */
         "repeatCategories"?: boolean;
         /**
@@ -4479,7 +4479,7 @@ declare namespace LocalJSX {
          */
         "staticOperator"?: LogicalFilterOperator;
         /**
-          * A list of strings that will be supplied as typeahead suggestions not tied to any categories.
+          * A list of strings that will be supplied as type-ahead suggestions not tied to any categories.
          */
         "suggestions"?: string[];
         "tmpDisableScrollIntoView"?: boolean;

diff --git a/packages/core/src/components/category-filter/category-filter.tsx b/packages/core/src/components/category-filter/category-filter.tsx
@@ -69,7 +69,7 @@ export class CategoryFilter {
   @Prop() placeholder: string;
 
   /**
-   * Configuration object hash used to populate the dropwdown menu for typeahead and quick selection functionality.
+   * Configuration object hash used to populate the dropdown menu for type-ahead and quick selection functionality.
    * Each ID maps to an object with a label and an array of options to select from.
    */
   @Prop() categories: {
@@ -91,7 +91,7 @@ export class CategoryFilter {
   } = {};
 
   /**
-   * A list of strings that will be supplied as typeahead suggestions not tied to any categories.
+   * A list of strings that will be supplied as type-ahead suggestions not tied to any categories.
    */
   @Prop() suggestions: string[];
 
@@ -116,7 +116,7 @@ export class CategoryFilter {
   @Prop() staticOperator?: LogicalFilterOperator;
 
   /**
-   * If set to true allows that a single category can be set more than once.
+   * If set to true, allows that a single category can be set more than once.
    * An already set category will not appear in the category dropdown if set to false.
    *
    * Defaults to true
@@ -139,7 +139,7 @@ export class CategoryFilter {
   @Prop() i18nPlainText = 'Filter by text';
 
   /**
-   * Event dispatched whenever the a category gets selected in the dropdown
+   * Event dispatched whenever a category gets selected in the dropdown
    */
   @Event() categoryChanged: EventEmitter<string>;
 

diff --git a/packages/documentation/docs/controls/_avatar_code.md b/packages/documentation/docs/controls/_avatar_code.md
@@ -1,41 +1,48 @@
-import Playground from '@site/src/components/PlaygroundV2';
 import Props from './../auto-generated/ix-avatar/props.md';
 import Events from './../auto-generated/ix-avatar/events.md';
-import Tags from './../auto-generated/ix-avatar/tags.md';
 
-# Avatar
+import Playground from '@site/src/components/PlaygroundV2';
 
-<Tags />
+## Examples
 
-## Default
+### Basic
 
 <Playground
-name="avatar"
-examplesByName>
+  name="avatar"
+  examplesByName>
 </Playground>
 
-## Initials
+### Initials
 
 <Playground
-name="avatar-initials"
-examplesByName>
+  name="avatar-initials"
+  examplesByName>
 </Playground>
 
-## Image
+### Image
 
 <Playground
-name="avatar-image"
-examplesByName>
+  name="avatar-image"
+  examplesByName>
 </Playground>
 
-## Header
+### Header
 
-You can also add the avatar to the header which will turn it into a clickable button.
+You can also add the avatar to the header, which will turn it into a clickable button.
 
-<Playground name="application-header" examplesByName noMargin height="21rem"></Playground>
+<Playground 
+  name="application-header" 
+  examplesByName 
+  noMargin 
+  height="21rem">
+</Playground>
 
-## Properties
+## API
 
-### Props
+### Properties
 
 <Props />
+
+### Events 
+
+<Events />
diff --git a/packages/documentation/docs/controls/_blind_code.md b/packages/documentation/docs/controls/_blind_code.md
@@ -1,42 +1,45 @@
 import { ApiTableSinceTag } from '@site/src/components/ApiTableTag';
 
-import TabItem from '@theme/TabItem';
 import Preview from '@site/src/components/Preview';
 import Props from './../auto-generated/ix-blind/props.md';
 import Events from './../auto-generated/ix-blind/events.md';
 
 import Playground from '@site/src/components/PlaygroundV2'
 
+## Examples
+
 <Playground
-name="blind"
-height="16rem"
-examplesByName>
+  name="blind"
+  height="16rem"
+  examplesByName>
 </Playground>
 
 ### Header actions
 
 <ApiTableSinceTag message="1.5.0" />
 
 <Playground
-name="blind-header-actions"
-height="16rem"
-examplesByName>
+  name="blind-header-actions"
+  height="16rem"
+  examplesByName>
 </Playground>
 
+### Variants
+
 <ApiTableSinceTag message="2.0.0" />
 
 <Playground
-name="blind-variants"
-height="16rem"
-examplesByName>
+  name="blind-variants"
+  height="55rem"
+  examplesByName>
 </Playground>
 
-### Properties
+## API
 
-#### Props
+### Properties
 
 <Props />
 
-#### Events
+### Events
 
 <Events />