@siemens/ix 3.0.0-alpha.4 → 3.0.0

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

@@ -12,17 +12,14 @@ export declare class Blind {
     label?: string;
     /**
      * Secondary label inside blind header
-     * @since 2.0.0
      */
     sublabel?: string;
     /**
      * Optional icon to be displayed next to the header label
-     * @since 1.5.0
      */
     icon?: string;
     /**
      * Blind variant
-     * @since 2.0.0
      */
     variant: BlindVariant;
     /**

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

@@ -17,8 +17,6 @@ export declare class Breadcrumb {
     /**
      * Accessibility label for the dropdown button (ellipsis icon) used to access the dropdown list
      * with conditionally hidden previous items
-     *
-     * @since 2.0.0
      */
     ariaLabelPreviousButton: string;
     /**

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

@@ -3,7 +3,6 @@ export type ButtonVariant = 'danger' | 'primary' | 'secondary';
 export declare class Button implements IxButtonComponent {
     /**
      * Button variant
-     * @since 2.3.0 - variant danger
      */
     variant: ButtonVariant;
     /**
@@ -24,8 +23,6 @@ export declare class Button implements IxButtonComponent {
     type: 'button' | 'submit';
     /**
      * Loading button
-     *
-     * @since 2.0.0
      */
     loading: boolean;
     /**

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

@@ -1,7 +1,4 @@
 export type CardVariant = 'alarm' | 'critical' | 'warning' | 'info' | 'neutral' | 'success' | 'primary' | 'outline' | 'filled';
-/**
- * @since 1.6.0
- */
 export declare class Card {
     hostElement: HTMLIxCardElement;
     /**
@@ -9,7 +6,7 @@ export declare class Card {
      */
     variant: CardVariant;
     /**
-     * @since 2.1.0
+     * Show card in selected state
      */
     selected: boolean;
     render(): any;

package/dist/types/components/card-accordion/card-accordion.d.ts

@@ -3,13 +3,9 @@ export type CardAccordionExpandChangeEvent = {
     expand: boolean;
     nativeEvent: Event;
 };
-/**
- * @since 1.6.0
- */
 export declare class CardAccordion {
     /**
      * Collapse the card
-     * @since 2.1.0
      */
     collapse: boolean;
     hostElement: HTMLIxCardAccordionElement;

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

@@ -1,6 +1,3 @@
-/**
- * @since 1.6.0
- */
 export declare class CardContent {
     render(): any;
 }

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

@@ -1,7 +1,4 @@
 import { EventEmitter } from '../../stencil-public-runtime';
-/**
- * @since 1.6.0
- */
 export declare class CardList {
     /**
      * Name the card list
@@ -31,8 +28,6 @@ export declare class CardList {
     suppressOverflowHandling: boolean;
     /**
      * Hide the show all button
-     *
-     * @since 2.2.0
      */
     hideShowAll: boolean;
     /**

package/dist/types/components/card-title/card-title.d.ts

@@ -1,7 +1,5 @@
 /**
  * @slot title-actions - Place additional actions inside title
- *
- * @since 1.6.0
  */
 export declare class CardHeader {
     render(): any;

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

@@ -78,8 +78,6 @@ export declare class CategoryFilter {
     /**
      * If set categories will always be filtered via the respective logical operator.
      * Toggling of the operator will not be available to the user.
-     *
-     * @since 2.2.0
      */
     staticOperator?: LogicalFilterOperator;
     /**

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

@@ -1,8 +1,7 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 import { IxFormComponent } from '../utils/input';
 /**
- * @since 2.6.0
- * @form-ready 2.6.0
+ * @form-ready
  */
 export declare class Checkbox implements IxFormComponent<string> {
     hostElement: HTMLIxCheckboxElement;
@@ -45,6 +44,11 @@ export declare class Checkbox implements IxFormComponent<string> {
      * Event emitted when the value of the checkbox changes
      */
     valueChange: EventEmitter<string>;
+    /**
+     * Event emitted when the checkbox is blurred
+     */
+    ixBlur: EventEmitter<void>;
+    private touched;
     private readonly inputRef;
     private setCheckedState;
     onCheckedChange(): void;
@@ -55,6 +59,8 @@ export declare class Checkbox implements IxFormComponent<string> {
     hasValidValue(): Promise<boolean>;
     /** @internal */
     getAssociatedFormElement(): Promise<HTMLFormElement | null>;
+    /** @internal */
+    isTouched(): Promise<boolean>;
     updateClassMappings(): void;
     private renderCheckmark;
     render(): any;

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

@@ -1,8 +1,7 @@
 import { FieldWrapperInterface, IxFormValidationState, ValidationResults } from '../utils/input';
 import { IxComponent } from '../utils/internal';
 /**
- * @since 2.6.0
- * @form-ready 2.6.0
+ * @form-ready
  */
 export declare class CheckboxGroup implements FieldWrapperInterface, IxFormValidationState, IxComponent {
     hostElement: HTMLIxCheckboxGroupElement;
@@ -38,10 +37,30 @@ export declare class CheckboxGroup implements FieldWrapperInterface, IxFormValid
      * Show helper, info, warning, error and valid text as tooltip
      */
     showTextAsTooltip: boolean;
+    /**
+     * @internal
+     */
+    required: boolean;
     isInvalid: boolean;
     isInfo: boolean;
     isValid: boolean;
     isWarning: boolean;
+    private touched;
+    private readonly groupRef;
+    get checkboxElements(): HTMLIxCheckboxElement[];
+    private readonly observer;
+    private checkForRequiredCheckbox;
+    connectedCallback(): void;
+    componentWillLoad(): void | Promise<void>;
+    disconnectedCallback(): void;
     onClassFieldUpdate({ isInvalid, isInvalidByRequired, isInfo, isValid, isWarning, }: ValidationResults): void;
+    /**
+     * @internal
+     */
+    isTouched(): Promise<boolean>;
+    /**
+     * @internal
+     */
+    hasValidValue(): Promise<boolean>;
     render(): any;
 }

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

@@ -0,0 +1 @@
+export {};

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

@@ -35,13 +35,12 @@ export declare class Chip {
     /**
      * Display a tooltip. By default, no tooltip will be displayed.
      * Add the attribute to display the text content of the component as a tooltip or use a string to display a custom text.
+     *
      * @since 3.0.0
      */
     tooltipText: string | boolean;
     /**
      * Fire event if close button is clicked
-     *
-     * @since 1.5.0
      */
     closeChip: EventEmitter;
     private readonly containerElementRef;

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

@@ -1,9 +1,6 @@
 import { Breakpoint } from '../utils/breakpoints';
 type GridBreakpoint = Breakpoint | '';
 export type ColumnSize = '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | 'auto';
-/**
- * @since 2.0.0
- */
 export declare class Col {
     static Breakpoints: GridBreakpoint[];
     /**

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

@@ -1,5 +1,4 @@
 /**
- * @since 2.1.0
  * @slot header - Display content at the top of the content page
  */
 export declare class Content {

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

@@ -1,8 +1,5 @@
 import { FieldWrapperInterface, IxFormValidationState, ValidationResults } from '../utils/input';
 import { IxComponent } from '../utils/internal';
-/**
- * @since 2.6.0
- */
 export declare class CustomField implements FieldWrapperInterface, IxFormValidationState, IxComponent {
     hostElement: HTMLIxCustomFieldElement;
     /**

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

@@ -12,15 +12,10 @@ export type DateRangeChangeEvent = {
     from?: string;
     to?: string;
 };
-/**
- * @since 2.1.0
- */
 export declare class DateDropdown implements Omit<IxDatePickerComponent, 'corners'>, Omit<IxButtonComponent, 'type' | 'icon'> {
     hostElement: HTMLIxDateDropdownElement;
     /**
      * Disable the button that opens the dropdown containing the date picker.
-     *
-     * @since 2.3.0
      */
     disabled: boolean;
     /**
@@ -107,15 +102,11 @@ export declare class DateDropdown implements Omit<IxDatePickerComponent, 'corner
     onDateRangeOptionsChange(): void;
     /**
      * Locale identifier (e.g. 'en' or 'de').
-     *
-     * @since 2.6.0
      */
     locale?: string;
     /**
      * The index of which day to start the week on, based on the Locale#weekdays array.
      * E.g. if the locale is en-us, weekStartIndex = 1 results in starting the week on monday.
-     *
-     * @since 2.6.0
      */
     weekStartIndex: number;
     /**

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

@@ -5,8 +5,8 @@ export type DateInputValidityState = {
     invalidReason?: string;
 };
 /**
- * @since 2.6.0
- * @form-ready 2.6.0
+ * @form-ready
+ *
  * @slot start - Element will be displayed at the start of the input
  * @slot end - Element will be displayed at the end of the input
  */
@@ -27,8 +27,6 @@ export declare class DateInput implements IxInputFieldComponent<string | undefin
     value?: string;
     /**
      * Locale identifier (e.g. 'en' or 'de').
-     *
-     * @since 2.6.0
      */
     locale?: string;
     /**

package/dist/types/components/date-picker/date-picker.d.ts

@@ -24,50 +24,36 @@ export declare class DatePicker implements IxDatePickerComponent {
     /**
      * The selected starting date. If the date-picker-rework is not in range mode this is the selected date.
      * Format has to match the `format` property.
-     *
-     * @since 1.1.0
      */
     from: string | undefined;
     watchFromPropHandler(newValue: string): void;
     /**
      * The selected end date. If the the date-picker-rework is not in range mode this property has no impact.
      * Format has to match the `format` property.
-     *
-     * @since 1.1.0
      */
     to: string | undefined;
     watchToPropHandler(newValue: string): void;
     /**
      * The earliest date that can be selected by the date picker.
      * If not set there will be no restriction.
-     *
-     * @since 1.1.0
      */
     minDate: string;
     /**
      * The latest date that can be selected by the date picker.
      * If not set there will be no restriction.
-     *
-     * @since 1.1.0
      */
     maxDate: string;
     /**
      * Text of date select button
-     *
-     * @since 2.1.0
      */
     i18nDone: string;
     /**
      * The index of which day to start the week on, based on the Locale#weekdays array.
      * E.g. if the locale is en-us, weekStartIndex = 1 results in starting the week on monday.
-     *
-     * @since 2.1.0
      */
     weekStartIndex: number;
     /**
      * Locale identifier (e.g. 'en' or 'de').
-     *
-     * @since 2.1.0
      */
     locale?: string;
     onLocaleChange(): void;
@@ -84,21 +70,15 @@ export declare class DatePicker implements IxDatePickerComponent {
     /**
      * Triggers if the date selection changes.
      * Note: Since 2.0.0 `dateChange` does not dispatch detail property as `string`
-     *
-     * @since 2.1.0
      */
     dateChange: EventEmitter<DateChangeEvent>;
     /**
      * Triggers if the date selection changes.
      * Only triggered if date-picker-rework is in range mode.
-     *
-     * @since 2.1.0
      */
     dateRangeChange: EventEmitter<DateChangeEvent>;
     /**
      * Date selection confirmed via button action
-     *
-     * @since 1.1.0
      */
     dateSelect: EventEmitter<DateChangeEvent>;
     /**

package/dist/types/components/datetime-picker/datetime-picker.d.ts

@@ -26,56 +26,40 @@ export declare class DatetimePicker implements Omit<IxDatePickerComponent, 'corn
     /**
      * The earliest date that can be selected by the date picker.
      * If not set there will be no restriction.
-     *
-     * @since 1.1.0
      */
     minDate?: string;
     /**
      * The latest date that can be selected by the date picker.
      * If not set there will be no restriction.
-     *
-     * @since 1.1.0
      */
     maxDate?: string;
     /**
      * Date format string.
      * See {@link "https://moment.github.io/luxon/#/formatting?id=table-of-tokens"} for all available tokens.
-     *
-     * @since 1.1.0
      */
     dateFormat: string;
     /**
      * Time format string.
      * See {@link "https://moment.github.io/luxon/#/formatting?id=table-of-tokens"} for all available tokens.
-     *
-     * @since 1.1.0
      */
     timeFormat: string;
     /**
      * The selected starting date. If the picker is not in range mode this is the selected date.
      * Format has to match the `format` property.
-     *
-     * @since 1.1.0
      */
     from?: string;
     /**
      * The selected end date. If the the picker is not in range mode this property has no impact.
      * Format has to match the `format` property.
-     *
-     * @since 1.1.0
      */
     to?: string;
     /**
      * Select time with format string
-     *
-     * @since 1.1.0
      */
     time?: string;
     /**
      * Show time reference input
      * Time reference is default aligned with @see {this.timeFormat}
-     *
-     * @since 1.1.0
      */
     showTimeReference: boolean;
     /**
@@ -84,8 +68,6 @@ export declare class DatetimePicker implements Omit<IxDatePickerComponent, 'corn
     timeReference?: 'AM' | 'PM';
     /**
      * Text of date select button
-     *
-     * @since 2.1.0
      */
     i18nDone: string;
     /**
@@ -97,15 +79,11 @@ export declare class DatetimePicker implements Omit<IxDatePickerComponent, 'corn
     /**
      * The index of which day to start the week on, based on the Locale#weekdays array.
      * E.g. if the locale is en-us, weekStartIndex = 1 results in starting the week on monday.
-     *
-     * @since 2.1.0
      */
     weekStartIndex: number;
     /**
      * Format of time string
      * See {@link "https://moment.github.io/luxon/#/formatting?id=table-of-tokens"} for all available tokens.
-     *
-     * @since 2.1.0
      */
     locale?: string;
     /**
@@ -115,22 +93,15 @@ export declare class DatetimePicker implements Omit<IxDatePickerComponent, 'corn
      */
     showWeekNumbers: boolean;
     /**
-  
      * Time change
-     *
-     * @since 1.1.0
      */
     timeChange: EventEmitter<string>;
     /**
      * Date change
-     *
-     * @since 1.1.0
      */
     dateChange: EventEmitter<DateTimeDateChangeEvent>;
     /**
      * Datetime selection event is fired after confirm button is pressed
-     *
-     * @since 1.1.0
      */
     dateSelect: EventEmitter<DateTimeSelectEvent>;
     private datePickerElement?;

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

@@ -1,6 +1,3 @@
-/**
- * @since 1.4.0
- */
 export declare class Divider {
     render(): any;
 }

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

@@ -7,8 +7,6 @@ export declare class Dropdown implements ComponentInterface, DropdownInterface {
     hostElement: HTMLIxDropdownElement;
     /**
      * Suppress the automatic placement of the dropdown.
-     *
-     * @since 2.0.0
      */
     suppressAutomaticPlacement: boolean;
     /**

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

@@ -1,9 +1,6 @@
 import { ButtonVariant } from '../button/button';
 import { AlignedPlacement } from '../dropdown/placement';
 export type DropdownButtonVariant = ButtonVariant;
-/**
- * @since 1.3.0
- */
 export declare class DropdownButton {
     hostElement: HTMLIxDropdownButtonElement;
     /**
@@ -32,13 +29,10 @@ export declare class DropdownButton {
     icon?: string;
     /**
      * Controls if the dropdown will be closed in response to a click event depending on the position of the event relative to the dropdown.
-     * @since 2.1.0
      */
     closeBehavior: 'inside' | 'outside' | 'both' | boolean;
     /**
      * Placement of the dropdown
-     *
-     * @since 2.0.0
      */
     placement?: AlignedPlacement;
     private readonly dropdownAnchor;

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

@@ -1,6 +1,3 @@
-/**
- * @since 2.0.0
- */
 export declare class DropdownHeader {
     /**
      * Display name of the header

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

@@ -1,6 +1,3 @@
-/**
- * @since 1.4.0
- */
 export declare class DropdownQuickActions {
     render(): any;
 }

package/dist/types/components/empty-state/empty-state.d.ts

@@ -1,8 +1,5 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 export type EmptyStateLayout = 'large' | 'compact' | 'compactBreak';
-/**
- * @since 1.6.0
- */
 export declare class EmptyState {
     /**
      * Optional empty state layout - one of 'large', 'compact' or 'compactBreak'

package/dist/types/components/expanding-search/expanding-search.d.ts

@@ -16,7 +16,6 @@ export declare class ExpandingSearch implements Omit<IxButtonComponent, 'type' |
     value: string;
     /**
      * If true the search field will fill all available horizontal space of it's parent container when expanded.
-     * @since 1.6.0
      */
     fullWidth: boolean;
     /**

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

@@ -7,7 +7,6 @@ export declare class FilterChip {
     disabled: boolean;
     /**
      * If true the filter chip will be in readonly mode
-     * @since 2.0.0
      */
     readonly: boolean;
     /**

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

@@ -8,12 +8,10 @@ export declare class FlipTile {
     state?: FlipTileState;
     /**
      * Height interpreted as REM
-     * @since 1.5.0
      */
     height: number | 'auto';
     /**
      * Width interpreted as REM
-     * @since 1.5.0
      */
     width: number | 'auto';
     /**

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

@@ -5,13 +5,10 @@ export declare class IconButton {
     /**
      * Accessibility label for the icon button
      * Will be set as aria-label on the nested HTML button element
-     *
-     * @since 2.1.0
      */
     a11yLabel?: string;
     /**
      * Variant of button
-     * @since 2.3.0 - variant danger
      */
     variant: IconButtonVariant;
     /**
@@ -49,8 +46,6 @@ export declare class IconButton {
     type: 'button' | 'submit';
     /**
      * Loading button
-     *
-     * @since 2.0.0
      */
     loading: boolean;
     /**

package/dist/types/components/icon-toggle-button/icon-toggle-button.d.ts

@@ -1,8 +1,5 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 import { ButtonVariant } from '../button/button';
-/**
- * @since 2.0.0
- */
 export declare class IconToggleButton {
     /**
      * Button variant.

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

@@ -1,8 +1,7 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 import { IxInputFieldComponent, ValidationResults } from '../utils/input';
 /**
- * @since 2.6.0
- * @form-ready 2.6.0
+ * @form-ready
  * @slot start - Element will be displayed at the start of the input
  * @slot end - Element will be displayed at the end of the input
  */
@@ -120,6 +119,10 @@ export declare class Input implements IxInputFieldComponent<string> {
      * Returns the native input element used in the text field.
      */
     getNativeInputElement(): Promise<HTMLInputElement>;
+    /**
+     * Returns the validity state of the input field.
+     */
+    getValidityState(): Promise<ValidityState>;
     /**
      * Focuses the input field
      */

package/dist/types/components/input/input.fc.d.ts

@@ -1,7 +1,7 @@
 import { FunctionalComponent } from '../../stencil-public-runtime';
 import { MakeRef } from '../utils/make-ref';
 import { A11yAttributes } from '../utils/a11y';
-export declare function TextareaElement(props: {
+export declare function TextareaElement(props: Readonly<{
     resizeBehavior: 'both' | 'horizontal' | 'vertical' | 'none';
     textareaHeight?: string;
     textareaWidth?: string;
@@ -20,8 +20,8 @@ export declare function TextareaElement(props: {
     updateFormInternalValue: (value: string) => void;
     onBlur: () => void;
     ariaAttributes?: A11yAttributes;
-}): any;
-export declare function InputElement(props: {
+}>): any;
+export declare function InputElement(props: Readonly<{
     id: string;
     disabled: boolean;
     readonly: boolean;
@@ -29,6 +29,7 @@ export declare function InputElement(props: {
     minLength?: string | number;
     max?: string | number;
     min?: string | number;
+    step?: string | number;
     pattern?: string;
     type: string;
     isInvalid: boolean;
@@ -41,7 +42,7 @@ export declare function InputElement(props: {
     updateFormInternalValue: (value: string) => void;
     onBlur: () => void;
     ariaAttributes?: A11yAttributes;
-}): any;
+}>): any;
 export declare const SlotEnd: FunctionalComponent<{
     slotEndRef: MakeRef<HTMLDivElement>;
     onSlotChange?: (e: Event) => void;