@gov-design-system-ce/components 4.6.4 → 4.6.5

package/dist/dist/dist/types/components/gov-flex/constants.d.ts

@@ -0,0 +1,7 @@
+import { Sizes } from "../../core/constants/sizes";
+import { ValueOf } from "../../types/interfaces";
+export declare const FlexSizes: typeof Sizes;
+export type FlexSizesType = `${ValueOf<typeof FlexSizes>}`;
+export declare const FlexClass: {
+    root: string;
+};

package/dist/dist/dist/types/components/gov-flex/gov-flex.d.ts

@@ -0,0 +1,39 @@
+import { FlexSizesType } from './constants';
+export declare class GovFlex {
+    private h;
+    constructor();
+    host: HTMLGovGridElement;
+    /**
+     * Controls the flex direction of the container.
+     */
+    direction?: 'row' | 'row-reverse' | 'column' | 'column-reverse';
+    /**
+     * Defines how the browser distributes space between and around content items along the main axis.
+     */
+    justifyContent?: 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around' | 'space-evenly';
+    /**
+     * Aligns flex items along the cross axis.
+     */
+    alignItems?: 'stretch' | 'flex-start' | 'flex-end' | 'center' | 'baseline';
+    /**
+     * Controls whether the flex container is a single-line or multi-line flex container.
+     */
+    wrap?: 'nowrap' | 'wrap' | 'wrap-reverse';
+    /**
+     * Aligns the flex container's lines within when there is extra space in the cross-axis.
+     */
+    alignContent?: 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around' | 'stretch';
+    /**
+     * Sets the alignment of the flex container’s children along the flex container’s cross axis, overriding the `align-items` property for individual flex items.
+     */
+    alignSelf?: 'auto' | 'normal' | 'self-start' | 'self-end' | 'flex-start' | 'flex-end' | 'center' | 'baseline' | 'stretch' | 'anchor-center';
+    /**
+     * The gap property creates consistent spacing between flex items in the container.
+     */
+    gap?: FlexSizesType;
+    /**
+     * Option to turn off responsive
+     */
+    readonly responsive: string;
+    render(): any;
+}

package/dist/dist/dist/types/components/gov-form/autocomplete/autocomplete.utils.d.ts

@@ -0,0 +1,2 @@
+import { GovFormAutocompleteItem } from './gov-form-autocomplete.types';
+export declare const filterAutocompleteOptions: (options: GovFormAutocompleteItem[], query: string, nameKey: string, maxOptions: number) => GovFormAutocompleteItem[];

package/dist/dist/dist/types/components/gov-form/autocomplete/constants.d.ts

@@ -0,0 +1,11 @@
+import { Sizes } from '../../../core/constants/sizes';
+import { ValueOf } from '../../../types/interfaces';
+export declare const FormAutocompleteSizes: Pick<typeof Sizes, "_XS" | "_S" | "_M" | "_L" | "_XL">;
+export type SizesType = `${ValueOf<typeof FormAutocompleteSizes>}`;
+export declare const FormAutocompleteClass: {
+    root: string;
+    list: string;
+    item: string;
+    empty: string;
+    loading: string;
+};

package/dist/dist/dist/types/components/gov-form/autocomplete/gov-form-autocomplete.d.ts

@@ -0,0 +1,158 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { SizesType } from './constants';
+import { FormAutocompleteEvent, GovFormAutocompleteItem } from './gov-form-autocomplete.types';
+import { Attributes } from "../../../helpers/Dom/attribute";
+export declare class GovFormAutocomplete {
+    private inputRef?;
+    private listRef?;
+    private readonly listBoxId;
+    private searchCallback;
+    private fullOptions;
+    private templateResolver;
+    private attributeObserver;
+    private debouncedSearch;
+    constructor();
+    host: HTMLGovFormInputElement;
+    /**
+     * Value of input
+     */
+    value: string;
+    /**
+     * Options of autocomplete
+     */
+    options?: string | GovFormAutocompleteItem[];
+    /**
+     * Custom input identifier.
+     */
+    readonly identifier: string;
+    /**
+     * Indicates the entered value of child form element does conform to the format expected by the application.
+     */
+    readonly success: boolean;
+    /**
+     * Input’s size.
+     */
+    readonly size?: SizesType;
+    /**
+     * Main key name in the object
+     */
+    readonly nameKey: string;
+    /**
+     * Name of the input.
+     */
+    readonly name: string;
+    /**
+     * Set whether the input is required or not. Please note that this is necessary for accessible inputs when the user is required to fill them.
+     * When using this property you need to also set “novalidate” attribute to your form element to prevent browser from displaying its own validation errors.
+     */
+    readonly required: boolean;
+    /**
+     * Makes the input component disabled.
+     * This prevents users from being able to interact with the select, and conveys its inactive state to assistive technologies.
+     */
+    readonly disabled: boolean;
+    /**
+     * Text that appears in the form control when it has no value set
+     */
+    readonly placeholder: string;
+    /**
+     * The value is not editable
+     */
+    readonly readonly: boolean;
+    /**
+     * Indicates the entered value does not conform to the format expected by the application.
+     */
+    readonly invalid: boolean;
+    /**
+     * Minimum length (number of characters) of value
+     */
+    readonly minlength: number;
+    /**
+     * Maximum length (number of characters) of value
+     */
+    readonly maxlength: number;
+    /**
+     * Maximum number of items shown from a static `options` list (0 = unlimited).
+     * Applies only when no async search callback is set.
+     */
+    readonly maxOptions: number;
+    /**
+     * Input throttle in milliseconds
+     */
+    readonly throttleTime: number;
+    /**
+     * Custom message for when there is a blank sheet
+     */
+    readonly messageEmpty: string;
+    /**
+     * Emitted when the input has focus.
+     */
+    govFocus: EventEmitter<FormAutocompleteEvent>;
+    /**
+     * Emitted when the input loses focus.
+     */
+    govBlur: EventEmitter<FormAutocompleteEvent>;
+    /**
+     * Emitted when the input change value.
+     */
+    govInput: EventEmitter<FormAutocompleteEvent>;
+    /**
+     * Emitted when the input change value.
+     */
+    govSelect: EventEmitter<FormAutocompleteEvent>;
+    focused: boolean;
+    processing: boolean;
+    arrowCounter: number;
+    list: GovFormAutocompleteItem[];
+    inheritedAttributes: Attributes;
+    validateSize(newValue: string): void;
+    watchOptions(newValue: string | GovFormAutocompleteItem[]): void;
+    private onArrowUp;
+    private onArrowDown;
+    private moveToView;
+    private doSearch;
+    private clearList;
+    get isValueAccepted(): boolean;
+    componentDidLoad(): void;
+    componentWillLoad(): void;
+    watchThrottleTime(): void;
+    private emitAndSearch;
+    disconnectedCallback(): void;
+    onAriaAttributeChange(attributeName: string, newValue: string): void;
+    render(): any;
+    private onFocusHandler;
+    private onBlurHandler;
+    private onInputHandler;
+    private onSelectHandler;
+    private onKeyUpHandler;
+    private onKeyDownHandler;
+    /**
+     * Focus main input element
+     */
+    setFocus(options?: FocusOptions): Promise<void>;
+    /**
+     * Blur main input element
+     */
+    setBlur(): Promise<void>;
+    /**
+     * Set options for list
+     */
+    setOptions(options: GovFormAutocompleteItem[]): Promise<void>;
+    /**
+     * Clears whisperer value
+     */
+    clearValue(): Promise<void>;
+    /**
+     * Clears whisperer value
+     */
+    setProcessing(status: boolean): Promise<void>;
+    /**
+     * Set a custom asynchronous function for the whisperer
+     */
+    setSearchCallback(callback: (value: string) => Promise<any>): Promise<void>;
+    /**
+     * Setting a custom whisper result template
+     * @param callback
+     */
+    setTemplateResolver(callback: (item: GovFormAutocompleteItem) => string): Promise<void>;
+}

package/dist/dist/dist/types/components/gov-form/autocomplete/gov-form-autocomplete.types.d.ts

@@ -0,0 +1,9 @@
+import { GovBaseEvent } from "../../../types/event.types";
+import { Nullable } from "../../../types/interfaces";
+export interface FormAutocompleteEvent extends GovBaseEvent {
+    value: string;
+    selected: Nullable<GovFormAutocompleteItem>;
+}
+export interface GovFormAutocompleteItem {
+    [key: string]: any;
+}

package/dist/dist/dist/types/components/gov-form/checkbox/constants.d.ts

@@ -0,0 +1,10 @@
+import { Sizes } from '../../../core/constants/sizes';
+import { ValueOf } from '../../../types/interfaces';
+export declare const FormCheckboxSizes: Pick<typeof Sizes, "_XS" | "_S" | "_M" | "_L" | "_XL">;
+export type FormCheckboxSizesType = `${ValueOf<typeof FormCheckboxSizes>}`;
+export declare const FormCheckboxClass: {
+    root: string;
+    check: string;
+    indeterminate: string;
+    label: string;
+};

package/dist/dist/dist/types/components/gov-form/checkbox/gov-form-checkbox.d.ts

@@ -0,0 +1,86 @@
+import { EventEmitter } from "../../../stencil-public-runtime";
+import { FormCheckboxSizesType } from "./constants";
+import { FormCheckboxEvent } from "./gov-form-checkbox.types";
+import { Attributes } from "../../../helpers/Dom/attribute";
+export declare class GovFormCheckbox {
+    private readonly h;
+    private f;
+    private inputRef?;
+    private attributeObserver;
+    private readonly checkboxId;
+    private hydrated;
+    constructor();
+    host: HTMLGovFormCheckboxElement;
+    /**
+     * Value of checkbox
+     */
+    readonly value: string;
+    /**
+     * Checkbox button state
+     */
+    checked: boolean;
+    /**
+     * Set whether the input is required or not. Please note that this is necessary for accessible inputs when the user is required to fill them.
+     * When using this property you need to also set “novalidate” attribute to your form element to prevent browser from displaying its own validation errors.
+     */
+    readonly required: boolean;
+    /**
+     * Makes the checkbox component disabled.
+     */
+    readonly disabled: boolean;
+    /**
+     * Same as original parameter (https://developer.mozilla.org/en-US/docs/Web/CSS/:indeterminate)
+     */
+    readonly indeterminate: boolean;
+    /**
+     * Name of the checkbox.
+     */
+    readonly name: string;
+    /**
+     * Checkboxes size.
+     */
+    readonly size?: FormCheckboxSizesType;
+    /**
+     * Custom checkbox identifier.
+     */
+    readonly identifier: string;
+    /**
+     * When you can't use the form label.
+     */
+    readonly noLabel: boolean;
+    /**
+     * Indicates the entered value does not conform to the format expected by the application.
+     */
+    readonly invalid: boolean;
+    /**
+     * Emitted when the checkbox has focus.
+     */
+    govFocus: EventEmitter<FormCheckboxEvent>;
+    /**
+     * Emitted when the checkbox loses focus.
+     */
+    govBlur: EventEmitter<FormCheckboxEvent>;
+    /**
+     * Emitted when the checkbox change value.
+     */
+    govChange: EventEmitter<FormCheckboxEvent>;
+    validateSize(newValue: string): void;
+    watchControlAttrs(): void;
+    inheritedAttributes: Attributes;
+    private passControlAttrs;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    componentDidRender(): Promise<void>;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    onAriaAttributeChange(attributeName: string, newValue: string): void;
+    render(): any;
+    private onFocusHandler;
+    private onBlurHandler;
+    private onClickHandler;
+    private onChangeHandler;
+    /**
+     * Returns the reference of the native element
+     */
+    getRef(): Promise<HTMLInputElement>;
+}

package/dist/dist/dist/types/components/gov-form/checkbox/gov-form-checkbox.types.d.ts

@@ -0,0 +1,5 @@
+import { GovBaseEvent } from "../../../types/event.types";
+export interface FormCheckboxEvent extends GovBaseEvent {
+    checked: boolean;
+    value: string;
+}

package/dist/dist/dist/types/components/gov-form/control/constants.d.ts

@@ -0,0 +1,9 @@
+import { Sizes } from '../../../core/constants/sizes';
+import { ValueOf } from '../../../types/interfaces';
+export declare const FormControlSizes: Pick<typeof Sizes, "_M" | "_L" | "_XL">;
+export type FormControlSizesType = `${ValueOf<typeof FormControlSizes>}`;
+export declare const FormControlClass: {
+    root: string;
+    holder: string;
+    bottom: string;
+};

package/dist/dist/dist/types/components/gov-form/control/gov-form-control.d.ts

@@ -0,0 +1,40 @@
+import { FormControlSizesType } from "./constants";
+export declare class GovFormControl {
+    private readonly h;
+    private f;
+    private observer;
+    constructor();
+    host: HTMLGovFormControlElement;
+    /**
+     * Custom form element identifier
+     */
+    readonly identifier: string;
+    /**
+     * Indicates the entered value of a child form element does not conform to the format expected by the application.
+     */
+    readonly invalid: boolean;
+    /**
+    /**
+    * Indicates the form control is disabled
+     */
+    readonly disabled: boolean;
+    /**
+    /**
+    * Indicates the entered value of a child form element does conform to the format expected by the application.
+     */
+    readonly success: boolean;
+    /**
+     * Use control as a fieldset for better accessibility.
+     * Note: Remember to set the legend attribute of the gov-form-label component
+     */
+    readonly fieldset: boolean;
+    /**
+     * Form element size.
+     */
+    readonly size?: FormControlSizesType;
+    componentDidRender(): void;
+    disconnectedCallback(): void;
+    private formElementDescriptionControl;
+    private syncControlMessages;
+    render(): any;
+}

package/dist/dist/dist/types/components/gov-form/file/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const FormFileClass: {
+    root: string;
+    area: string;
+    input: string;
+    inputFocus: string;
+    attachments: string;
+};

package/dist/dist/dist/types/components/gov-form/file/gov-form-file.d.ts

@@ -0,0 +1,130 @@
+import { EventEmitter } from "../../../stencil-public-runtime";
+import { GovFormFileEvent, GovFormFileItem } from "./gov-form-file.types";
+import { Attributes } from "../../../helpers/Dom/attribute";
+export declare class GovFormFile {
+    private f;
+    private readonly h;
+    private areaRef?;
+    private inputRef?;
+    private readonly fileId;
+    private attributeObserver;
+    private eventsRegistered;
+    constructor();
+    host: HTMLGovFormFileElement;
+    /**
+     * Expands the file input to fill 100% of the container width.
+     */
+    readonly expanded: boolean;
+    /**
+     * Set whether the input is required or not. Please note that this is necessary for accessible inputs when the user is required to fill them.
+     * When using this property you need to also set “novalidate” attribute to your form element to prevent browser from displaying its own validation errors.
+     */
+    readonly required: boolean;
+    /**
+     * Makes the File component disabled.
+     * This prevents users from being able to interact with the File, and conveys its inactive state to assistive technologies.
+     */
+    readonly disabled: boolean;
+    /**
+     * After selecting the files, the main input element will be reset.
+     * The propagation of the event with the selected files will not be affected.
+     */
+    readonly resetAfterPick: boolean;
+    /**
+     * Selected files will not be checked for duplicates based on name and size.
+     */
+    readonly ignoreFileDuplicationCheck: boolean;
+    /**
+     * Show list of attachments
+     */
+    readonly displayAttachments: boolean;
+    /**
+     * Name of the input.
+     */
+    readonly name: string;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/accept
+     */
+    readonly accept: string;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/multiple
+     */
+    readonly multiple: boolean;
+    /**
+     * Maximum embedded file size
+     */
+    readonly maxFileSize: number;
+    /**
+     * Custom File identifier.
+     */
+    readonly identifier: string;
+    /**
+     * Indicates the entered value does not conform to the format expected by the application.
+     */
+    readonly invalid: boolean;
+    /**
+     * Error message when the maximum file size is exceeded
+     */
+    readonly errorSize: string;
+    /**
+     * Insert unsupported file error message
+     */
+    readonly errorAccept: string;
+    /**
+     * Adds accessible label for the list of attachments.
+     */
+    readonly accessibleAttachmentsLabel: string;
+    /**
+     * Emitted when the File has focus.
+     */
+    govFocus: EventEmitter<GovFormFileEvent>;
+    /**
+     * Emitted when the File loses focus.
+     */
+    govBlur: EventEmitter<GovFormFileEvent>;
+    /**
+     * Called when the list of inserted files is changed
+     */
+    govFiles: EventEmitter<GovFormFileEvent>;
+    /**
+     * Called when a new file is added
+     */
+    govAddFile: EventEmitter<GovFormFileEvent>;
+    /**
+     * Called when a file is removed from the list
+     */
+    govRemoveFile: EventEmitter<GovFormFileEvent>;
+    watchControlAttrs(): void;
+    files: GovFormFileItem[];
+    inheritedAttributes: Attributes;
+    private passControlAttrs;
+    private registerListeners;
+    preventDefaults(e: any): void;
+    handleDrop(e: DragEvent): void;
+    private validateFiles;
+    private syncNativeInputFiles;
+    componentDidLoad(): void;
+    componentWillLoad(): void;
+    componentDidRender(): Promise<void>;
+    disconnectedCallback(): void;
+    onAriaAttributeChange(attributeName: string, newValue: string): void;
+    render(): any;
+    private onRemoveFileHandler;
+    private onFocusHandler;
+    private onBlurHandler;
+    private onChangeHandler;
+    /**
+     * Returns the reference of the native element
+     */
+    getRef(): Promise<HTMLInputElement>;
+    /**
+     * Returns the reference of the native area element
+     */
+    getAreaRef(): Promise<HTMLDivElement>;
+    /**
+     * Remove all files from component state
+     */
+    reset(): Promise<void>;
+}

package/dist/dist/dist/types/components/gov-form/file/gov-form-file.types.d.ts

@@ -0,0 +1,11 @@
+import { GovBaseEvent } from "../../../types/event.types";
+export interface GovFormFileEvent extends GovBaseEvent {
+    files?: GovFormFileItem[];
+    file?: GovFormFileItem;
+}
+export interface GovFormFileItem {
+    id: string;
+    file: File;
+    sizeValid: boolean;
+    acceptValid: boolean;
+}

package/dist/dist/dist/types/components/gov-form/group/constants.d.ts

@@ -0,0 +1,18 @@
+import { Sizes } from "../../../core/constants/sizes";
+import { ValueOf } from "../../../types/interfaces";
+export declare const FormGroupSizes: Pick<typeof Sizes, "_XS" | "_S" | "_M" | "_L" | "_2XL">;
+export type FormGroupSizesType = `${ValueOf<typeof FormGroupSizes>}`;
+export declare enum FormGroupOrientation {
+    HORIZONTAL = "horizontal",
+    VERTICAL = "vertical"
+}
+export type FormGroupOrientationType = `${ValueOf<typeof FormGroupOrientation>}`;
+export declare const FormGroupClass: {
+    root: string;
+};
+export declare const FormRadioGroupClass: {
+    root: string;
+};
+export declare const FormCheckboxGroupClass: {
+    root: string;
+};

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

@@ -0,0 +1,32 @@
+import { EventEmitter } from "../../../stencil-public-runtime";
+import { FormGroupOrientationType, FormGroupSizesType } from "./constants";
+import { FormCheckboxEvent } from "../checkbox/gov-form-checkbox.types";
+import { FormCheckboxGroupEvent } from "./gov-form-group.types";
+export declare class GovFormCheckboxGroup {
+    private readonly h;
+    constructor();
+    host: HTMLGovFormGroupElement;
+    /**
+     * Gap's size.
+     */
+    readonly gap?: FormGroupSizesType;
+    /**
+     * Elements orientation
+     */
+    readonly orientation?: FormGroupOrientationType;
+    /**
+     * Group's value
+     */
+    value?: string | string[];
+    /**
+  /* Emitted when the checkbox change value.
+     */
+    govChange: EventEmitter<FormCheckboxGroupEvent>;
+    validateGap(newValue: string): void;
+    validateOrientation(newValue: string): void;
+    handleChange: (event: CustomEvent<FormCheckboxEvent>) => void;
+    componentWillLoad(): void;
+    componentDidRender(): void;
+    rerenderComponent(): void;
+    render(): any;
+}

package/dist/dist/dist/types/components/gov-form/group/gov-form-group.d.ts

@@ -0,0 +1,18 @@
+import { FormGroupOrientationType, FormGroupSizesType } from "./constants";
+export declare class GovFormGroup {
+    private readonly h;
+    constructor();
+    host: HTMLGovFormGroupElement;
+    /**
+     * Gap's size.
+     */
+    readonly gap?: FormGroupSizesType;
+    /**
+     * Elements orientation
+     */
+    readonly orientation?: FormGroupOrientationType;
+    validateGap(newValue: string): void;
+    validateOrientation(newValue: string): void;
+    componentWillLoad(): void;
+    render(): any;
+}

package/dist/dist/dist/types/components/gov-form/group/gov-form-group.types.d.ts

@@ -0,0 +1,7 @@
+import { GovBaseEvent } from "../../../types/event.types";
+export interface FormRadioGroupEvent extends GovBaseEvent {
+    value: string;
+}
+export interface FormCheckboxGroupEvent extends GovBaseEvent {
+    value: string[];
+}

package/dist/dist/dist/types/components/gov-form/group/gov-form-radio-group.d.ts

@@ -0,0 +1,32 @@
+import { EventEmitter } from "../../../stencil-public-runtime";
+import { FormGroupOrientationType, FormGroupSizesType } from "./constants";
+import { FormRadioEvent } from "../radio/gov-form-radio.types";
+import { FormRadioGroupEvent } from "./gov-form-group.types";
+export declare class GovFormRadioGroup {
+    private readonly h;
+    constructor();
+    host: HTMLGovFormGroupElement;
+    /**
+     * Gap's size.
+     */
+    readonly gap?: FormGroupSizesType;
+    /**
+     * Elements orientation
+     */
+    readonly orientation?: FormGroupOrientationType;
+    /**
+     * Group's value
+     */
+    value?: string;
+    /**
+     * Emitted when the checkbox change value.
+     */
+    govChange: EventEmitter<FormRadioGroupEvent>;
+    validateGap(newValue: string): void;
+    validateOrientation(newValue: string): void;
+    handleChange: (event: CustomEvent<FormRadioEvent>) => void;
+    componentWillLoad(): void;
+    componentDidRender(): void;
+    rerenderComponent(): void;
+    render(): any;
+}