@riverty/web-components 6.3.0 → 6.3.1

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

@@ -0,0 +1,124 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import type { IconName } from '../icon/exports';
+export declare class CheckboxGroup {
+    host: HTMLRCheckboxGroupElement;
+    /**
+     * Specifies the `id` of the `<form>` to which the element belongs.
+     * */
+    form?: string;
+    /**
+     * Specifies `name` property of the 'select-all' checkbox, representing the group as a whole.
+     * */
+    name?: string;
+    /**
+     * Specifies `value` property of the 'select-all', representing the group as a whole.
+     * */
+    value: string;
+    /**
+     * Specifies whether the `value` is required.
+     */
+    required?: boolean;
+    /** Set custom message for `valueMissing` property
+     * of a ValidityState object (set by `required`)
+     * within Constrain Validation API
+     * */
+    valueMissingMessage?: string;
+    /** Apply validation success visual style */
+    valid?: boolean;
+    /** Apply validation error visual style */
+    invalid?: boolean;
+    /** Custom validation error message */
+    error?: string;
+    /** Set custom message for `customError` property of a ValidityState object
+     * indicating whether the element's custom validity message has been set to a non-empty
+     * string by calling the element's setCustomValidity() method. */
+    customErrorMessage?: string;
+    /**
+     * The label for the checkbox group.
+     */
+    label: string;
+    /**
+     * An optional field indicator for the label.
+     */
+    fieldIndicator?: string;
+    /**
+     * Help text for the checkbox group.
+     */
+    help?: string;
+    /**
+     * An optional icon to display in the help text.
+     */
+    helpIcon?: IconName;
+    /**
+     * The color of the help icon.
+     */
+    helpIconColor?: string;
+    /**
+     * A hint providing additional information for the checkbox group.
+     */
+    hint?: string;
+    /**
+     * Whether to show a "Select All" checkbox.
+     */
+    showSelectAll?: boolean;
+    /** Specifies if element must be ignored during validation of the form elements */
+    novalidate?: boolean;
+    /** Specifies if select-all checkbox is initially in checked state */
+    checked?: boolean;
+    /** Specifies if select-all checkbox is initially in indetermitate state */
+    indetermitate?: boolean;
+    /** Emits event after each validation */
+    rValidate: EventEmitter<{
+        state: string;
+        message: string;
+    }>;
+    indeterminate: boolean;
+    allChecked: boolean;
+    noChecked: boolean;
+    validityState: string;
+    validityMessage: string;
+    private uniqueId;
+    private initial;
+    /** Validates the checkbox group, displays provided message in case value is invalid. */
+    setCustomValidity(message: string): Promise<void>;
+    /**
+     * Validates the checkbox group without triggering UI and returns a boolean indicating its validity.
+     * @returns A boolean indicating whether the checkbox is valid.
+     */
+    checkValidity(): Promise<boolean>;
+    /**
+     * Resets the validity state and message of the radio group.
+     * This method clears the validity message and state, and sets the invalid
+     * property to its initial value.
+     */
+    resetValidity(): Promise<void>;
+    /**
+     * @returns {HTMLRCheckboxElement[]} - Returns all checkboxes in the slot.
+     */
+    private get checkboxes();
+    private get hasMessage();
+    /**
+     * Checks all checkboxes in the slot.
+     */
+    checkAll(): Promise<this>;
+    /**
+     * Unchecks all checkboxes in the slot.
+     */
+    uncheckAll(): Promise<this>;
+    handleCheckboxChange(event: CustomEvent): void;
+    private updateCheckAllState;
+    private updateCheckboxesState;
+    private get message();
+    private renderMessage;
+    private getValidityStateData;
+    private validateGroup;
+    private get parentFormEl();
+    private get isNoValidate();
+    private onSubmitForm;
+    private onResetForm;
+    private resetToInitial;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private get groupDescribedby();
+    render(): any;
+}

package/dist/types/components/design-system-devtools/design-system-devtools.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Can be used by developers to verify functionality of the design system.
+ *
+ * Example:
+ * ```html
+ * <r-design-system-devtools design-tokens></r-design-system-devtools>
+ * ```
+ */
+export declare class DesignSystemDevtools {
+    el: HTMLRDesignSystemDevtoolsElement;
+    /** Whether to display a preview of some key design tokens */
+    designTokens: boolean;
+    private renderDesignTokens;
+    render(): any;
+}

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

@@ -0,0 +1,69 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { DialogSize } from './exports';
+export declare class Dialog {
+    host: HTMLRDialogElement;
+    /** Define if dialog either shown or hidden. */
+    open: boolean;
+    /** A value indicating the result of a user’s
+     * interaction with the dialog, used to determine what action
+     * the user took before closing the dialog.
+     *
+     * For example, it can differentiate between whether the user
+     * clicked a “Confirm” button or a “Cancel” button.
+     */
+    returnValue?: string;
+    /**
+     * Allows to provide headline text to the dialog header section.
+     */
+    headline?: string;
+    /**
+     * Allows plain text to be provided to the body of the dialog
+     * in cases where markup is not required. For more complex cases,
+     * including those requiring HTML markup,
+     * use <div slot="body">...</div>.
+     */
+    bodyText?: string;
+    /**
+     * Allows to set height of the dialog body container
+     * while the value is smaller then `max-height` of the
+     * dialog body pre-set according to the `size` prop.
+     */
+    bodyHeight: string;
+    /**
+     * Defines one of pre-defined sizes of the dialog.
+     */
+    size: DialogSize;
+    /**
+     * Allows plain text to be provided to the close button of the dialog.
+     * */
+    closeAriaLabel: string;
+    /**
+     * Defines if dialog is currently revealed.
+     * */
+    isOpen: boolean;
+    handleOpenChange(): void;
+    private dialogElement;
+    private uniqueId;
+    private get dialogLabel();
+    /**
+     * Emitted when the dialog is closed.
+     * Fired by close(), and by the close button.
+     */
+    dialogClose: EventEmitter;
+    /** Method to display a modal dialog */
+    showModal(): Promise<void>;
+    /** Method to display a non-modal dialog */
+    close(): Promise<void>;
+    /** Method to either show or hide dialog
+     * depending on the current state. */
+    toggle(): Promise<void>;
+    private _renderInitialState;
+    private connectEventListeners;
+    private disconnectEventListeners;
+    componentDidLoad(): void;
+    disconnectedCallback(): void;
+    private onTriggerClick;
+    private isInside;
+    onMouseup(event: any): void;
+    render(): any;
+}

package/dist/types/components/dialog/exports.d.ts

@@ -0,0 +1,10 @@
+export declare const dialogSizeArray: readonly ["small", "medium", "large"];
+export declare const formMethodArray: readonly ["GET", "POST"];
+export declare const formEnctypeArray: readonly ["application/x-www-form-urlencoded", "multipart/form-data", "text/plain"];
+export declare const formTargetArray: readonly ["_self", "_blank", "_parent", "_top"];
+export declare const formAutocompleteArray: readonly ["on", "off"];
+export type DialogSize = typeof dialogSizeArray[number];
+export type FormMethod = typeof formMethodArray[number];
+export type FormEnctype = typeof formEnctypeArray[number];
+export type FormTarget = typeof formTargetArray[number];
+export type FormAutocomplete = typeof formAutocompleteArray[number];

package/dist/types/components/hint/exports.d.ts

@@ -0,0 +1,2 @@
+export declare const hintVariantArray: readonly ["information", "success", "warning", "error"];
+export type HintVariant = typeof hintVariantArray[number];

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

@@ -0,0 +1,20 @@
+import { IconName } from '../icon/exports';
+import { HintVariant } from './exports';
+/**
+ * A form hint is a small presentational components used next to some form elements.
+ *
+ * Mainly used within design system components and not primarilly intended for end-users.
+ */
+export declare class Hint {
+    host: HTMLRHintElement;
+    /** Apply validation error visual style */
+    invalid?: boolean;
+    /** Variant defines the way hint will be visually presented */
+    variant?: HintVariant;
+    /** Allows to define custom icon to be shown next to hint text */
+    icon?: IconName;
+    private get iconName();
+    private get hasIconSlot();
+    private get hasIcon();
+    render(): any;
+}