@siemens/ix 5.1.0 → 5.2.0

package/dist/types/components/chat-input/chat-input.d.ts

@@ -0,0 +1,175 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+declare const ChatInput_base: abstract new (...args: any[]) => {
+    componentDidLoad(): void;
+    disconnectedCallback(): void;
+    hostElement?: import("@stencil/core/internal").HTMLStencilElement;
+    connectedCallback?(): void;
+    componentWillRender?(): Promise<void> | void;
+    componentDidRender?(): void;
+    componentWillLoad?(): Promise<void> | void;
+    componentShouldUpdate?(newVal: any, oldVal: any, propName: string): boolean | void;
+    componentWillUpdate?(): Promise<void> | void;
+    componentDidUpdate?(): void;
+    render?(): any;
+} & import("../utils/internal/component").StencilLifecycle & {
+    $internal_id: number;
+    getHostElementId(): string;
+    hostElement?: import("@stencil/core/internal").HTMLStencilElement;
+    connectedCallback?(): void;
+    disconnectedCallback?(): void;
+    componentWillRender?(): Promise<void> | void;
+    componentDidRender?(): void;
+    componentWillLoad?(): Promise<void> | void;
+    componentDidLoad?(): void;
+    componentShouldUpdate?(newVal: any, oldVal: any, propName: string): boolean | void;
+    componentWillUpdate?(): Promise<void> | void;
+    componentDidUpdate?(): void;
+    render?(): any;
+};
+/**
+ * @since 5.2.0
+ * @form-ready
+ * @slot follow-up - Optional refresh action and follow-up prompt buttons displayed above the chat input
+ * @slot attachments - Attachments displayed above the prompt text area
+ * @slot start - Element will be displayed in the left action area
+ * @slot end - Element will be displayed in the right action area before the submit button
+ */
+export declare class ChatInput extends ChatInput_base {
+    hostElement: HTMLIxChatInputElement;
+    formInternals: ElementInternals;
+    /**
+     * The state of the chat input, which can be either 'input' or 'processing'.
+     */
+    state?: 'input' | 'processing';
+    /**
+     * The name of the chat input.
+     */
+    name?: string;
+    /**
+     * The placeholder text for the chat input.
+     */
+    placeholder: string;
+    /**
+     * The value of the chat input.
+     */
+    value: string;
+    /**
+     * Specifies whether the chat input is disabled.
+     */
+    disabled: boolean;
+    /**
+     * Specifies whether the chat input is readonly.
+     */
+    readonly: boolean;
+    /**
+     * Accessible label for the native textarea.
+     */
+    textareaLabel: string;
+    /**
+     * The maximum length of the chat input.
+     */
+    maxLength?: number;
+    /**
+     * Character limit used for the optional inline character limit message.
+     * Falls back to `maxLength` when not set.
+     */
+    characterLimit?: number;
+    /**
+     * i18n label for the hard character limit message.
+     * Use `{current}` and `{limit}` placeholders to place the values in any order.
+     */
+    i18nCharacterLimitReached: string;
+    /**
+     * i18n label for the soft character limit warning.
+     * Use `{current}` and `{limit}` placeholders to place the values in any order.
+     */
+    i18nCharacterLimitWarning: string;
+    /**
+     * Percentage of the character limit that triggers the soft warning. Define a number between 0 and 1 (e.g. 0.8 for 80%).
+     */
+    characterLimitWarningThreshold: number;
+    /**
+     * Minimum number of visible text rows.
+     */
+    minRows: number;
+    /**
+     * Maximum number of visible text rows before the input becomes scrollable.
+     */
+    maxRows: number;
+    /**
+     * If true, pressing Enter inserts a line break instead of submitting the prompt.
+     */
+    insertLineBreakOnEnter: boolean;
+    /**
+     * Disclaimer text displayed below the chat input.
+     */
+    disclaimer: string;
+    /**
+     * Event emitted when the value of the chat input changes.
+     */
+    valueChange: EventEmitter<string>;
+    /**
+     * Event emitted when the chat input loses focus.
+     */
+    ixBlur: EventEmitter<void>;
+    /**
+     * Event emitted when the chat input loses focus and the value has changed.
+     */
+    ixChange: EventEmitter<string>;
+    /**
+     * Event emitted when the prompt is submitted by the send button or Enter key.
+     */
+    promptSubmit: EventEmitter<string>;
+    /** @internal */
+    initialValue?: string;
+    hasAttachments: boolean;
+    hasAttachmentScrollbar: boolean;
+    hasFollowUp: boolean;
+    private readonly attachmentsRef;
+    private readonly textareaRef;
+    private attachmentResizeObserver?;
+    private attachmentMutationObserver?;
+    private isAttachmentScrollbarUpdateQueued;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    componentDidRender(): void;
+    disconnectedCallback(): void;
+    onValueChange(value: string): void;
+    onRowsChange(): void;
+    updateFormInternalValue(value: string): void;
+    /** @internal */
+    getAssociatedFormElement(): Promise<HTMLFormElement | null>;
+    /**
+     * Returns the native textarea element used by the chat input.
+     * @since 5.1.0
+     */
+    getNativeInputElement(): Promise<HTMLTextAreaElement>;
+    /**
+     * Focuses the chat input.
+     * @since 5.1.0
+     */
+    focusInput(): Promise<void>;
+    private canSubmit;
+    private emitIxChangeIfNeeded;
+    private submitPrompt;
+    private updateTextareaHeight;
+    private getCharacterLimit;
+    private getNormalizedCharacterLimitWarningThreshold;
+    private isSoftCharacterLimitWarning;
+    private isCharacterLimitReached;
+    private getCharacterLimitMessage;
+    private formatCharacterLimitMessage;
+    private getCharacterLimitState;
+    private handleKeyDown;
+    private renderCharacterLimit;
+    private handleAttachmentsSlotChange;
+    private handleFollowUpSlotChange;
+    private hasAssignedContent;
+    private updateHasFollowUp;
+    private initAttachmentResizeObserver;
+    private initAttachmentMutationObserver;
+    private scheduleAttachmentScrollbarUpdate;
+    private updateAttachmentScrollbar;
+    render(): any;
+}
+export {};

package/dist/types/components/chat-user-message/chat-user-message.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @since 5.2.0
+ * @slot - Message content displayed in the user message bubble
+ * @slot actions - Optional actions displayed below the user message bubble
+ * @slot attachments - ix-chat-attachment elements with variant="sent" displayed above the user message bubble
+ */
+export declare class ChatUserMessage {
+    hostElement: HTMLIxChatUserMessageElement;
+    /**
+     * Text displayed in the user message bubble.
+     */
+    message?: string;
+    hasActions: boolean;
+    hasAttachments: boolean;
+    hasMessageContent: boolean;
+    componentWillLoad(): void;
+    private handleActionsSlotChange;
+    private handleAttachmentsSlotChange;
+    private handleMessageSlotChange;
+    private hasAssignedMessageContent;
+    private updateHasMessageContent;
+    render(): any;
+}

package/dist/types/components/checkbox/checkbox.d.ts

@@ -2,6 +2,7 @@ import { EventEmitter } from '../../stencil-public-runtime';
 import { IxFormComponent } from '../utils/input';
 /**
  * @form-ready
+ * @slot default - Checkbox label.
  */
 export declare class Checkbox implements IxFormComponent<string> {
     hostElement: HTMLIxCheckboxElement;

package/dist/types/components/checkbox-group/checkbox-group.d.ts

@@ -2,6 +2,7 @@ import { FieldWrapperInterface, IxFormValidationState, ValidationResults } from
 import { IxComponentInterface } from '../utils/internal';
 /**
  * @form-ready
+ * @slot default - Checkboxes displayed in the group.
  */
 export declare class CheckboxGroup implements FieldWrapperInterface, IxFormValidationState, IxComponentInterface {
     hostElement: HTMLIxCheckboxGroupElement;

package/dist/types/components/chip/chip.d.ts

@@ -30,6 +30,9 @@ declare const Chip_base: abstract new (...args: any[]) => {
     componentDidUpdate?(): void;
     render?(): any;
 };
+/**
+ * @slot default - Chip label.
+ */
 export declare class Chip extends Chip_base implements InheritAriaAttributesMixinContract {
     hostElement: HTMLIxChipElement;
     /**
@@ -39,7 +42,7 @@ export declare class Chip extends Chip_base implements InheritAriaAttributesMixi
     variant: ChipVariant;
     /**
      * Determines if the chip is interactive. If true no user input (e.g. mouse states, keyboard navigation)
-     * will be possible and also the close button will not be present.
+     * will be possible on the main chip content.
      */
     inactive: boolean;
     /**

package/dist/types/components/col/col.d.ts

@@ -1,6 +1,9 @@
 import { Breakpoint } from '../utils/breakpoints';
 import type { ColumnSize } from './col.types';
 type GridBreakpoint = Breakpoint | '';
+/**
+ * @slot default - Column content.
+ */
 export declare class Col {
     static Breakpoints: GridBreakpoint[];
     /**

package/dist/types/components/content/content.d.ts

@@ -1,5 +1,6 @@
 /**
  * @slot header - Display content at the top of the content page
+ * @slot default - Main page content.
  */
 export declare class Content {
     hostElement: HTMLIxContentElement;

package/dist/types/components/content-header/content-header.d.ts

@@ -2,7 +2,7 @@ import { EventEmitter } from '../../stencil-public-runtime';
 import type { ContentHeaderVariant } from './content-header.types';
 /**
  * @slot header - Content to be placed in the header area next to the title
- * @slot - Default slot for action buttons or other content
+ * @slot default - Default slot for action buttons or other content
  */
 export declare class ContentHeader {
     /**

package/dist/types/components/css-grid/css-grid-item.d.ts

@@ -1,5 +1,6 @@
 /**
  * @internal
+ * @slot default - Grid item content.
  */
 export declare class CssGridItem {
     /**

package/dist/types/components/css-grid/css-grid.d.ts

@@ -1,6 +1,7 @@
 import type { CssGridTemplateType } from './css-grid.types';
 /**
  * @internal
+ * @slot default - Grid items arranged by the configured template.
  */
 export declare class CssGrid {
     /**

package/dist/types/components/custom-field/custom-field.d.ts

@@ -1,5 +1,8 @@
 import { FieldWrapperInterface, IxFormValidationState, ValidationResults } from '../utils/input';
 import { IxComponentInterface } from '../utils/internal';
+/**
+ * @slot default - The form control.
+ */
 export declare class CustomField implements FieldWrapperInterface, IxFormValidationState, IxComponentInterface {
     hostElement: HTMLIxCustomFieldElement;
     /**

package/dist/types/components/dropdown/dropdown.d.ts

@@ -16,6 +16,9 @@ declare const Dropdown_base: abstract new (...args: any[]) => {
     componentDidUpdate?(): void;
     render?(): any;
 } & import("../utils/internal/component").StencilLifecycle;
+/**
+ * @slot default - Dropdown items.
+ */
 export declare class Dropdown extends Dropdown_base implements DropdownInterface {
     hostElement: HTMLIxDropdownElement;
     /**

package/dist/types/components/dropdown-button/dropdown-button.d.ts

@@ -48,6 +48,10 @@ declare const DropdownButton_base: abstract new (...args: any[]) => {
     componentDidUpdate?(): void;
     render?(): any;
 };
+/**
+ * @slot button-label - Custom content displayed next to the button label.
+ * @slot default - Dropdown items.
+ */
 export declare class DropdownButton extends DropdownButton_base implements AriaActiveDescendantMixinContract, ComponentIdMixinContract {
     hostElement: HTMLIxDropdownButtonElement;
     /**

package/dist/types/components/dropdown-item/dropdown-item.d.ts

@@ -44,6 +44,9 @@ declare const DropdownItem_base: abstract new (...args: any[]) => {
     componentDidUpdate?(): void;
     render?(): any;
 };
+/**
+ * @slot default - Dropdown item content.
+ */
 export declare class DropdownItem extends DropdownItem_base implements DropdownItemWrapper, ComponentIdMixinContract {
     hostElement: HTMLIxDropdownItemElement;
     /**

package/dist/types/components/dropdown-quick-actions/dropdown-quick-actions.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @slot default - Quick action items.
+ */
 export declare class DropdownQuickActions {
     render(): any;
 }

package/dist/types/components/event-list/event-list.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @slot default - Event list items.
+ */
 export declare class EventList {
     private readonly mutationObserver;
     private static readonly fadeOutDuration;

package/dist/types/components/event-list-item/event-list-item.d.ts

@@ -1,4 +1,7 @@
 import { EventEmitter } from '../../stencil-public-runtime';
+/**
+ * @slot default - Event list item content.
+ */
 export declare class EventListItem {
     /**
      * Variant of the event list item

package/dist/types/components/field-label/field-label.d.ts

@@ -1,5 +1,8 @@
 import { IxComponentInterface } from '../utils/internal';
 import { MakeRef } from '../utils/make-ref';
+/**
+ * @slot default - Field label content.
+ */
 export declare class FormFieldLabel implements IxComponentInterface {
     hostElement: HTMLIxFieldLabelElement;
     /**

package/dist/types/components/filter-chip/filter-chip.d.ts

@@ -1,4 +1,7 @@
 import { EventEmitter } from '../../stencil-public-runtime';
+/**
+ * @slot default - Filter chip label.
+ */
 export declare class FilterChip {
     hostElement: HTMLIxFilterChipElement;
     /**

package/dist/types/components/flip-tile/flip-tile.d.ts

@@ -1,5 +1,10 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 import { FlipTileVariant } from './flip-tile.types';
+/**
+ * @slot header - Content displayed in the tile header.
+ * @slot default - Flip tile pages.
+ * @slot footer - Content displayed in the tile footer.
+ */
 export declare class FlipTile {
     hostElement: HTMLIxFlipTileElement;
     /**

package/dist/types/components/flip-tile-content/flip-tile-content.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @slot default - Flip tile body content.
+ */
 export declare class FlipTileContent {
     /**
      * Controls the visibility of the content

package/dist/types/components/group/group-context-menu.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @slot default - Context menu items.
+ */
 export declare class GroupContextMenu {
     hostElement: HTMLIxGroupContextMenuElement;
     showContextMenu: boolean;

package/dist/types/components/group/group.d.ts

@@ -1,4 +1,10 @@
 import { EventEmitter } from '../../stencil-public-runtime';
+/**
+ * @slot header - Content displayed in the group header.
+ * @slot dropdown - Dropdown used for the group context menu.
+ * @slot default - Group items.
+ * @slot footer - Content displayed below the group items.
+ */
 export declare class Group {
     hostElement: HTMLIxGroupElement;
     /**

package/dist/types/components/group-item/group-item.d.ts

@@ -1,4 +1,7 @@
 import { EventEmitter } from '../../stencil-public-runtime';
+/**
+ * @slot default - Group item content.
+ */
 export declare class GroupItem {
     hostElement: HTMLIxGroupItemElement;
     /**

package/dist/types/components/key-value-list/key-value-list.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @slot default - Key-value entries.
+ */
 export declare class KeyValueList {
     /**
      * Optional striped key value list style

package/dist/types/components/layout-auto/layout-auto.d.ts

@@ -1,4 +1,7 @@
 import { IxComponentInterface } from '../utils/internal';
+/**
+ * @slot default - Content arranged by the automatic layout.
+ */
 export declare class LayoutForm implements IxComponentInterface {
     hostElement: HTMLIxLayoutAutoElement;
     /**

package/dist/types/components/layout-grid/layout-grid.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @slot default - Content arranged in the grid.
+ */
 export declare class LayoutGrid {
     /**
      * The grid will not have any horizontal padding

package/dist/types/components/link-button/link-button.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @slot default - Link button label.
+ */
 export declare class LinkButton {
     /**
      * Disable the link button

package/dist/types/components/menu/menu.d.ts

@@ -3,6 +3,14 @@ import { ApplicationLayoutContext } from '../utils/application-layout/context';
 import { Breakpoint } from '../utils/breakpoints';
 import { ContextType } from '../utils/context';
 import { CustomCloseEvent } from '../utils/menu-tabs/menu-tabs-utils';
+/**
+ * @slot ix-menu-avatar - Avatar displayed at the top of the menu.
+ * @slot home - Home menu item.
+ * @slot default - Main menu items and categories.
+ * @slot bottom - Menu items displayed below the main navigation.
+ * @slot ix-menu-settings - Settings content displayed in the menu overlay.
+ * @slot ix-menu-about - About content displayed in the menu overlay.
+ */
 export declare class Menu {
     hostElement: HTMLIxMenuElement;
     /**

package/dist/types/components/menu-about/menu-about.d.ts

@@ -1,5 +1,8 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 import { CustomCloseEvent } from '../utils/menu-tabs/menu-tabs-utils';
+/**
+ * @slot default - About overlay content.
+ */
 export declare class MenuAbout {
     hostElement: HTMLIxMenuAboutElement;
     /**

package/dist/types/components/menu-about-item/menu-about-item.d.ts

@@ -17,6 +17,7 @@ declare const MenuAboutItem_base: abstract new (...args: any[]) => {
 } & import("../utils/internal/component").StencilLifecycle;
 /**
  * @deprecated since 5.0.0, use ix-tab-item instead of ix-menu-about-item
+ * @slot default - About menu item content.
  */
 export declare class MenuAboutItem extends MenuAboutItem_base implements BaseTabMixinContract {
     /**

package/dist/types/components/menu-about-news/menu-about-news.d.ts

@@ -12,6 +12,9 @@ declare const MenuAboutNews_base: abstract new (...args: any[]) => {
     componentDidUpdate?(): void;
     render?(): any;
 } & import("../utils/internal/component").StencilLifecycle;
+/**
+ * @slot default - News content.
+ */
 export declare class MenuAboutNews extends MenuAboutNews_base {
     hostElement: HTMLIxMenuAboutNewsElement;
     /**

package/dist/types/components/menu-avatar/menu-avatar.d.ts

@@ -1,4 +1,7 @@
 import { EventEmitter } from '../../stencil-public-runtime';
+/**
+ * @slot default - Avatar dropdown items.
+ */
 export declare class MenuAvatar {
     hostElement: HTMLIxMenuAvatarElement;
     /**

package/dist/types/components/menu-category/menu-category.d.ts

@@ -29,6 +29,9 @@ declare const MenuCategory_base: abstract new (...args: any[]) => {
     componentDidUpdate?(): void;
     render?(): any;
 };
+/**
+ * @slot default - Menu items in the category.
+ */
 export declare class MenuCategory extends MenuCategory_base implements IxMenuItemBase, InheritAriaAttributesMixinContract {
     hostElement: HTMLIxMenuCategoryElement;
     /**
@@ -50,7 +53,7 @@ export declare class MenuCategory extends MenuCategory_base implements IxMenuIte
      */
     tooltipText?: string;
     /** @internal */
-    closeOtherCategories: EventEmitter;
+    closeOtherCategories: EventEmitter<string>;
     menuExpand: boolean;
     showItems: boolean;
     showDropdown: boolean;

package/dist/types/components/menu-item/menu-item.d.ts

@@ -30,7 +30,7 @@ declare const MenuItem_base: abstract new (...args: any[]) => {
     render?(): any;
 };
 /**
- * @slot menu-item-label Custom label
+ * @slot default - Custom menu item label.
  */
 export declare class MenuItem extends MenuItem_base implements IxMenuItemBase, InheritAriaAttributesMixinContract {
     /**

package/dist/types/components/menu-settings/menu-settings.d.ts

@@ -1,5 +1,8 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 import { CustomCloseEvent } from '../utils/menu-tabs/menu-tabs-utils';
+/**
+ * @slot default - Settings overlay content.
+ */
 export declare class MenuSettings {
     hostElement: HTMLIxMenuSettingsElement;
     /**

package/dist/types/components/menu-settings-item/menu-settings-item.d.ts

@@ -17,6 +17,7 @@ declare const MenuSettingsItem_base: abstract new (...args: any[]) => {
 } & import("../utils/internal/component").StencilLifecycle;
 /**
  * @deprecated since 5.0.0, use ix-tab-item instead of ix-menu-settings-item
+ * @slot default - Settings menu item content.
  */
 export declare class MenuSettingsItem extends MenuSettingsItem_base implements BaseTabMixinContract {
     /**

package/dist/types/components/message-bar/message-bar.d.ts

@@ -1,5 +1,8 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 import { NotificationColor } from '../utils/notification-color';
+/**
+ * @slot default - Message content.
+ */
 export declare class MessageBar {
     /**
      * Specifies the type of the alert.

package/dist/types/components/modal/modal.d.ts

@@ -1,5 +1,8 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 import { IxModalSize } from './modal.types';
+/**
+ * @slot default - Modal sections and content.
+ */
 export declare class Modal {
     private ariaAttributes;
     private isMouseDownInsideDialog;

package/dist/types/components/modal-content/modal-content.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @slot default - Modal body content.
+ */
 export declare class ModalContent {
     render(): any;
 }

package/dist/types/components/modal-footer/modal-footer.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @slot default - Modal footer actions.
+ */
 export declare class ModalFooter {
     render(): any;
 }

package/dist/types/components/modal-header/modal-header.d.ts

@@ -1,4 +1,7 @@
 import { EventEmitter } from '../../stencil-public-runtime';
+/**
+ * @slot default - Modal header content.
+ */
 export declare class ModalHeader {
     hostElement: HTMLIxModalHeaderElement;
     /**

package/dist/types/components/pane/pane.d.ts

@@ -2,6 +2,7 @@ import { EventEmitter } from '../../stencil-public-runtime';
 import type { BorderlessChangedEvent, Composition, ExpandedChangedEvent, HideOnCollapseChangedEvent, SlotChangedEvent, VariantChangedEvent } from './pane.types';
 /**
  * @slot header - Additional slot for the header content
+ * @slot default - Pane body content.
  */
 export declare class Pane {
     hostElement: HTMLIxPaneElement;

package/dist/types/components/pane-layout/pane-layout.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @slot left - Pane displayed to the left of the content.
+ * @slot top - Pane displayed above the content.
+ * @slot content - Main layout content.
+ * @slot default - Additional main layout content.
+ * @slot bottom - Pane displayed below the content.
+ * @slot right - Pane displayed to the right of the content.
+ */
 export declare class Panes {
     hostElement: HTMLIxPaneLayoutElement;
     /**

package/dist/types/components/pill/pill.d.ts

@@ -12,6 +12,9 @@ declare const Pill_base: abstract new (...args: any[]) => {
     componentDidUpdate?(): void;
     render?(): any;
 } & import("../utils/internal/component").StencilLifecycle;
+/**
+ * @slot default - Pill label.
+ */
 export declare class Pill extends Pill_base implements IxComponentInterface {
     hostElement: HTMLIxPillElement;
     /**

package/dist/types/components/popover/popover.d.ts

@@ -48,7 +48,7 @@ declare const Popover_base: abstract new (...args: any[]) => {
 /**
  * Floating panel anchored to a trigger element.
  *
- * @slot - Child sections in order: `ix-popover-header`, `ix-popover-image`, `ix-popover-content`, and `ix-popover-footer`.
+ * @slot default - Child sections in order: `ix-popover-header`, `ix-popover-image`, `ix-popover-content`, and `ix-popover-footer`.
  *
  * @since 5.1.0
  */