gov-gui
Version:
Gov UI Component Library Typscript Build
1,310 lines • 135 kB
TypeScript
/* eslint-disable */
/* tslint:disable */
/**
* This is an autogenerated file created by the Stencil compiler.
* It contains typing information for all components that exist in this project.
*/
import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
import { ChartType } from "chart.js/auto";
import { FunctionalComponent } from "./stencil-public-runtime";
import { RadioOption } from "./components/gov-radiobutton/gov-radiobutton";
export { ChartType } from "chart.js/auto";
export { FunctionalComponent } from "./stencil-public-runtime";
export { RadioOption } from "./components/gov-radiobutton/gov-radiobutton";
export namespace Components {
interface GovAccordion {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"openIndex": number;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"open-index"?: number;
}
interface GovAccordionItem {
"label": string;
}
interface GovAlert {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"header": string | number;
"icon": string;
"label": string | number;
"showIcons": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-icons"?: boolean;
"variant": string;
}
interface GovAvatar {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"hasNotification": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"has-notification"?: boolean;
"imgUrl": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"img-url"?: string;
"initials": string;
"notificationCount": number;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"notification-count"?: number;
"size": 'small' | 'medium' | 'large';
"status": 'online' | 'offline' | 'busy' | null;
}
interface GovBadge {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"classes"?: string;
"size"?: string;
"styles"?: { [key: string]: string };
"variant"?: string;
}
interface GovBox {
"align": 'start' | 'center' | 'end';
"auto": boolean;
"classes": string;
"gap": string;
"isFlexBox": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"is-flex-box"?: boolean;
"justify": 'start' | 'center' | 'end' | 'between' | 'around' | 'evenly';
"lg": number;
"md": number;
"size": number;
"sm": number;
"styles": { [key: string]: string };
"xl": number;
"xs": number;
}
interface GovBreadcrumb {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
}
interface GovButton {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"clicked"?: (event: MouseEvent) => void;
"disabled": boolean;
"hasPrefix": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"has-prefix"?: boolean;
"hasSuffix": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"has-suffix"?: boolean;
"icon": string;
"iconSize": 'sm' | 'md' | 'lg';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"icon-size"?: 'sm' | 'md' | 'lg';
"label": string | number;
"size": string;
"type"?: string;
"typeVariant": 'button' | 'textButton' | 'iconButton';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"type-variant"?: 'button' | 'textButton' | 'iconButton';
"variant": string;
}
interface GovCalender {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"date": Map<string, any>;
"required": boolean;
"validate": () => Promise<boolean>;
}
interface GovCard {
"alignment": 'vertical' | 'horizontal';
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"buttonText": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"button-text"?: string;
"cardTitle": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"card-title"?: string;
"description": string;
"imageClip": 'cover' | 'contain' | 'fill' | 'none';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"image-clip"?: 'cover' | 'contain' | 'fill' | 'none';
"imageSrc": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"image-src"?: string;
"showButton": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-button"?: boolean;
}
interface GovChart {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"data": any;
"options": any;
"type": ChartType;
}
interface GovCheckbox {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"checked": boolean;
"disabled": boolean;
/**
* Returns the current value of the checkbox. If checked, returns the `value` prop; otherwise, returns an empty string.
*/
"getValue": () => Promise<string>;
"label": string;
"required": boolean;
"requiredErrorMessage": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"required-error-message"?: string;
/**
* Public method to validate the checkbox. If the checkbox is required and not checked, sets an error message and returns false.
*/
"validate": () => Promise<boolean>;
"value": string;
}
interface GovChip {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"disabled": boolean;
"label": string;
"selected": boolean;
"size": 'sm' | 'md' | 'lg';
"variant": 'primary' | 'secondary' | 'tertiary';
}
interface GovChoiceChips {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"name": string;
}
interface GovComboBox {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"description": string;
"label": string;
"options": string | string[];
}
interface GovContainer {
"fluid": boolean;
"size": 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
}
interface GovDateTimePicker {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"date": string;
"required": boolean;
"time": string;
/**
* Public method to validate the component. If the component is required and no date is selected, it sets an error message.
*/
"validate": () => Promise<boolean>;
}
interface GovDrop {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"heading": string;
"options": string | string[];
"subtitle": string;
}
interface GovDropdown {
"options": number[];
"selected": number;
}
interface GovForm {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"cancelBtnText"?: string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"cancel-btn-text"?: string;
"encType"?: string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"enc-type"?: string;
"header": string;
"hideCancelBtn"?: boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"hide-cancel-btn"?: boolean;
"hideSubmitBtn"?: boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"hide-submit-btn"?: boolean;
"method"?: string;
"resetOnSubmit": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"reset-on-submit"?: boolean;
"submitBtnText"?: string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"submit-btn-text"?: string;
"url"?: string;
"variant"?: string;
}
interface GovIcon {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"color"?: string;
"name": string;
"size": string;
"variant": string;
}
interface GovInput {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"disabled": boolean;
"errorMessage": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"error-message"?: string;
"getValue": () => Promise<string>;
"icon": string;
"label": string;
"legend": string;
"maxlength": number;
"placeholder": string;
"required": boolean;
"requiredErrorMessage": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"required-error-message"?: string;
"type": string;
"validate": () => Promise<boolean>;
"validationPattern": RegExp;
"value": string;
}
interface GovLayout {
"avatarImgUrl": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"avatar-img-url"?: string;
"avatarInitials": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"avatar-initials"?: string;
"menuType": 'admin' | 'site';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"menu-type"?: 'admin' | 'site';
"showSideBarAvatar": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-side-bar-avatar"?: boolean;
"showTopBarAvatar": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-top-bar-avatar"?: boolean;
"sidebarItems": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"sidebar-items"?: string;
"sidebarUsername": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"sidebar-username"?: string;
"topBarItems": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"top-bar-items"?: string;
"topBarUsername": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"top-bar-username"?: string;
}
interface GovLayoutOld {
"sidebar"?: string | FunctionalComponent;
"topbar"?: string | FunctionalComponent;
}
interface GovList {
"alignment": string;
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"items": any;
}
interface GovMenubar {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* The menu items passed as an array of objects
*/
"items": string | { label: string; link?: string; icon?: string; subItems?: { label: string; link?: string; icon?: string; subSubItems?: { label: string; link?: string; icon?: string }[] }[] }[];
/**
* The type of menu: 'horizontal', 'vertical', or 'sticky'
*/
"type": 'horizontal' | 'vertical' | 'sticky';
}
interface GovModal {
"Subheader": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"subheader"?: string;
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* Allow closing by clicking backdrop
*/
"backdropClose": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"backdrop-close"?: boolean;
/**
* Cancel button text
*/
"cancelButtonText": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"cancel-button-text"?: string;
/**
* Cancel button variant
*/
"cancelButtonVariant": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"cancel-button-variant"?: string;
/**
* Close the modal
*/
"close": () => Promise<void>;
/**
* Close modal on ESC key
*/
"closeOnEsc": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"close-on-esc"?: boolean;
/**
* Confirm button text
*/
"confirmButtonText": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"confirm-button-text"?: string;
/**
* Confirm button variant
*/
"confirmButtonVariant": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"confirm-button-variant"?: string;
/**
* Prevent all manual closing
*/
"disableClose": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"disable-close"?: boolean;
/**
* Fullscreen modal
*/
"fullscreen": boolean;
/**
* Modal header/title
*/
"header": string;
/**
* Controls the visibility of the modal (two-way binding)
*/
"isOpen": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"is-open"?: boolean;
/**
* Open the modal
*/
"open": () => Promise<void>;
/**
* Show/hide cancel button
*/
"showCancelButton": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-cancel-button"?: boolean;
/**
* Show/hide confirm button
*/
"showConfirmButton": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-confirm-button"?: boolean;
/**
* Show footer section
*/
"showFooter": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-footer"?: boolean;
/**
* Show header section
*/
"showHeader": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-header"?: boolean;
"showSubHeader": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-sub-header"?: boolean;
/**
* Modal size variant
*/
"size": 'small' | 'medium' | 'large';
}
interface GovPagination {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"currentPage": number;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"current-page"?: number;
"maxVisible": number;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"max-visible"?: number;
"showFirstLast": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-first-last"?: boolean;
"totalPages": number;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"total-pages"?: number;
}
interface GovPopups {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* Allow clicking on the backdrop to close the modal
*/
"backdropClose": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"backdrop-close"?: boolean;
/**
* Cancel button text
*/
"cancelButtonText": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"cancel-button-text"?: string;
"cancelButtonVariant": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"cancel-button-variant"?: string;
/**
* Closes the modal
*/
"closeModal": () => Promise<void>;
/**
* Confirm button text
*/
"confirmButtonText": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"confirm-button-text"?: string;
/**
* Modal variant (style theme)
*/
"confirmButtonVariant": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"confirm-button-variant"?: string;
/**
* Prevent closing the modal manually
*/
"disableClose": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"disable-close"?: boolean;
/**
* Modal title/header
*/
"header": string;
/**
* Opens the modal
*/
"openModal": () => Promise<void>;
/**
* Show/hide cancel button
*/
"showCancelButton": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-cancel-button"?: boolean;
/**
* Show/hide confirm button
*/
"showConfirmButton": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-confirm-button"?: boolean;
/**
* Modal subheader
*/
"subheader": string;
}
interface GovProgressBar {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"label"?: string;
"progress": number;
"type": 'linear' | 'circular';
"variant": any;
}
interface GovRadiobutton {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"heading": string;
"name": string;
"options": string[] | RadioOption[] | string;
"required": boolean;
"requiredErrorMessage": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"required-error-message"?: string;
"subtitle": string;
/**
* Public method to validate the radio button group. If required is true and no option is selected, sets an error message and returns false.
*/
"validate": () => Promise<boolean>;
"value": string;
}
interface GovRow {
"align": 'start' | 'center' | 'end' | 'stretch' | 'baseline';
"classes": string;
"gap": string;
"justify": 'start' | 'center' | 'end' | 'between' | 'around' | 'evenly';
"reverse": boolean;
"styles": { [key: string]: string };
}
interface GovSegmentedChips {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"name": string;
"variant": 'filled' | 'outlined' | 'disabled';
}
interface GovSidebar {
"avatarImgUrl": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"avatar-img-url"?: string;
"avatarInitials": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"avatar-initials"?: string;
"items": string;
"showSideBarAvatar": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-side-bar-avatar"?: boolean;
"sidebarUsername": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"sidebar-username"?: string;
}
interface GovSlider {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"label": string;
"max": number;
"min": number;
"step": number;
"value": number;
}
interface GovStepper {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"maxStepsVisible": number;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"max-steps-visible"?: number;
"nextText": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"next-text"?: string;
"onSubmit": () => Promise<void>;
"prevText": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"prev-text"?: string;
"resetOnSubmit": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"reset-on-submit"?: boolean;
"submitText": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"submit-text"?: string;
"validateStep": (step: number) => Promise<boolean> | boolean;
"variant": 'horizontal' | 'vertical';
}
interface GovSwitcher {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"disabled": boolean;
"hasIcons": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"has-icons"?: boolean;
"isOn": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"is-on"?: boolean;
"showLabel": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-label"?: boolean;
"size": 'small' | 'medium';
}
interface GovTable {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* JSON stringified 2D array for the table data
*/
"data": string;
/**
* JSON stringified array of headings, e.g. '["Name", "Age", "Country"]'
*/
"headings": string;
/**
* JSON stringified array of row action objects. Each action object should have a `label` and an `action` identifier, e.g.: `[{"label": "Edit", "action": "edit"}, {"label": "Delete", "action": "delete"}]`
*/
"rowActions"?: string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"row-actions"?: string;
/**
* Number of rows per page
*/
"rowsPerPage": number;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"rows-per-page"?: number;
}
interface GovTabs {
"activeTab": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"active-tab"?: string;
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"disabledTabs": string | string[];
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"disabled-tabs"?: string | string[];
"tabList": string | string[];
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"tab-list"?: string | string[];
}
interface GovToaster {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"duration": number;
"icon": string;
"message": string;
"show": () => Promise<void>;
"variant": 'success' | 'danger' | 'warning' | 'info' | 'white';
}
interface GovTooltip {
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"color": 'dark' | 'light';
"hoverDelay": number;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"hover-delay"?: number;
"position": 'top' | 'right' | 'bottom' | 'left';
"size": 'sm' | 'lg';
"text": string;
}
interface GovTopbar {
"avatarImgUrl": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"avatar-img-url"?: string;
"avatarInitials": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"avatar-initials"?: string;
"menuType": 'admin' | 'site';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"menu-type"?: 'admin' | 'site';
"showTopBarAvatar": boolean;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"show-top-bar-avatar"?: boolean;
"siteMenuItems": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"site-menu-items"?: string;
"topBarUsername": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"top-bar-username"?: string;
}
interface GovUpload {
"allowedFileTypes": string | string[];
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"allowed-file-types"?: string | string[];
"animation"?: string;
"animationDelay"?: '2s' | '3s' | '4s' | '5s';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-delay"?: '2s' | '3s' | '4s' | '5s';
"animationSpeed"?: 'slow' | 'slower' | 'fast' | 'faster';
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"animation-speed"?: 'slow' | 'slower' | 'fast' | 'faster';
"fileNameValue": string;
/**
* @deprecated use camelCase instead. Support for dash-casing will be removed in Stencil v5.
*/
"file-name-value"?: string;
"required": boolean;
/**
* Public method to set the upload URL through script.
*/
"setUploadUrl": (url: string) => Promise<void>;
/**
* Public method to validate that a file has been uploaded when required. Returns true if valid; otherwise, sets an error status and returns false.
*/
"validate": () => Promise<boolean>;
}
interface MyComponent {
/**
* The first name
*/
"first": string;
/**
* The last name
*/
"last": string;
/**
* The middle name
*/
"middle": string;
}
interface PageSample {
}
}
export interface GovCardCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovCardElement;
}
export interface GovCheckboxCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovCheckboxElement;
}
export interface GovDateTimePickerCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovDateTimePickerElement;
}
export interface GovDropdownCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovDropdownElement;
}
export interface GovFormCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovFormElement;
}
export interface GovInputCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovInputElement;
}
export interface GovListCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovListElement;
}
export interface GovModalCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovModalElement;
}
export interface GovPaginationCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovPaginationElement;
}
export interface GovPopupsCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovPopupsElement;
}
export interface GovRadiobuttonCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovRadiobuttonElement;
}
export interface GovSliderCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovSliderElement;
}
export interface GovStepperCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovStepperElement;
}
export interface GovSwitcherCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovSwitcherElement;
}
export interface GovTableCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLGovTableElement;
}
declare global {
interface HTMLGovAccordionElement extends Components.GovAccordion, HTMLStencilElement {
}
var HTMLGovAccordionElement: {
prototype: HTMLGovAccordionElement;
new (): HTMLGovAccordionElement;
};
interface HTMLGovAccordionItemElement extends Components.GovAccordionItem, HTMLStencilElement {
}
var HTMLGovAccordionItemElement: {
prototype: HTMLGovAccordionItemElement;
new (): HTMLGovAccordionItemElement;
};
interface HTMLGovAlertElement extends Components.GovAlert, HTMLStencilElement {
}
var HTMLGovAlertElement: {
prototype: HTMLGovAlertElement;
new (): HTMLGovAlertElement;
};
interface HTMLGovAvatarElement extends Components.GovAvatar, HTMLStencilElement {
}
var HTMLGovAvatarElement: {
prototype: HTMLGovAvatarElement;
new (): HTMLGovAvatarElement;
};
interface HTMLGovBadgeElement extends Components.GovBadge, HTMLStencilElement {
}
var HTMLGovBadgeElement: {
prototype: HTMLGovBadgeElement;
new (): HTMLGovBadgeElement;
};
interface HTMLGovBoxElement extends Components.GovBox, HTMLStencilElement {
}
var HTMLGovBoxElement: {
prototype: HTMLGovBoxElement;
new (): HTMLGovBoxElement;
};
interface HTMLGovBreadcrumbElement extends Components.GovBreadcrumb, HTMLStencilElement {
}
var HTMLGovBreadcrumbElement: {
prototype: HTMLGovBreadcrumbElement;
new (): HTMLGovBreadcrumbElement;
};
interface HTMLGovButtonElement extends Components.GovButton, HTMLStencilElement {
}
var HTMLGovButtonElement: {
prototype: HTMLGovButtonElement;
new (): HTMLGovButtonElement;
};
interface HTMLGovCalenderElement extends Components.GovCalender, HTMLStencilElement {
}
var HTMLGovCalenderElement: {
prototype: HTMLGovCalenderElement;
new (): HTMLGovCalenderElement;
};
interface HTMLGovCardElementEventMap {
"cardButtonClicked": void;
}
interface HTMLGovCardElement extends Components.GovCard, HTMLStencilElement {
addEventListener<K extends keyof HTMLGovCardElementEventMap>(type: K, listener: (this: HTMLGovCardElement, ev: GovCardCustomEvent<HTMLGovCardElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
removeEventListener<K extends keyof HTMLGovCardElementEventMap>(type: K, listener: (this: HTMLGo