@siemens/ix 1.2.0 → 1.3.0-beta.0

package/src/components/group-item/readme.md

@@ -1,34 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-group-item
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property            | Attribute            | Description                                                                                         | Type      | Default     |
-| ------------------- | -------------------- | --------------------------------------------------------------------------------------------------- | --------- | ----------- |
-| `focusable`         | `focusable`          | The elements tabindex attribute will get set accordingly. If true tabindex will be 0, -1 otherwise. | `boolean` | `true`      |
-| `icon`              | `icon`               | Group item icon                                                                                     | `string`  | `undefined` |
-| `index`             | `index`              | Index                                                                                               | `number`  | `undefined` |
-| `secondaryText`     | `secondary-text`     | Group item secondary text                                                                           | `string`  | `undefined` |
-| `selected`          | `selected`           | Show selected state                                                                                 | `boolean` | `undefined` |
-| `suppressSelection` | `suppress-selection` | Supress the selection of the group                                                                  | `boolean` | `false`     |
-| `text`              | `text`               | Group item text                                                                                     | `string`  | `undefined` |
-
-
-## Events
-
-| Event             | Description       | Type                                  |
-| ----------------- | ----------------- | ------------------------------------- |
-| `selectedChanged` | Selection changed | `CustomEvent<HTMLIxGroupItemElement>` |
-
-
-----------------------------------------------
-
-

package/src/components/icon/readme.md

@@ -1,23 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-icon
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property | Attribute | Description                                    | Type                           | Default     |
-| -------- | --------- | ---------------------------------------------- | ------------------------------ | ----------- |
-| `color`  | `color`   | Color of the icon                              | `string`                       | `undefined` |
-| `name`   | `name`    | Use one of our defined icon names e.g. `copy`. | `string`                       | `undefined` |
-| `size`   | `size`    | Size of the icon                               | `"12" \| "16" \| "24" \| "32"` | `undefined` |
-
-
-----------------------------------------------
-
-

package/src/components/icon-button/readme.md

@@ -1,31 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-icon-button
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property    | Attribute   | Description                                                                                  | Type                           | Default       |
-| ----------- | ----------- | -------------------------------------------------------------------------------------------- | ------------------------------ | ------------- |
-| `color`     | `color`     | Color of icon in  button                                                                     | `string`                       | `undefined`   |
-| `disabled`  | `disabled`  | Disabled                                                                                     | `boolean`                      | `false`       |
-| `ghost`     | `ghost`     | Button invisible                                                                             | `boolean`                      | `undefined`   |
-| `icon`      | `icon`      | Button icon                                                                                  | `string`                       | `undefined`   |
-| `invisible` | `invisible` | <span style="color:red">**[DEPRECATED]**</span> Use ghost property<br/><br/>Button invisible | `boolean`                      | `undefined`   |
-| `outline`   | `outline`   | Button outline                                                                               | `boolean`                      | `undefined`   |
-| `oval`      | `oval`      | Button in oval shape                                                                         | `boolean`                      | `undefined`   |
-| `selected`  | `selected`  | Selected state only working with outline or invisible                                        | `boolean`                      | `false`       |
-| `size`      | `size`      | Size of icon in button                                                                       | `"12" \| "16" \| "24" \| "32"` | `'24'`        |
-| `type`      | `type`      | Type of the button                                                                           | `"button" \| "submit"`         | `'button'`    |
-| `variant`   | `variant`   | Variant of button                                                                            | `"Primary" \| "Secondary"`     | `'Secondary'` |
-
-
-----------------------------------------------
-
-

package/src/components/input-group/readme.md

@@ -1,14 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-input-group
-
-<!-- Auto Generated Below -->
-
-
-----------------------------------------------
-
-

package/src/components/kpi/readme.md

@@ -1,27 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-kpi
-
-
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property      | Attribute     | Description | Type                                | Default        |
-| ------------- | ------------- | ----------- | ----------------------------------- | -------------- |
-| `label`       | `label`       |             | `string`                            | `undefined`    |
-| `orientation` | `orientation` |             | `"horizontal" \| "vertical"`        | `'horizontal'` |
-| `state`       | `state`       |             | `"alarm" \| "neutral" \| "warning"` | `'neutral'`    |
-| `unit`        | `unit`        |             | `string`                            | `undefined`    |
-| `value`       | `value`       |             | `number \| string`                  | `undefined`    |
-
-
-----------------------------------------------
-
-

package/src/components/map-navigation/readme.md

@@ -1,54 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-map-navigation
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property          | Attribute           | Description                                           | Type      | Default     |
-| ----------------- | ------------------- | ----------------------------------------------------- | --------- | ----------- |
-| `applicationName` | `application-name`  | Application name                                      | `string`  | `undefined` |
-| `hideContextMenu` | `hide-context-menu` | Hide the sidebar context menu button when set to true | `boolean` | `true`      |
-| `navigationTitle` | `navigation-title`  | Navigation title                                      | `string`  | `undefined` |
-
-
-## Events
-
-| Event               | Description          | Type                   |
-| ------------------- | -------------------- | ---------------------- |
-| `contextMenuClick`  | Context menu clicked | `CustomEvent<void>`    |
-| `navigationToggled` | Navigation toggled   | `CustomEvent<boolean>` |
-
-
-## Methods
-
-### `closeOverlay() => Promise<void>`
-
-<span style="color:red">**[DEPRECATED]**</span> Will be removed in 2.0.0. Use slot based approach<br/><br/>Close current shown overlay
-
-#### Returns
-
-Type: `Promise<void>`
-
-
-
-### `openOverlay(name: string, component: HTMLElement, icon?: string, color?: string) => Promise<void>`
-
-<span style="color:red">**[DEPRECATED]**</span> Will be removed in 2.0.0. Use slot based approach<br/><br/>Open a overlay inside content area
-
-#### Returns
-
-Type: `Promise<void>`
-
-
-
-
-----------------------------------------------
-
-

package/src/components/map-navigation-overlay/readme.md

@@ -1,30 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-map-navigation-overlay
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property | Attribute | Description      | Type     | Default     |
-| -------- | --------- | ---------------- | -------- | ----------- |
-| `color`  | `color`   | Color of icon    | `string` | `undefined` |
-| `icon`   | `icon`    | Icon of overlay  | `string` | `undefined` |
-| `name`   | `name`    | Title of overlay | `string` | `undefined` |
-
-
-## Events
-
-| Event        | Description  | Type               |
-| ------------ | ------------ | ------------------ |
-| `closeClick` | Event closed | `CustomEvent<any>` |
-
-
-----------------------------------------------
-
-

package/src/components/menu/readme.md

@@ -1,86 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-menu
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property                 | Attribute                 | Description                                                                                                                                   | Type      | Default                       |
-| ------------------------ | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ----------------------------- |
-| `applicationDescription` | `application-description` | Should only be set if you use ix-menu standalone                                                                                              | `string`  | `''`                          |
-| `applicationName`        | `application-name`        | Should only be set if you use ix-menu standalone                                                                                              | `string`  | `undefined`                   |
-| `enableMapExpand`        | `enable-map-expand`       | Internal                                                                                                                                      | `boolean` | `false`                       |
-| `enableSettings`         | `enable-settings`         | Is settings tab is visible                                                                                                                    | `boolean` | `true`                        |
-| `enableToggleTheme`      | `enable-toggle-theme`     | Show toggle between light and dark variant. Only if the provided theme have implemented both!                                                 | `boolean` | `false`                       |
-| `expand`                 | `expand`                  | Expand menu                                                                                                                                   | `boolean` | `false`                       |
-| `i18nCollapse`           | `i-1-8n-collapse`         |                                                                                                                                               | `string`  | `'Collapse'`                  |
-| `i18nExpand`             | `i-1-8n-expand`           |                                                                                                                                               | `string`  | `' Expand'`                   |
-| `i18nLegal`              | `i-1-8n-legal`            |                                                                                                                                               | `string`  | `'About & legal information'` |
-| `i18nMore`               | `i-1-8n-more`             |                                                                                                                                               | `string`  | `'More…'`                     |
-| `i18nSettings`           | `i-1-8n-settings`         |                                                                                                                                               | `string`  | `'Settings'`                  |
-| `i18nToggleTheme`        | `i-1-8n-toggle-theme`     |                                                                                                                                               | `string`  | `'Toggle theme'`              |
-| `maxVisibleMenuItems`    | `max-visible-menu-items`  | Maximum number of menu items to show in case enough vertical space is available. Extra menu items will be collapsed to 'show more' menu item. | `number`  | `9`                           |
-| `showAbout`              | `show-about`              | Is about tab visible                                                                                                                          | `boolean` | `false`                       |
-| `showSettings`           | `show-settings`           | Is settings tab visible                                                                                                                       | `boolean` | `false`                       |
-
-
-## Events
-
-| Event             | Description          | Type                   |
-| ----------------- | -------------------- | ---------------------- |
-| `expandChange`    | Menu expanded        | `CustomEvent<boolean>` |
-| `mapExpandChange` | Map Sidebar expanded | `CustomEvent<boolean>` |
-
-
-## Methods
-
-### `toggleAbout(show: boolean) => Promise<void>`
-
-Toggle About tabs
-
-#### Returns
-
-Type: `Promise<void>`
-
-
-
-### `toggleMapExpand(show?: boolean) => Promise<void>`
-
-Toggle map sidebar expand
-
-#### Returns
-
-Type: `Promise<void>`
-
-
-
-### `toggleMenu(show?: boolean) => Promise<void>`
-
-Toggle menu
-
-#### Returns
-
-Type: `Promise<void>`
-
-
-
-### `toggleSettings(show: boolean) => Promise<void>`
-
-Toggle Settings tabs
-
-#### Returns
-
-Type: `Promise<void>`
-
-
-
-
-----------------------------------------------
-
-

package/src/components/menu-about/readme.md

@@ -1,30 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-menu-about
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property         | Attribute          | Description        | Type      | Default                       |
-| ---------------- | ------------------ | ------------------ | --------- | ----------------------------- |
-| `activeTabLabel` | `active-tab-label` | Active tab         | `string`  | `undefined`                   |
-| `label`          | `label`            | Label of first tab | `string`  | `'About & legal information'` |
-| `show`           | `show`             | Internal           | `boolean` | `false`                       |
-
-
-## Events
-
-| Event   | Description            | Type                      |
-| ------- | ---------------------- | ------------------------- |
-| `close` | About and Legal closed | `CustomEvent<MouseEvent>` |
-
-
-----------------------------------------------
-
-

package/src/components/menu-about-item/readme.md

@@ -1,21 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-menu-about-item
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property | Attribute | Description      | Type     | Default     |
-| -------- | --------- | ---------------- | -------- | ----------- |
-| `label`  | `label`   | About Item label | `string` | `undefined` |
-
-
-----------------------------------------------
-
-

package/src/components/menu-about-news/readme.md

@@ -1,34 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-menu-about-news
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property         | Attribute          | Description                | Type      | Default       |
-| ---------------- | ------------------ | -------------------------- | --------- | ------------- |
-| `aboutItemLabel` | `about-item-label` | Subtitle of the about news | `string`  | `undefined`   |
-| `expanded`       | `expanded`         | Internal                   | `boolean` | `false`       |
-| `i18nShowMore`   | `i-1-8n-show-more` |                            | `string`  | `'Show more'` |
-| `label`          | `label`            | Title of the about news    | `string`  | `undefined`   |
-| `offsetBottom`   | `offset-bottom`    | Bottom offset              | `number`  | `0`           |
-| `show`           | `show`             | Show about news            | `boolean` | `false`       |
-
-
-## Events
-
-| Event          | Description                 | Type                      |
-| -------------- | --------------------------- | ------------------------- |
-| `closePopover` | Popover closed              | `CustomEvent<void>`       |
-| `showMore`     | Show More button is pressed | `CustomEvent<MouseEvent>` |
-
-
-----------------------------------------------
-
-

package/src/components/menu-avatar/readme.md

@@ -1,30 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-menu-avatar
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property     | Attribute       | Description         | Type     | Default     |
-| ------------ | --------------- | ------------------- | -------- | ----------- |
-| `bottom`     | `bottom`        | Second line of text | `string` | `undefined` |
-| `i18nLogout` | `i-1-8n-logout` |                     | `string` | `'Logout'`  |
-| `top`        | `top`           | First line of text  | `string` | `undefined` |
-
-
-## Events
-
-| Event         | Description  | Type               |
-| ------------- | ------------ | ------------------ |
-| `logoutClick` | Logout click | `CustomEvent<any>` |
-
-
-----------------------------------------------
-
-

package/src/components/menu-avatar-item/readme.md

@@ -1,29 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-menu-avatar-item
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property | Attribute | Description           | Type     | Default     |
-| -------- | --------- | --------------------- | -------- | ----------- |
-| `icon`   | `icon`    | Avatar dropdown icon  | `string` | `undefined` |
-| `label`  | `label`   | Avatar dropdown label | `string` | `undefined` |
-
-
-## Events
-
-| Event       | Description                  | Type                      |
-| ----------- | ---------------------------- | ------------------------- |
-| `itemClick` | Avatar dropdown item clicked | `CustomEvent<MouseEvent>` |
-
-
-----------------------------------------------
-
-

package/src/components/menu-item/readme.md

@@ -1,26 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-menu-item
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property        | Attribute       | Description                                                                                                                                                                                                         | Type      | Default      |
-| --------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------ |
-| `active`        | `active`        | State to display active                                                                                                                                                                                             | `boolean` | `undefined`  |
-| `bottom`        | `bottom`        | <span style="color:red">**[DEPRECATED]**</span> Will be removed in 2.0.0. Replaced by slot based implementation<br/><br/>Caution: this is no longer working. Please use slot="bottom" instead.  Place tab on bottom | `boolean` | `false`      |
-| `disabled`      | `disabled`      | Disable tab and remove event handlers                                                                                                                                                                               | `boolean` | `undefined`  |
-| `home`          | `home`          | Move the Tab to a top position.                                                                                                                                                                                     | `boolean` | `false`      |
-| `notifications` | `notifications` | Show notification cound on tab                                                                                                                                                                                      | `number`  | `undefined`  |
-| `tabIcon`       | `tab-icon`      | Icon name from @siemens/ix-icons                                                                                                                                                                                    | `string`  | `'document'` |
-
-
-----------------------------------------------
-
-

package/src/components/menu-settings/readme.md

@@ -1,30 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-menu-settings
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property         | Attribute          | Description | Type      | Default      |
-| ---------------- | ------------------ | ----------- | --------- | ------------ |
-| `activeTabLabel` | `active-tab-label` | active tab  | `string`  | `undefined`  |
-| `label`          | `label`            | Label       | `string`  | `'Settings'` |
-| `show`           | `show`             | Internal    | `boolean` | `false`      |
-
-
-## Events
-
-| Event   | Description    | Type                      |
-| ------- | -------------- | ------------------------- |
-| `close` | Popover closed | `CustomEvent<MouseEvent>` |
-
-
-----------------------------------------------
-
-

package/src/components/menu-settings-item/readme.md

@@ -1,21 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-menu-settings-item
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property | Attribute | Description | Type     | Default     |
-| -------- | --------- | ----------- | -------- | ----------- |
-| `label`  | `label`   | Label       | `string` | `undefined` |
-
-
-----------------------------------------------
-
-

package/src/components/message-bar/readme.md

@@ -1,31 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# message-bar
-
-
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property      | Attribute     | Description                                                             | Type                              | Default  |
-| ------------- | ------------- | ----------------------------------------------------------------------- | --------------------------------- | -------- |
-| `dismissible` | `dismissible` | If true, close button is enabled and alert can be dismissed by the user | `boolean`                         | `true`   |
-| `type`        | `type`        | Specifies the type of the alert.                                        | `"danger" \| "info" \| "warning"` | `'info'` |
-
-
-## Events
-
-| Event          | Description                                       | Type               |
-| -------------- | ------------------------------------------------- | ------------------ |
-| `closedChange` | An event emitted when the close button is clicked | `CustomEvent<any>` |
-
-
-----------------------------------------------
-
-

package/src/components/modal/readme.md

@@ -1,67 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2022 Siemens AG
-
-SPDX-License-Identifier: MIT
--->
-
-# ix-modal
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property           | Attribute            | Description                                                                                                                                                                  | Type                                                                                      | Default            |
-| ------------------ | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------ |
-| `animation`        | `animation`          | Should the modal be animtated                                                                                                                                                | `boolean`                                                                                 | `true`             |
-| `ariaDescribedBy`  | `aria-described-by`  |                                                                                                                                                                              | `string`                                                                                  | `undefined`        |
-| `ariaLabelledBy`   | `aria-labelled-by`   |                                                                                                                                                                              | `string`                                                                                  | `'modal-title'`    |
-| `backdrop`         | `backdrop`           | Adds a dimming layer to the modal. This should only be used when it it necessary to focus the user's attention to the dialog content (e.g. errors, warnings, complex tasks). | `"static" \| boolean`                                                                     | `true`             |
-| `backdropClass`    | `backdrop-class`     | Backdrop class                                                                                                                                                               | `string`                                                                                  | `undefined`        |
-| `beforeDismiss`    | --                   | BeforeDismiss callback                                                                                                                                                       | `(reason?: any) => boolean \| Promise<boolean>`                                           | `undefined`        |
-| `centered`         | `centered`           | Centered modal                                                                                                                                                               | `boolean`                                                                                 | `false`            |
-| `content`          | `content`            | Content of modal                                                                                                                                                             | `HTMLElement \| string`                                                                   | `undefined`        |
-| `headerTitle`      | `header-title`       | Header title                                                                                                                                                                 | `string`                                                                                  | `undefined`        |
-| `icon`             | `icon`               | Optional icon displayed next to the title                                                                                                                                    | `string`                                                                                  | `undefined`        |
-| `iconColor`        | `icon-color`         | Color of the header {@see ix-icon}                                                                                                                                           | `"color-alarm" \| "color-info" \| "color-std-text" \| "color-success" \| "color-warning"` | `'color-std-text'` |
-| `keyboard`         | `keyboard`           | ESC close modal dialog                                                                                                                                                       | `boolean`                                                                                 | `true`             |
-| `modalDialogClass` | `modal-dialog-class` | Modal dialog class                                                                                                                                                           | `string`                                                                                  | `undefined`        |
-| `scrollable`       | `scrollable`         | Modal scollable                                                                                                                                                              | `boolean`                                                                                 | `true`             |
-| `size`             | `size`               | Modal size                                                                                                                                                                   | `"lg" \| "sm" \| "xl"`                                                                    | `'sm'`             |
-| `windowClass`      | `window-class`       | Window class                                                                                                                                                                 | `string`                                                                                  | `undefined`        |
-
-
-## Events
-
-| Event       | Description     | Type               |
-| ----------- | --------------- | ------------------ |
-| `closed`    | Modal closed    | `CustomEvent<any>` |
-| `dismissed` | Modal dismissed | `CustomEvent<any>` |
-
-
-## Methods
-
-### `close<T = any>(result: T) => Promise<void>`
-
-Close modal
-
-#### Returns
-
-Type: `Promise<void>`
-
-
-
-### `dismiss<T = any>(reason?: T) => Promise<void>`
-
-Dismiss modal instance
-
-#### Returns
-
-Type: `Promise<void>`
-
-
-
-
-----------------------------------------------
-
-