@siemens/ix 1.0.0-beta.2

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

@@ -0,0 +1,30 @@
+<!--
+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

@@ -0,0 +1,21 @@
+<!--
+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

@@ -0,0 +1,31 @@
+<!--
+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

@@ -0,0 +1,67 @@
+<!--
+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 {@link 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(result: any) => Promise<void>`
+
+Close modal
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `dismiss(reason?: any) => Promise<void>`
+
+Dismiss modal instance
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+----------------------------------------------
+
+

package/src/components/modal-container/readme.md

@@ -0,0 +1,29 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# overlay-container
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Methods
+
+### `showModal(config: ModalConfig) => Promise<{ onClose: TypedEvent<any>; onDismiss: TypedEvent<any>; }>`
+
+Display modal dialog
+
+#### Returns
+
+Type: `Promise<{ onClose: TypedEvent<any>; onDismiss: TypedEvent<any>; }>`
+
+
+
+
+----------------------------------------------
+
+

package/src/components/my-component/readme.md

@@ -0,0 +1,16 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# my-component
+
+
+
+<!-- Auto Generated Below -->
+
+
+----------------------------------------------
+
+

package/src/components/pill/readme.md

@@ -0,0 +1,26 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# ix-pill
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property     | Attribute    | Description                                                     | Type                                                                                              | Default     |
+| ------------ | ------------ | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ----------- |
+| `alignLeft`  | `align-left` | Align pill content left                                         | `boolean`                                                                                         | `false`     |
+| `background` | `background` | Custom color for pill. Only working for `variant='custom'`      | `string`                                                                                          | `undefined` |
+| `color`      | `color`      | Custom font color for pill. Only working for `variant='custom'` | `string`                                                                                          | `undefined` |
+| `icon`       | `icon`       | Show icon                                                       | `string`                                                                                          | `undefined` |
+| `outline`    | `outline`    | Show pill as outline                                            | `boolean`                                                                                         | `false`     |
+| `variant`    | `variant`    | Pill variant                                                    | `"alarm" \| "critical" \| "custom" \| "info" \| "neutral" \| "primary" \| "success" \| "warning"` | `'primary'` |
+
+
+----------------------------------------------
+
+

package/src/components/select/readme.md

@@ -0,0 +1,37 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# ix-select
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property                  | Attribute                     | Description                                  | Type                     | Default                     |
+| ------------------------- | ----------------------------- | -------------------------------------------- | ------------------------ | --------------------------- |
+| `allowClear`              | `allow-clear`                 | Show clear button                            | `boolean`                | `false`                     |
+| `disabled`                | `disabled`                    | If true the select will be in disabled state | `boolean`                | `false`                     |
+| `editable`                | `editable`                    | Select is extendable                         | `boolean`                | `false`                     |
+| `i18nPlaceholder`         | `i-1-8n-placeholder`          | Input field placeholder                      | `string`                 | `'Select an option'`        |
+| `i18nPlaceholderEditable` | `i-1-8n-placeholder-editable` | Input field placeholder for editable select  | `string`                 | `'Type of select option'`   |
+| `i18nSelectListHeader`    | `i-1-8n-select-list-header`   | Select list header                           | `string`                 | `'Please select an option'` |
+| `mode`                    | `mode`                        | Selection mode                               | `"multiple" \| "single"` | `'single'`                  |
+| `readonly`                | `readonly`                    | If true the select will be in readonly mode  | `boolean`                | `false`                     |
+| `selectedIndices`         | `selected-indices`            | Indices of selected items                    | `string \| string[]`     | `[]`                        |
+
+
+## Events
+
+| Event                 | Description             | Type                              |
+| --------------------- | ----------------------- | --------------------------------- |
+| `addItem`             | Item added to selection | `CustomEvent<string>`             |
+| `itemSelectionChange` | Item selection changed  | `CustomEvent<string \| string[]>` |
+
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,44 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# ix-select-item
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property             | Attribute  | Description                   | Type      | Default     |
+| -------------------- | ---------- | ----------------------------- | --------- | ----------- |
+| `hover`              | `hover`    | ***Internal***                | `boolean` | `false`     |
+| `label`              | `label`    | Displayed name of the item    | `string`  | `undefined` |
+| `selected`           | `selected` | Whether the item is selected. | `boolean` | `false`     |
+| `value` _(required)_ | `value`    | Item value                    | `any`     | `undefined` |
+
+
+## Events
+
+| Event       | Description  | Type                  |
+| ----------- | ------------ | --------------------- |
+| `itemClick` | Item clicked | `CustomEvent<string>` |
+
+
+## Methods
+
+### `onItemClick(event?: CustomEvent<HTMLIxDropdownItemElement>) => Promise<void>`
+
+Internal
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+----------------------------------------------
+
+

package/src/components/spinner/readme.md

@@ -0,0 +1,22 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# ix-spinner
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property  | Attribute | Description        | Type                                      | Default       |
+| --------- | --------- | ------------------ | ----------------------------------------- | ------------- |
+| `size`    | `size`    | Size of spinner    | `"large" \| "medium"`                     | `'medium'`    |
+| `variant` | `variant` | Variant of spinner | `"primary" \| "secondary" \| "sencodary"` | `'secondary'` |
+
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,36 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# ix-split-button
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property    | Attribute    | Description                                                                                  | Type                                                                                                                                                                                                         | Default          |
+| ----------- | ------------ | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- |
+| `disabled`  | `disabled`   | Disabled                                                                                     | `boolean`                                                                                                                                                                                                    | `false`          |
+| `ghost`     | `ghost`      | Button invisible                                                                             | `boolean`                                                                                                                                                                                                    | `false`          |
+| `icon`      | `icon`       | Button icon                                                                                  | `string`                                                                                                                                                                                                     | `''`             |
+| `invisible` | `invisible`  | <span style="color:red">**[DEPRECATED]**</span> use ghost property<br/><br/>Button invisible | `boolean`                                                                                                                                                                                                    | `false`          |
+| `label`     | `label`      | Button label                                                                                 | `string`                                                                                                                                                                                                     | `undefined`      |
+| `outline`   | `outline`    | Button outline variant                                                                       | `boolean`                                                                                                                                                                                                    | `false`          |
+| `placement` | `placement`  | Placement of the dropdown                                                                    | `"auto" \| "auto-end" \| "auto-start" \| "bottom" \| "bottom-end" \| "bottom-start" \| "left" \| "left-end" \| "left-start" \| "right" \| "right-end" \| "right-start" \| "top" \| "top-end" \| "top-start"` | `'bottom-start'` |
+| `splitIcon` | `split-icon` | Splitbutton icon                                                                             | `string`                                                                                                                                                                                                     | `'context-menu'` |
+| `variant`   | `variant`    | Color variant of button                                                                      | `"Primary" \| "Secondary"`                                                                                                                                                                                   | `'Primary'`      |
+
+
+## Events
+
+| Event         | Description    | Type                      |
+| ------------- | -------------- | ------------------------- |
+| `buttonClick` | Button clicked | `CustomEvent<MouseEvent>` |
+
+
+----------------------------------------------
+
+

package/src/components/split-button-item/readme.md

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

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

@@ -0,0 +1,28 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# ix-tab-item
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property    | Attribute   | Description            | Type                    | Default     |
+| ----------- | ----------- | ---------------------- | ----------------------- | ----------- |
+| `counter`   | `counter`   | Set counter value      | `number`                | `undefined` |
+| `disabled`  | `disabled`  | Set disabled tab       | `boolean`               | `false`     |
+| `icon`      | `icon`      | Set icon only tab      | `boolean`               | `false`     |
+| `layout`    | `layout`    | Set layout width style | `"auto" \| "stretched"` | `'auto'`    |
+| `placement` | `placement` | Set selected placement | `"bottom" \| "top"`     | `'bottom'`  |
+| `rounded`   | `rounded`   | Set rounded tab        | `boolean`               | `false`     |
+| `selected`  | `selected`  | Set selected tab       | `boolean`               | `false`     |
+| `small`     | `small`     | Set small size tab     | `boolean`               | `false`     |
+
+
+----------------------------------------------
+
+

package/src/components/tabs/readme.md

@@ -0,0 +1,25 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# ix-tabs
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property    | Attribute   | Description                       | Type                    | Default    |
+| ----------- | ----------- | --------------------------------- | ----------------------- | ---------- |
+| `layout`    | `layout`    | Set layout width style            | `"auto" \| "stretched"` | `'auto'`   |
+| `placement` | `placement` | Set placement style               | `"bottom" \| "top"`     | `'bottom'` |
+| `rounded`   | `rounded`   | Set rounded tabs                  | `boolean`               | `false`    |
+| `selected`  | `selected`  | Set default selected tab by index | `number`                | `0`        |
+| `small`     | `small`     | Set tab items to small size       | `boolean`               | `false`    |
+
+
+----------------------------------------------
+
+

package/src/components/tile/readme.md

@@ -0,0 +1,21 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# ix-tile
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property | Attribute | Description                                            | Type                           | Default    |
+| -------- | --------- | ------------------------------------------------------ | ------------------------------ | ---------- |
+| `size`   | `size`    | Size of the tile - one of 'small', 'medium' or 'large' | `"big" \| "medium" \| "small"` | `'medium'` |
+
+
+----------------------------------------------
+
+

package/src/components/time-picker/readme.md

@@ -0,0 +1,34 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# ix-time-picker
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property            | Attribute             | Description               | Type                             | Default     |
+| ------------------- | --------------------- | ------------------------- | -------------------------------- | ----------- |
+| `corners`           | `corners`             | Set corners style         | `"left" \| "right" \| "rounded"` | `'rounded'` |
+| `individual`        | `individual`          | set styles                | `boolean`                        | `true`      |
+| `showHour`          | `show-hour`           | Show Hour Input           | `boolean`                        | `false`     |
+| `showMinutes`       | `show-minutes`        | Show Minutes Input        | `boolean`                        | `false`     |
+| `showSeconds`       | `show-seconds`        | Show Seconds Input        | `boolean`                        | `false`     |
+| `showTimeReference` | `show-time-reference` | Show Time Reference Input | `boolean`                        | `false`     |
+
+
+## Events
+
+| Event        | Description       | Type                  |
+| ------------ | ----------------- | --------------------- |
+| `done`       | Time event        | `CustomEvent<string>` |
+| `timeChange` | Time change event | `CustomEvent<string>` |
+
+
+----------------------------------------------
+
+

package/src/components/toast/readme.md

@@ -0,0 +1,36 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# ix-toast-container
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property         | Attribute         | Description | Type     | Default             |
+| ---------------- | ----------------- | ----------- | -------- | ------------------- |
+| `containerClass` | `container-class` |             | `string` | `'toast-container'` |
+| `containerId`    | `container-id`    |             | `string` | `'toast-container'` |
+| `position`       | `position`        |             | `string` | `'bottom-right'`    |
+
+
+## Methods
+
+### `showToast(config: ToastConfig) => Promise<{ onClose: TypedEvent<any>; close: (result?: any) => void; }>`
+
+Display a toast message
+
+#### Returns
+
+Type: `Promise<{ onClose: TypedEvent<any>; close: (result?: any) => void; }>`
+
+
+
+
+----------------------------------------------
+
+

package/src/components/toggle/readme.md

@@ -0,0 +1,35 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# ix-toggle
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property            | Attribute            | Description                                                                                                                                 | Type      | Default    |
+| ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ---------- |
+| `checked`           | `checked`            | Whether the slide-toggle element is checked or not.                                                                                         | `boolean` | `false`    |
+| `color`             | `color`              | <span style="color:red">**[DEPRECATED]**</span> - Has no effect on the rendered control<br/><br/>Basic and status colors from color palette | `string`  | `'accent'` |
+| `disabled`          | `disabled`           | Whether the slide-toggle element is disabled or not.                                                                                        | `boolean` | `false`    |
+| `hideText`          | `hide-text`          | Hide `on` and `off` text                                                                                                                    | `boolean` | `false`    |
+| `indeterminate`     | `indeterminate`      | If true the control is in indeterminate state                                                                                               | `boolean` | `false`    |
+| `textIndeterminate` | `text-indeterminate` | Text for indeterminate state                                                                                                                | `string`  | `'Mixed'`  |
+| `textOff`           | `text-off`           | Text for off state                                                                                                                          | `string`  | `'Off'`    |
+| `textOn`            | `text-on`            | Text for on state                                                                                                                           | `string`  | `'On'`     |
+
+
+## Events
+
+| Event           | Description                                                               | Type                   |
+| --------------- | ------------------------------------------------------------------------- | ---------------------- |
+| `checkedChange` | An event will be dispatched each time the slide-toggle changes its value. | `CustomEvent<boolean>` |
+
+
+----------------------------------------------
+
+

package/src/components/tree/readme.md

@@ -0,0 +1,32 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# ix-tree
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property     | Attribute | Description                               | Type                                                                                                                                | Default     |
+| ------------ | --------- | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------- |
+| `context`    | --        | Selection and collapsed state management  | `{ [x: string]: TreeItemContext; }`                                                                                                 | `{}`        |
+| `model`      | --        | Tree modal                                | `{ [x: string]: TreeItem<any>; }`                                                                                                   | `undefined` |
+| `renderItem` | --        | Render function of tree items             | `<T = any>(index: number, data: T, dataList: T[], context: TreeContext, update: (callback: UpdateCallback) => void) => HTMLElement` | `undefined` |
+| `root`       | `root`    | Initial root element will not be rendered | `string`                                                                                                                            | `undefined` |
+
+
+## Events
+
+| Event           | Description         | Type                                             |
+| --------------- | ------------------- | ------------------------------------------------ |
+| `contextChange` | Context changed     | `CustomEvent<{ [x: string]: TreeItemContext; }>` |
+| `nodeRemoved`   | Emits removed nodes | `CustomEvent<any>`                               |
+
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,31 @@
+<!--
+SPDX-FileCopyrightText: 2022 Siemens AG
+
+SPDX-License-Identifier: MIT
+-->
+
+# ix-tree-item
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property      | Attribute      | Description            | Type              | Default     |
+| ------------- | -------------- | ---------------------- | ----------------- | ----------- |
+| `context`     | --             | Context                | `TreeItemContext` | `undefined` |
+| `hasChildren` | `has-children` | Has tree item children | `boolean`         | `undefined` |
+| `text`        | `text`         | Text                   | `string`          | `undefined` |
+
+
+## Events
+
+| Event       | Description              | Type                |
+| ----------- | ------------------------ | ------------------- |
+| `itemClick` | Clicked                  | `CustomEvent<void>` |
+| `toggle`    | Expand/Collapsed toggled | `CustomEvent<void>` |
+
+
+----------------------------------------------
+
+