@gov-design-system-ce/components 4.0.5 → 4.0.6

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

@@ -0,0 +1,12 @@
+import { MessageVariantType } from "./constants";
+export declare class GovMessage {
+  private h;
+  constructor();
+  host: HTMLGovMessageElement;
+  /**
+   * Style variation of the content message.
+   */
+  readonly variant: MessageVariantType;
+  validateVariant(newValue: string): void;
+  render(): any;
+}

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

@@ -0,0 +1,14 @@
+export declare const ModalClass: {
+  root: string;
+  rootPrompt: string;
+  dialog: string;
+  inner: string;
+  header: string;
+  icon: string;
+  title: string;
+  content: string;
+  close: string;
+  footer: string;
+  actions: string;
+  bodyFix: string;
+};

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

@@ -0,0 +1,69 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { Nullable } from '../../types/interfaces';
+export declare class GovModal {
+  private h;
+  private readonly labelId;
+  private readonly contentId;
+  constructor();
+  host: HTMLGovModalElement;
+  /**
+   * Attribute for modal window display
+   */
+  open: boolean;
+  /**
+   * Attribute allowing blocking the modal closing
+   */
+  blockClose: boolean;
+  /**
+   * Title of modal window
+   */
+  label: string;
+  /**
+   * Role of modal
+   */
+  role: Nullable<string>;
+  /**
+   * Used to change the HTML tag in the modal label for correct semantic structure
+   */
+  readonly labelTag: string;
+  /**
+   * String of id's that indicate alternative labels elements
+   */
+  wcagLabelledBy: string;
+  /**
+   * Indicates the id of a component that describes the modal.
+   */
+  wcagDescribedBy: string;
+  /**
+   * Adds accessible label for the modal close button that is only shown for screen readers.
+   */
+  readonly wcagCloseLabel: string;
+  /**
+   * A string of identifiers that indicate alternative label elements for closing the modal window
+   */
+  wcagCloseLabelledBy: string;
+  /**
+   * Emitted when modal window closes.
+   */
+  govClose: EventEmitter<PointerEvent>;
+  validateLabelTag(newValue: string): void;
+  watchOpen(newValue: boolean): void;
+  private showModal;
+  private hideModal;
+  componentWillRender(): Promise<void>;
+  componentDidRender(): Promise<void>;
+  render(): any;
+  private onCloseHandler;
+  /**
+   * Showing the modal
+   */
+  show(): Promise<void>;
+  /**
+   * Hiding the modal
+   */
+  hide(): Promise<void>;
+  /**
+   * Validate the WCAG attributes of the component
+   */
+  validateWcag(): Promise<void>;
+}

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

@@ -0,0 +1,8 @@
+export declare const NavClass: {
+  root: string;
+  nav: string;
+};
+export declare const NavItemClass: {
+  root: string;
+  link: string;
+};

package/dist/types/components/gov-nav/gov-nav-item.d.ts

@@ -0,0 +1,12 @@
+export declare class GovNavItem {
+  readonly host: HTMLGovNavItemElement;
+  isExpandedState: boolean;
+  /**
+   * Same as original parameter
+   * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-href
+   */
+  readonly href: string;
+  validateHref(newValue: string): void;
+  componentWillLoad(): void;
+  render(): any;
+}

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

@@ -0,0 +1,17 @@
+export declare class GovNav {
+  readonly host: HTMLGovNavElement;
+  /**
+   * Adds accessible label for the accordion that is only shown for screen readers.
+   */
+  readonly wcagLabel: string;
+  /**
+   * String of id's that indicate alternative labels elements
+   */
+  readonly wcagLabelledBy: string;
+  componentDidRender(): Promise<void>;
+  render(): any;
+  /**
+   * Validate the WCAG attributes of the component
+   */
+  validateWcag(): Promise<void>;
+}

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

@@ -0,0 +1,22 @@
+import { Sizes } from '../../core/constants/sizes';
+import { Variants } from '../../core/constants/variants';
+import { ValueOf } from '../../types/interfaces';
+export declare const PaginationSizes: Pick<typeof Sizes, "_S" | "_M">;
+export type PaginationSizeType = `${ValueOf<typeof PaginationSizes>}`;
+export declare const PaginationVariants: Pick<typeof Variants, "PRIMARY" | "SECONDARY">;
+export type PaginationVariantType = `${ValueOf<typeof PaginationVariants>}`;
+export declare enum PaginationTypes {
+  BUTTON = "button",
+  SELECT = "select"
+}
+export type PaginationType = `${ValueOf<typeof PaginationTypes>}`;
+export declare const PaginationClass: {
+  root: string;
+  list: string;
+  item: string;
+  itemArrow: string;
+  itemMore: string;
+  itemSelect: string;
+  inner: string;
+  arrow: string;
+};

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

@@ -0,0 +1,87 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { PaginationSizeType, PaginationVariantType, PaginationType } from "./constants";
+import { Pagination } from "./pagination";
+import { PaginationEvent } from "./gov-pagination.types";
+export declare class GovPagination {
+  private h;
+  private readonly pageSelectId;
+  private spreadSelectRef?;
+  constructor();
+  readonly host: HTMLGovPaginationElement;
+  /**
+   * Pagination type
+   */
+  readonly type: PaginationType;
+  /**
+   * Currently displayed page
+   */
+  readonly current: number;
+  /**
+   * Total count of entries
+   */
+  readonly total: number;
+  /**
+   * Set on active page
+   */
+  readonly inverse: boolean;
+  /**
+   * Pagination's size
+   */
+  readonly size?: PaginationSizeType;
+  /**
+   * Style variation of the pagination.
+   */
+  readonly variant?: PaginationVariantType;
+  /**
+   * Maximum number of entries per page
+   */
+  readonly pageSize: number;
+  /**
+   * Maximum pages displayed for selection
+   */
+  readonly maxPages: number;
+  /**
+   * Setting a link to redirect to a given page.
+   * The {PAGE} wildcard can be used in the link to replace the page number.
+   * Note that in the case of paging through a link, it is always necessary to send to the component the current page where the user is.
+   */
+  readonly link: string;
+  /**
+   * Adds accessible label for the pagination that is only shown for screen readers.
+   */
+  readonly wcagLabel: string;
+  /**
+   * Indicates the id of a component that labels the pagination.
+   */
+  readonly wcagLabelledBy: string;
+  /**
+   * Adds accessible label for the page select
+   */
+  readonly wcagSelectLabel: string;
+  /**
+   * Adds accessible label for the page item
+   */
+  readonly wcagPageLabel: string;
+  /**
+   * Event called when changing the page with the current setting of the whole paging
+   */
+  govPage: EventEmitter<PaginationEvent>;
+  pagination: Pagination;
+  validateType(newValue: string): void;
+  validateSize(newValue: string): void;
+  validateVariant(newValue: string): void;
+  recalculate(): void;
+  componentWillLoad(): void;
+  componentDidRender(): Promise<void>;
+  private recalculatePagination;
+  private isActivePageClass;
+  private prepareLinkUrl;
+  private resetSelectValue;
+  render(): any;
+  private onClickHandler;
+  private onSelectHandler;
+  /**
+   * Validate the WCAG attributes of the component
+   */
+  validateWcag(): Promise<void>;
+}

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

@@ -0,0 +1,5 @@
+import { GovBaseEvent } from "../../types/event.types";
+import { Pagination } from "./pagination";
+export interface PaginationEvent extends GovBaseEvent {
+  pagination: Pagination;
+}

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

@@ -0,0 +1,12 @@
+export interface Pagination {
+  totalItems: number;
+  currentPage: number;
+  pageSize: number;
+  totalPages: number;
+  startPage: number;
+  endPage: number;
+  startIndex: number;
+  endIndex: number;
+  pages: number[];
+}
+export declare function paginate(totalItems: number, currentPage?: number, pageSize?: number, maxPages?: number): Pagination;

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

@@ -0,0 +1,12 @@
+export declare const PromptClass: {
+  root: string;
+  dialog: string;
+  inner: string;
+  header: string;
+  icon: string;
+  title: string;
+  close: string;
+  content: string;
+  actions: string;
+  bodyFix: string;
+};

package/dist/types/components/gov-promp/gov-prompt.d.ts

@@ -0,0 +1,65 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { Nullable } from '../../types/interfaces';
+export declare class GovPrompt {
+  private h;
+  private readonly labelId;
+  private readonly contentId;
+  constructor();
+  host: HTMLGovPromptElement;
+  /**
+   * Attribute for modal window display
+   */
+  open: boolean;
+  /**
+   * Title of modal window
+   */
+  label: string;
+  /**
+   * Role of modal
+   */
+  role: Nullable<string>;
+  /**
+   * Used to change the HTML tag in the modal label for correct semantic structure
+   */
+  readonly labelTag: string;
+  /**
+   * String of id's that indicate alternative labels elements
+   */
+  wcagLabelledBy: string;
+  /**
+   * Indicates the id of a component that describes the modal.
+   */
+  wcagDescribedBy: string;
+  /**
+   * Adds accessible label for the modal close button that is only shown for screen readers.
+   */
+  readonly wcagCloseLabel: string;
+  /**
+   * A string of identifiers that indicate alternative label elements for closing the modal window
+   */
+  wcagCloseLabelledBy: string;
+  /**
+   * Emitted when modal window closes.
+   */
+  govClose: EventEmitter<PointerEvent>;
+  validateLabelTag(newValue: string): void;
+  watchOpen(newValue: boolean): void;
+  private showModal;
+  private hideModal;
+  componentWillRender(): Promise<void>;
+  componentDidRender(): Promise<void>;
+  render(): any;
+  private onCloseHandler;
+  /**
+   * Showing the modal
+   */
+  show(): Promise<void>;
+  /**
+   * Hiding the modal
+   */
+  hide(): Promise<void>;
+  /**
+   * Validate the WCAG attributes of the component
+   */
+  validateWcag(): Promise<void>;
+}

package/dist/types/components/gov-side-nav/constants.d.ts

@@ -0,0 +1,15 @@
+export declare const SideNavClass: {
+  root: string;
+  aside: string;
+};
+export declare const SideNavItemClass: {
+  root: string;
+  rootWithIcon: string;
+  header: string;
+  icon: string;
+  name: string;
+  label: string;
+  arrow: string;
+  chip: string;
+  content: string;
+};

package/dist/types/components/gov-side-nav/gov-side-nav-item.d.d.ts

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

package/dist/types/components/gov-side-nav/gov-side-nav-item.d.ts

@@ -0,0 +1,67 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { GovSideNavItemChangeEvent } from './gov-side-nav-item.d';
+export declare class GovSideNavItem {
+  private h;
+  constructor();
+  readonly host: HTMLGovSideNavItemElement;
+  isExpandedState: boolean;
+  /**
+   * Determide if component should have inversed colors to be used on dark background
+   */
+  readonly inverse: boolean;
+  /**
+   * Determide if component should have compact styles.
+   */
+  readonly compact: boolean;
+  /**
+   * Custom sidenav item identifier. Otherwise, it will be generated
+   */
+  readonly identifier: string;
+  /**
+   * Defined the count of nested items
+   */
+  readonly count: boolean;
+  /**
+   * Item name of the sidenav
+   */
+  readonly label: 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
+   * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-href
+   */
+  readonly href: string;
+  /**
+   * Defines whether the sidenav is open or closed by button
+   */
+  readonly isExpanded: boolean;
+  /**
+   * Called when the sidenav state changes
+   */
+  govChange: EventEmitter<GovSideNavItemChangeEvent>;
+  validateLabel(newValue: string): void;
+  private emmitChange;
+  componentWillLoad(): void;
+  get classNames(): string;
+  render(): any;
+  /**
+   * Opening the sidenav
+   */
+  open(): Promise<void>;
+  /**
+   * Closing the sidenav
+   */
+  close(): Promise<void>;
+  /**
+   * sidenav switch
+   */
+  toggle(): Promise<void>;
+  /**
+   * Returns the current state of the component
+   */
+  currentState(): Promise<boolean>;
+}

package/dist/types/components/gov-side-nav/gov-side-nav.d.ts

@@ -0,0 +1,32 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { GovSideNavItemChangeEvent } from './gov-side-nav-item.d';
+export declare class GovSideNav {
+  readonly host: HTMLGovSideNavElement;
+  /**
+   * Determide if component should have inversed colors to be used on dark background.
+   */
+  readonly inverse: boolean;
+  /**
+   * Determide if component should have compact styles.
+   */
+  readonly compact: boolean;
+  /**
+   * Adds accessible label for the sidenav that is only shown for screen readers.
+   */
+  readonly wcagLabel: string;
+  /**
+   * String of id's that indicate alternative labels elements
+   */
+  readonly wcagLabelledBy: string;
+  /**
+   * Called when the sidenav state changes
+   */
+  govChange: EventEmitter<GovSideNavItemChangeEvent>;
+  componentDidLoad(): void;
+  componentDidRender(): Promise<void>;
+  render(): any;
+  /**
+   * Validate the WCAG attributes of the component
+   */
+  validateWcag(): Promise<void>;
+}

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

@@ -0,0 +1,15 @@
+import { Sizes } from '../../core/constants/sizes';
+import { ValueOf } from '../../types/interfaces';
+export declare const SpacerSize: Pick<typeof Sizes, "_XS" | "_S" | "_M" | "_L" | "_2XS" | "_XL" | "_2XL" | "_3XL" | "_4XL">;
+export type SpacerSizeType = `${ValueOf<typeof SpacerSize>}`;
+export declare enum SpacerBreakpoints {
+  NONE = "none",
+  SM = "sm",
+  MD = "md",
+  LG = "lg",
+  XL = "xl"
+}
+export type SpacerBreakpointsType = `${ValueOf<typeof SpacerBreakpoints>}`;
+export declare const SpacerClass: {
+  root: string;
+};

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

@@ -0,0 +1,18 @@
+import { SpacerBreakpointsType, SpacerSizeType } from './constants';
+export declare class GovSpacer {
+  private h;
+  constructor();
+  host: HTMLGovSpacerElement;
+  /**
+   * Spacer’s size
+   */
+  readonly size?: SpacerSizeType;
+  /**
+   * Breakpoint
+   */
+  readonly breakpoint?: SpacerBreakpointsType;
+  validateSize(newValue: string): void;
+  validateBreakpoint(newValue: string): void;
+  componentWillLoad(): void;
+  render(): any;
+}

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

@@ -0,0 +1,18 @@
+import { ValueOf } from '../../types/interfaces';
+import { Variants } from '../../core/constants/variants';
+export declare enum StatsBarIconPosition {
+  LEFT = "left"
+}
+export type StatsBarIconPositionType = `${ValueOf<typeof StatsBarIconPosition>}`;
+export declare const StatsBarVariants: Pick<typeof Variants, "PRIMARY" | "SECONDARY">;
+export type StatsBarVariantType = `${ValueOf<typeof StatsBarVariants>}`;
+export declare const StatsBarClass: {
+  root: string;
+  section: string;
+};
+export declare const StatsBarItemClass: {
+  root: string;
+  icon: string;
+  number: string;
+  text: string;
+};

package/dist/types/components/gov-statsbar/gov-statsbar-item.d.ts

@@ -0,0 +1,14 @@
+import { GovHost } from '../../helpers/Dom/template.types';
+import { StatsBarIconPositionType } from './constants';
+export declare class GovStatsbarItem {
+  h: GovHost;
+  constructor();
+  host: HTMLGovStatsbarItemElement;
+  /**
+   * Icon’s position
+   */
+  readonly iconPosition?: StatsBarIconPositionType;
+  validateIconPosition(newValue: string): void;
+  componentWillLoad(): void;
+  render(): any;
+}

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

@@ -0,0 +1,19 @@
+import { StatsBarIconPositionType, StatsBarVariantType } from "./constants";
+export declare class GovStatsbar {
+  private h;
+  constructor();
+  host: HTMLGovStatsbarElement;
+  /**
+   * Icon’s position
+   */
+  readonly iconPosition?: StatsBarIconPositionType;
+  /**
+   * Style variation
+   */
+  readonly variant?: StatsBarVariantType;
+  validateIconPosition(newValue: string): void;
+  validateVariant(newValue: string): void;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  render(): any;
+}

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

@@ -0,0 +1,22 @@
+import { Variants } from '../../core/constants/variants';
+import { Sizes } from '../../core/constants/sizes';
+import { ValueOf } from '../../types/interfaces';
+export declare const StepperVariants: Pick<typeof Variants, "PRIMARY" | "SECONDARY" | "SUCCESS" | "ERROR" | "WARNING">;
+export type StepperVariantType = `${ValueOf<typeof StepperVariants>}`;
+export declare const StepperSizes: Pick<typeof Sizes, "_XS" | "_S" | "_M">;
+export type StepperSizesType = `${ValueOf<typeof StepperSizes>}`;
+export declare const StepperClass: {
+  root: string;
+};
+export declare const StepperItemClass: {
+  root: string;
+  rootWithAnnot: string;
+  header: string;
+  title: string;
+  label: string;
+  name: string;
+  annot: string;
+  prefix: string;
+  content: string;
+  suffix: string;
+};

package/dist/types/components/gov-stepper/gov-stepper-item.d.d.ts

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

package/dist/types/components/gov-stepper/gov-stepper-item.d.ts

@@ -0,0 +1,48 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { StepperSizesType, StepperVariantType } from './constants';
+import { GovStepperItemChangeEvent } from './gov-stepper-item.d';
+export declare class GovStepperItem {
+  private h;
+  private readonly triggerId;
+  private readonly contentId;
+  constructor();
+  readonly host: HTMLGovStepperItemElement;
+  isExpandedState: boolean;
+  /**
+   * Style variation of the button.
+   */
+  readonly variant?: StepperVariantType;
+  /**
+   * Size of stepper
+   */
+  readonly size?: StepperSizesType;
+  /**
+   * Custom stepper item identifier. Otherwise, it will be generated
+   */
+  readonly identifier: string;
+  /**
+   * Item name of the stepper
+   */
+  readonly label: string;
+  /**
+   * Item annotation of the stepper
+   */
+  readonly annotation: string;
+  /**
+   * Used to change the HMTL tag in the stepper trigger for correct semantic structure
+   */
+  readonly triggerTag: string;
+  /**
+   * Called when the accordion state changes
+   */
+  govChange: EventEmitter<GovStepperItemChangeEvent>;
+  validateLabel(newValue: string): void;
+  validateTriggerTag(newValue: string): void;
+  validateVariant(newValue: string): void;
+  componentWillLoad(): void;
+  render(): any;
+  /**
+   * Returns the current state of the component
+   */
+  currentState(): Promise<boolean>;
+}

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

@@ -0,0 +1,20 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { StepperSizesType } from './constants';
+import { GovStepperItemChangeEvent } from './gov-stepper-item.d';
+export declare class GovStepper {
+  private h;
+  constructor();
+  readonly host: HTMLGovStepperElement;
+  /**
+   * Size of stepper
+   */
+  readonly size?: StepperSizesType;
+  /**
+   * Called when the Stepper state changes
+   */
+  govChange: EventEmitter<GovStepperItemChangeEvent>;
+  validateSize(newValue: string): void;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  render(): any;
+}