@gov-design-system-ce/components 4.2.8 → 4.6.0

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

@@ -0,0 +1,133 @@
+import { EventEmitter } from "../../../stencil-public-runtime";
+import { ButtonColorType, ButtonSizesType, ButtonTargetType, ButtonTypesType, NativeTypesType } from "./constants";
+import { ButtonEvent } from "./gov-button.types";
+import { Attributes } from "../../../helpers/Dom/attribute";
+export declare class GovButton {
+    private h;
+    private triggerRef?;
+    private attributeObserver;
+    private hydrated;
+    constructor();
+    host: HTMLGovButtonElement;
+    /**
+     * Style variation of the button
+     */
+    readonly color: ButtonColorType;
+    /**
+     * Button’s size
+     */
+    readonly size?: ButtonSizesType;
+    /**
+     * Button's type
+     */
+    readonly type: ButtonTypesType;
+    /**
+     * Expands the button to fill 100% of the container width
+     */
+    readonly expanded: boolean;
+    /**
+     * Expands the button to fill 100% of the container width only on mobile
+     */
+    readonly expandedMobile: boolean;
+    /**
+     * The name of the button, which gets paired with the button's value when submitted as part of a form. Corresponds with the native HTML name attribute
+     */
+    readonly name: string;
+    /**
+     * Makes the button component disabled.
+     * This prevents users from being able to interact with the button, and conveys its inactive state to assistive technologies
+     */
+    readonly disabled: boolean;
+    /**
+     * Same as original parameter
+     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type
+     */
+    readonly nativeType?: NativeTypesType;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-href
+     */
+    readonly href: string;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-target
+     */
+    readonly target?: ButtonTargetType;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-download
+     */
+    readonly download: boolean;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-download
+     */
+    readonly tab: number;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-hreflang
+     */
+    readonly hreflang: string;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-referrerpolicy
+     */
+    readonly referrerpolicy: string;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-rel
+     */
+    readonly rel: string;
+    /**
+     * Indicates whether an asynchronous process is running
+     */
+    readonly loading: string;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/focusable
+     */
+    readonly focusable: boolean;
+    /**
+     * Custom button identifier
+     */
+    readonly identifier: string;
+    /**
+     * Emitted when the button click
+     */
+    govClick: EventEmitter<ButtonEvent>;
+    /**
+     * Emitted when the button has focus
+     */
+    govFocus: EventEmitter<ButtonEvent>;
+    /**
+     * Emitted when the button loses focus
+     */
+    govBlur: EventEmitter<ButtonEvent>;
+    validateColor(newValue: string): void;
+    validateType(newValue: string): void;
+    validateSize(newValue: string): void;
+    validateNativeType(newValue: string): void;
+    inheritedAttributes: Attributes;
+    componentDidLoad(): void;
+    onAriaAttributeChange(attributeName: string, newValue: string): void;
+    disconnectedCallback(): void;
+    componentWillLoad(): void;
+    componentDidRender(): Promise<void>;
+    connectedCallback(): void;
+    render(): any;
+    private onClickHandler;
+    private onFocusHandler;
+    private onBlurHandler;
+    /**
+     * Focus button element
+     */
+    setFocus(): Promise<void>;
+    /**
+     * Returns a clickable element instance
+     */
+    getRef(): Promise<HTMLButtonElement | HTMLLinkElement>;
+    /**
+     * Validate the Accessibility attributes of the component
+     */
+    validateAccessibility(): Promise<void>;
+}

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

@@ -0,0 +1,4 @@
+import { GovBaseEvent } from "../../../types/event.types";
+export interface ButtonEvent extends GovBaseEvent {
+    ref: HTMLGovButtonElement;
+}

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

@@ -0,0 +1,10 @@
+import { ValueOf } from "../../../types/interfaces";
+export declare enum Position {
+    LEFT = "left",
+    RIGHT = "right"
+}
+export type PositionType = `${ValueOf<typeof Position>}`;
+export declare const DropdownClass: {
+    root: string;
+    list: string;
+};

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

@@ -0,0 +1,40 @@
+import { EventEmitter } from "../../../stencil-public-runtime";
+import { Nullable } from "../../../types/interfaces";
+import { PositionType } from "./constants";
+import { DropdownEvent } from "./gov-dropdown.types";
+export declare class GovDropdown {
+    private h;
+    private readonly listId;
+    private readonly controlId;
+    constructor();
+    host: HTMLGovButtonElement;
+    /**
+     * Custom trigger identifier
+     */
+    readonly identifier: string;
+    /**
+     * Dropdown state
+     */
+    open: boolean;
+    /**
+     * Menu display position
+     */
+    readonly position: PositionType;
+    /**
+     * Emitted when the dropdown change state
+     */
+    govChange: EventEmitter<DropdownEvent>;
+    watchOpen(): void;
+    get trigger(): HTMLGovButtonElement;
+    get list(): Nullable<HTMLUListElement>;
+    componentWillLoad(): void;
+    render(): any;
+    /**
+     * Returns the current state of the dropdown
+     */
+    getState(): Promise<boolean>;
+    /**
+     * Toggle state of dropdown
+     */
+    toggle(): Promise<void>;
+}

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

@@ -0,0 +1,4 @@
+import { GovBaseEvent } from "../../../types/event.types";
+export interface DropdownEvent extends GovBaseEvent {
+    open: boolean;
+}

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

@@ -0,0 +1,16 @@
+import { ValueOf } from "../../types/interfaces";
+export declare enum CardDirection {
+    HORIZONTAL = "horizontal",
+    VERTICAL = "vertical"
+}
+export type CardDirectionType = `${ValueOf<typeof CardDirection>}`;
+export declare const CardClass: {
+    root: string;
+    header: string;
+    arrow: string;
+    inner: string;
+    img: string;
+    icon: string;
+    content: string;
+    footer: string;
+};

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

@@ -0,0 +1,57 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { CardDirectionType } from './constants';
+import { GovCardChangeEvent } from './interfaces';
+import { ButtonTargetType } from "../gov-button/button/constants";
+export declare class GovCard {
+    private h;
+    private readonly headlineId;
+    private readonly contentId;
+    private hydrated;
+    constructor();
+    host: HTMLGovCardElement;
+    /**
+     * Card direction
+     */
+    readonly direction: CardDirectionType;
+    /**
+     * Defines weather the card can be collapsible
+     */
+    readonly collapsible: boolean;
+    /**
+     * Defines weather the card can be clickable with hover effect
+     */
+    readonly clickable: boolean;
+    /**
+     * Defines whether the card is open or closed
+     */
+    open: boolean;
+    /**
+     * Link on whole card
+     */
+    readonly href: string;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-target
+     */
+    readonly target?: ButtonTargetType;
+    /**
+     * Adds accessible label for the collapsible button that is only shown for screen readers.
+     */
+    accessibleTriggerLabel: string;
+    /**
+     * A string of identifiers that indicate alternative label elements for collapsible card
+     */
+    accessibleTriggerLabelledBy: string;
+    /**
+     * Called when the card toggle state changes
+     */
+    govToggle: EventEmitter<GovCardChangeEvent>;
+    componentDidRender(): Promise<void>;
+    connectedCallback(): void;
+    render(): any;
+    private onClickHandler;
+    /**
+     * Validate the accessible attributes of the component
+     */
+    validateAccessibility(): Promise<void>;
+}

package/dist/dist/types/components/gov-card/interfaces.d.ts

@@ -0,0 +1,4 @@
+export interface GovCardChangeEvent {
+    open: boolean;
+    element: HTMLGovCardElement;
+}

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

@@ -0,0 +1,21 @@
+import { ValueOf } from '../../types/interfaces';
+import { Sizes } from "../../core/constants/sizes";
+export declare const ChipSizes: Pick<typeof Sizes, "_XS" | "_S" | "_M">;
+export type ChipSizesType = `${ValueOf<typeof ChipSizes>}`;
+export declare enum ChipType {
+    SOLID = "solid",
+    OUTLINED = "outlined"
+}
+export type ChipTypesType = `${ValueOf<typeof ChipType>}`;
+export declare enum NativeType {
+    A = "a",
+    SPAN = "span",
+    BUTTON = "button"
+}
+export type NativeTypesType = `${ValueOf<typeof NativeType>}`;
+export declare const ChipClass: {
+    root: string;
+    inner: string;
+    hasRight: string;
+    hasLeft: string;
+};

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

@@ -0,0 +1,82 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { ChipSizesType, ChipTypesType, NativeTypesType } from "./constants";
+import { ButtonColorType } from "../gov-button/button/constants";
+import { Attributes } from "../../helpers/Dom/attribute";
+export declare class GovChip {
+    private triggerRef?;
+    private h;
+    private readonly chipId;
+    private hydrated;
+    private attributeObserver;
+    constructor();
+    host: HTMLGovChipElement;
+    /**
+     * Makes the chip component disabled.
+     */
+    readonly disabled: boolean;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-href
+     */
+    readonly href: string;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-target
+     */
+    readonly target: string;
+    /**
+     * Definition of the button icon on the left. The icon must be defined in the form "type/name".
+     */
+    readonly iconStart?: string;
+    /**
+     * Definition of the button icon on the left. The icon must be defined in the form "type/name".
+     */
+    readonly iconEnd?: string;
+    /**
+     * Chip’s size.
+     */
+    readonly size: ChipSizesType;
+    /**
+     * Used to change the HTML tag in the chip
+     */
+    readonly tag: NativeTypesType;
+    /**
+     * Style variation of the chip.
+     */
+    readonly color: ButtonColorType;
+    /**
+     * Chip’s type
+     */
+    readonly type: ChipTypesType;
+    /**
+     * Same as original parameter
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/focusable
+     */
+    readonly focusable: boolean;
+    /**
+     * Custom chip identifier. Otherwise, it will be generated
+     */
+    readonly identifier: string;
+    /**
+     * Emitted when the button click.
+     */
+    govClick: EventEmitter<PointerEvent>;
+    validateColor(newValue: string): void;
+    validateSize(newValue: string): void;
+    inheritedAttributes: Attributes;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    disconnectedCallback(): void;
+    connectedCallback(): void;
+    onAriaAttributeChange(attributeName: string, newValue: string): void;
+    render(): any;
+    private onClickHandler;
+    /**
+     * Returns a clickable element instance
+     */
+    geRef(): Promise<HTMLButtonElement | HTMLLinkElement | HTMLSpanElement>;
+    /**
+     * Focus button element
+     */
+    setFocus(): Promise<void>;
+}

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

@@ -0,0 +1,18 @@
+import { Sizes } from "../../core/constants/sizes";
+import { ValueOf } from "../../types/interfaces";
+export declare const CollapsibleSizes: Pick<typeof Sizes, "_XS" | "_S" | "_M" | "_L" | "_XL">;
+export type CollapsibleSizesType = `${ValueOf<typeof CollapsibleSizes>}`;
+export declare enum CollapsibleDirection {
+    DOWN = "down",
+    UP = "up"
+}
+export type CollapsibleDirectionType = `${ValueOf<typeof CollapsibleDirection>}`;
+export declare const CollapsibleClass: {
+    root: string;
+    details: string;
+    summary: string;
+    title: string;
+    arrow: string;
+    content: string;
+    disabled: string;
+};

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

@@ -0,0 +1,36 @@
+import { CollapsibleSizesType } from './constants';
+import { Attributes } from "../../helpers/Dom/attribute";
+export declare class GovCollapsible {
+    private h;
+    private hydrated;
+    private readonly triggerId;
+    private readonly contentId;
+    private attributeObserver;
+    constructor();
+    host: HTMLGovCollapsibleElement;
+    /**
+     * Element size.
+     */
+    readonly size?: CollapsibleSizesType;
+    /**
+     * Custom input identifier.
+     */
+    readonly identifier: string;
+    readonly label: string;
+    /**
+     * Makes component disabled.
+     */
+    readonly disabled: boolean;
+    /**
+     * Defines whether the collapsible is open or closed
+     */
+    open: boolean;
+    inheritedAttributes: Attributes;
+    validateSize(newValue: string): void;
+    componentDidLoad(): void;
+    componentWillLoad(): void;
+    onAriaAttributeChange(attributeName: string, newValue: string): void;
+    disconnectedCallback(): void;
+    connectedCallback(): void;
+    render(): any;
+}

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

@@ -0,0 +1,3 @@
+export declare const ContainerClass: {
+    root: string;
+};

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

@@ -0,0 +1,6 @@
+export declare class GovContainer {
+    private h;
+    constructor();
+    host: HTMLGovContainerElement;
+    render(): any;
+}

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

@@ -0,0 +1,7 @@
+import { Colors } from '../../core/constants/colors';
+import { ValueOf } from '../../types/interfaces';
+export declare const ControlGroupColors: Pick<typeof Colors, "PRIMARY" | "NEUTRAL" | "ERROR">;
+export type ControlGroupColorType = `${ValueOf<typeof ControlGroupColors>}`;
+export declare const ControlGroupClass: {
+    root: string;
+};

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

@@ -0,0 +1,24 @@
+import { ControlGroupColorType } from "./constants";
+export declare class GovControlGroup {
+    private readonly h;
+    constructor();
+    host: HTMLGovControlGroupElement;
+    /**
+     * Style variation of the content message.
+     */
+    readonly color: ControlGroupColorType;
+    /**
+     * Specifies the display of the border between elements
+     */
+    readonly noBorder: boolean;
+    /**
+     * Specifies the display of the border between elements
+     */
+    readonly noInnerBorder: boolean;
+    /**
+     * Specifies the display of elements to full width
+     */
+    readonly fitContent: boolean;
+    validateColor(newValue: string): void;
+    render(): any;
+}

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

@@ -0,0 +1,7 @@
+export declare const CookieConsentClass: {
+    root: string;
+    content: string;
+    actions: string;
+    actionsPrimary: string;
+    actionsSecondary: string;
+};

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

@@ -0,0 +1,7 @@
+import { GovHost } from '../../helpers/Dom/template.types';
+export declare class GovCookiebar {
+    h: GovHost;
+    constructor();
+    host: HTMLGovCookiebarElement;
+    render(): any;
+}

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

@@ -0,0 +1,11 @@
+export declare const DialogClass: {
+    root: string;
+    dialog: string;
+    inner: string;
+    header: string;
+    title: string;
+    content: string;
+    close: string;
+    footer: string;
+    bodyFix: string;
+};

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

@@ -0,0 +1,70 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { Nullable } from '../../types/interfaces';
+export declare class GovDialog {
+    private h;
+    private readonly labelId;
+    private readonly contentId;
+    private hydrated;
+    private closeCtaRef?;
+    private dialogRef?;
+    private lastActiveElementRef?;
+    constructor();
+    host: HTMLGovDialogElement;
+    /**
+     * Attribute for dialog window display
+     */
+    open: boolean;
+    /**
+     * Attribute allowing blocking the dialog closing
+     */
+    blockClose: boolean;
+    /**
+     * Attribute allowing blocking the backdrop dialog closing
+     */
+    blockBackdropClose: boolean;
+    /**
+     * Role of dialog
+     */
+    role: Nullable<string>;
+    /**
+     * Used to change the HTML tag in the dialog label for correct semantic structure
+     */
+    readonly labelTag: string;
+    /**
+     * String of id's that indicates alternative labels elements
+     */
+    accessibleLabelledBy: string;
+    /**
+     * Indicates the id of a component that describes the dialog.
+     */
+    accessibleDescribedBy: string;
+    /**
+     * Adds accessible label for the dialog close button that is only shown for screen readers.
+     */
+    readonly accessibleCloseLabel: string;
+    /**
+     * A string of identifiers that indicate alternative label elements for closing the dialog window
+     */
+    accessibleCloseLabelledBy: string;
+    /**
+     * Emitted when a dialog window closes.
+     */
+    govClose: EventEmitter<PointerEvent>;
+    watchOpen(newValue: boolean): void;
+    private showDialog;
+    private hideDialog;
+    componentDidRender(): Promise<void>;
+    private focusTrap;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    render(): any;
+    private onCloseHandler;
+    /**
+     * Sets the close button to focus
+     */
+    setFocus(): Promise<void>;
+    /**
+     * Validate the WCAG attributes of the component
+     */
+    validateAccessibility(): Promise<void>;
+}

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

@@ -0,0 +1,19 @@
+import { Sizes } from "../../core/constants/sizes";
+import { ValueOf } from "../../types/interfaces";
+export declare const EmptySizes: Pick<typeof Sizes, "_S" | "_M" | "_L">;
+export type EmptySizesType = `${ValueOf<typeof EmptySizes>}`;
+export declare enum EmptyDirection {
+    HORIZONTAL = "horizontal",
+    VERTICAL = "vertical"
+}
+export type EmptyDirectionType = `${ValueOf<typeof EmptyDirection>}`;
+export declare enum EmptyAlign {
+    LEFT = "left",
+    CENTER = "center",
+    RIGHT = "right"
+}
+export type EmptyAlignType = `${ValueOf<typeof EmptyAlign>}`;
+export declare const EmptyClass: {
+    root: string;
+    content: string;
+};

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

@@ -0,0 +1,21 @@
+import { EmptyAlignType, EmptyDirectionType, EmptySizesType } from './constants';
+export declare class GovEmpty {
+    private h;
+    constructor();
+    host: HTMLGovEmptyElement;
+    /**
+     * Element size.
+     */
+    readonly size?: EmptySizesType;
+    /**
+     * Element direction
+     */
+    readonly direction: EmptyDirectionType;
+    /**
+     * Element alignment.
+     */
+    readonly align?: EmptyAlignType;
+    validateSize(newValue: string): void;
+    componentWillLoad(): void;
+    render(): any;
+}

package/dist/dist/types/components/gov-error-code/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const ErrorCodeClass: {
+    root: string;
+    content: string;
+};

package/dist/dist/types/components/gov-error-code/gov-error-code.d.ts

@@ -0,0 +1,6 @@
+export declare class GovErrorCode {
+    private h;
+    constructor();
+    host: HTMLGovErrorCodeElement;
+    render(): any;
+}

package/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;
+};