npm - @siemens/ix-docs - Versions diffs - 4.4.0 → 5.0.0 - Mend

@siemens/ix-docs 4.4.0 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2401) hide show

package/build/docs/autogenerated/prompt/ix-avatar/readme.md CHANGED Viewed

@@ -6,7 +6,7 @@
 ### Example: application-advanced
 ```html
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en" data-ix-theme="classic" data-ix-color-schema="system">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -43,8 +43,8 @@
           <ix-menu-item icon="plant">Plant</ix-menu-item>
           <ix-menu-item icon="network-device">Network</ix-menu-item>
         </ix-menu-category>
-        <ix-menu-settings></ix-menu-settings>
-        <ix-menu-about></ix-menu-about>
+        <ix-menu-settings suppress-legacy-tabs></ix-menu-settings>
+        <ix-menu-about suppress-legacy-tabs></ix-menu-about>
       </ix-menu>
       <ix-content>
@@ -88,7 +88,7 @@
 ### Example: application-app-switch
 ```html
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en" data-ix-theme="classic" data-ix-color-schema="system">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -178,7 +178,7 @@
 ### Example: application-breakpoints
 ```html
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en" data-ix-theme="classic" data-ix-color-schema="system">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -243,7 +243,7 @@
 ### Example: application-header
 ```html
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en" data-ix-theme="classic" data-ix-color-schema="system">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -260,9 +260,21 @@
     <ix-application-header name="My Application">
       <div class="placeholder-logo" slot="logo"></div>
-      <ix-icon-button variant="tertiary" icon="checkboxes"></ix-icon-button>
-      <ix-icon-button variant="tertiary" icon="checkboxes"></ix-icon-button>
-      <ix-icon-button variant="tertiary" icon="checkboxes"></ix-icon-button>
+      <ix-icon-button
+        aria-label="Button 1"
+        variant="tertiary"
+        icon="checkboxes"
+      ></ix-icon-button>
+      <ix-icon-button
+        aria-label="Button 2"
+        variant="tertiary"
+        icon="checkboxes"
+      ></ix-icon-button>
+      <ix-icon-button
+        aria-label="Button 3"
+        variant="tertiary"
+        icon="checkboxes"
+      ></ix-icon-button>
       <ix-dropdown-button variant="subtle-tertiary" label="Select config">
         <ix-dropdown-item label="Config 1"></ix-dropdown-item>
@@ -270,7 +282,11 @@
         <ix-dropdown-item label="Config 3"></ix-dropdown-item>
       </ix-dropdown-button>
-      <ix-avatar username="John Doe" extra="Administrator">
+      <ix-avatar
+        aria-label="John Doe"
+        username="John Doe"
+        extra="Administrator"
+      >
         <ix-dropdown-item label="Action 1"></ix-dropdown-item>
         <ix-dropdown-item label="Action 2"></ix-dropdown-item>
       </ix-avatar>
@@ -283,7 +299,7 @@
 ### Example: avatar-image
 ```html
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en" data-ix-theme="classic" data-ix-color-schema="system">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -301,7 +317,7 @@
 ### Example: avatar-initials
 ```html
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en" data-ix-theme="classic" data-ix-color-schema="system">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -317,7 +333,7 @@
 ### Example: avatar
 ```html
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en" data-ix-theme="classic" data-ix-color-schema="system">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -397,8 +413,8 @@ export default function ApplicationAdvancedExample() {
             Network
           </IxMenuItem>
         </IxMenuCategory>
-        <IxMenuSettings></IxMenuSettings>
-        <IxMenuAbout></IxMenuAbout>
+        <IxMenuSettings suppressLegacyTabs></IxMenuSettings>
+        <IxMenuAbout suppressLegacyTabs></IxMenuAbout>
       </IxMenu>
       <IxContent>
         <IxContentHeader
@@ -407,7 +423,7 @@ export default function ApplicationAdvancedExample() {
       </IxContent>
     </IxApplication>
   );
-};
+}
 ```
 ### Example: application-app-switch
@@ -988,12 +1004,14 @@ LICENSE file in the root directory of this source tree.
         >Network</ix-menu-item
       >
     </ix-menu-category>
-    <ix-menu-settings></ix-menu-settings>
-    <ix-menu-about></ix-menu-about>
+    <ix-menu-settings suppressLegacyTabs></ix-menu-settings>
+    <ix-menu-about suppressLegacyTabs></ix-menu-about>
   </ix-menu>
   <ix-content>
-    <ix-content-header headerTitle="Example {{ activeContent }} content"></ix-content-header>
+    <ix-content-header
+      headerTitle="Example {{ activeContent }} content"
+    ></ix-content-header>
   </ix-content>
 </ix-application>
@@ -1335,12 +1353,14 @@ LICENSE file in the root directory of this source tree.
         >Network</ix-menu-item
       >
     </ix-menu-category>
-    <ix-menu-settings></ix-menu-settings>
-    <ix-menu-about></ix-menu-about>
+    <ix-menu-settings suppressLegacyTabs></ix-menu-settings>
+    <ix-menu-about suppressLegacyTabs></ix-menu-about>
   </ix-menu>
   <ix-content>
-    <ix-content-header headerTitle="Example {{ activeContent }} content"></ix-content-header>
+    <ix-content-header
+      headerTitle="Example {{ activeContent }} content"
+    ></ix-content-header>
   </ix-content>
 </ix-application>
@@ -1667,15 +1687,14 @@ export default class Avatar {}
 ## Properties
-| Property           | Attribute            | Description                                                                                                                                                                                                                             | Type                  | Default     |
-| ------------------ | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | ----------- |
-| `a11yLabel`        | `a11y-label`         | <span style="color:red">**[DEPRECATED]**</span> Set the native `aria-label` on the ix-avatar host element. Will be removed in 5.0.0<br/><br/>Accessibility label for the image Will be set as aria-label on the nested HTML img element | `string \| undefined` | `undefined` |
-| `ariaLabelTooltip` | `aria-label-tooltip` | aria-label for the tooltip                                                                                                                                                                                                              | `string \| undefined` | `undefined` |
-| `extra`            | `extra`              | Optional description text that will be displayed underneath the username. Note: Only working if avatar is part of the ix-application-header                                                                                             | `string \| undefined` | `undefined` |
-| `image`            | `image`              | Display an avatar image                                                                                                                                                                                                                 | `string \| undefined` | `undefined` |
-| `initials`         | `initials`           | Display the initials of the user. Will be overwritten by image                                                                                                                                                                          | `string \| undefined` | `undefined` |
-| `tooltipText`      | `tooltip-text`       | Text to display in a tooltip when hovering over the avatar                                                                                                                                                                              | `string \| undefined` | `undefined` |
-| `username`         | `username`           | If set an info card displaying the username will be placed inside the dropdown. Note: Only working if avatar is part of the ix-application-header                                                                                       | `string \| undefined` | `undefined` |
+| Property           | Attribute            | Description                                                                                                                                       | Type                  | Default     |
+| ------------------ | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | ----------- |
+| `ariaLabelTooltip` | `aria-label-tooltip` | aria-label for the tooltip                                                                                                                        | `string \| undefined` | `undefined` |
+| `extra`            | `extra`              | Optional description text that will be displayed underneath the username. Note: Only working if avatar is part of the ix-application-header       | `string \| undefined` | `undefined` |
+| `image`            | `image`              | Display an avatar image                                                                                                                           | `string \| undefined` | `undefined` |
+| `initials`         | `initials`           | Display the initials of the user. Will be overwritten by image                                                                                    | `string \| undefined` | `undefined` |
+| `tooltipText`      | `tooltip-text`       | Text to display in a tooltip when hovering over the avatar                                                                                        | `string \| undefined` | `undefined` |
+| `username`         | `username`           | If set an info card displaying the username will be placed inside the dropdown. Note: Only working if avatar is part of the ix-application-header | `string \| undefined` | `undefined` |
 ## Dependencies

package/build/docs/autogenerated/prompt/ix-blind/readme.md CHANGED Viewed

@@ -6,7 +6,7 @@
 ### Example: blind-header-actions
 ```html
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en" data-ix-theme="classic" data-ix-color-schema="system">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -46,7 +46,7 @@
 ### Example: blind-variants
 ```html
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en" data-ix-theme="classic" data-ix-color-schema="system">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -98,7 +98,7 @@
 ### Example: blind
 ```html
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en" data-ix-theme="classic" data-ix-color-schema="system">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />