@abgov/web-components 1.37.1-alpha.2 → 1.37.1-alpha.4

package/common/breakpoints.d.ts

@@ -0,0 +1,2 @@
+export declare const MOBILE_BP = 624;
+export declare const TABLET_BP = 1024;

package/common/context-store.d.ts

@@ -0,0 +1,10 @@
+export interface Message {
+    [key: string]: unknown;
+    type: string;
+}
+export interface ContextStore {
+    subscribe: (cb: (msg: Message) => void) => void;
+    notify: (msg: Message) => void;
+}
+export declare function getContext(name: string): ContextStore;
+export declare function deleteContext(name: string): void;

package/common/no-scroll.d.ts

@@ -0,0 +1,8 @@
+type NoScrollOptions = {
+    enable: boolean;
+};
+export default function (_node: HTMLElement, opts: NoScrollOptions): {
+    update(options: NoScrollOptions): void;
+    destroy(): void;
+};
+export {};

package/common/styling.d.ts

@@ -0,0 +1,18 @@
+type NumericSpacing = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10";
+type TShirtSpacing = "none" | "3xs" | "2xs" | "xs" | "s" | "m" | "l" | "xl" | "2xl" | "3xl" | "4xl";
+export type Spacing = NumericSpacing | TShirtSpacing | null;
+/**
+ * import type { Spacing } from "../../common/types";
+ * import { calculateMargin } from "../../common/types";
+ *
+ * export let mt: Spacing = null;
+ * export let mr: Spacing = null;
+ * export let mb: Spacing = null;
+ * export let ml: Spacing = null;
+ *
+ * // add the following style attribute to the root element
+ * style={calculateMargin(mt, mr, mb, ml)}
+ */
+export declare function calculateMargin(mt: Spacing, mr: Spacing, mb: Spacing, ml: Spacing): string;
+export declare function injectCss(el: HTMLElement, rootSelector: string, css: Record<string, string | number>, media?: string): void;
+export {};

package/common/types.d.ts

@@ -0,0 +1,3 @@
+export type DrawerPosition = "bottom" | "left" | "right" | undefined;
+export type DrawerSizeUnit = "px" | "rem" | "ch" | "vh" | "vw";
+export type DrawerSize = `${number}${DrawerSizeUnit}` | undefined;

package/common/urls.d.ts

@@ -0,0 +1,2 @@
+export declare function isUrlMatch(windowUrl: URL | Location, testUrl: string): number;
+export declare function getMatchedLink(links: Element[], windowUrl: URL | Location): Element | null;

package/common/utils.d.ts

@@ -0,0 +1,41 @@
+export declare function styles(...css: (string | boolean)[]): string;
+export declare function style(name: string, value: string | number): string;
+export declare const msg: {
+    receive: typeof receive;
+    relay: typeof relay;
+};
+export declare function receive(el: HTMLElement | Element | null | undefined, handler: (action: string, data: unknown, event: Event) => void): () => void;
+export declare function relay<T>(el: HTMLElement | Element | null | undefined, eventName: string, data?: T, opts?: {
+    bubbles?: boolean;
+    cancelable?: boolean;
+    timeout?: number;
+}): void;
+export declare function dispatch<T>(el: HTMLElement | Element | null | undefined, eventName: string, detail?: T, opts?: {
+    bubbles?: boolean;
+    cancelable?: boolean;
+    timeout?: number;
+}): void;
+export declare function getSlottedChildren(rootEl?: HTMLElement, parentTestSelector?: string): Element[];
+export declare function toBoolean(value: string): boolean;
+export declare function fromBoolean(value: boolean): string;
+export declare function isValidDate(d: Date): boolean;
+export declare function validateRequired(componentName: string, props: Record<string, unknown>): void;
+export declare function typeValidator(message: string, values: string[], opts?: boolean | {
+    required?: boolean;
+    deprecated?: string[];
+}): [string[], (value: string | null) => void];
+export declare function getTimestamp(val?: Date): string;
+export declare function pluralize(word: string, count: number): string;
+export declare function clamp(value: number, min: number, max: number): number;
+export declare function generateRandomId(): string;
+export declare function padLeft(value: string | number, len: number, padWith: string | number): string;
+export declare function performOnce(timeoutId: any, action: () => void, delay?: number): any;
+export declare function ensureSlotExists(el: HTMLElement): void;
+export declare function getQueryParams(url: string | URL): Record<string, string>;
+export declare function getQueryParam(url: string | URL, key: string): string | undefined;
+/**
+ * Creates a temporary screen reader announcement using aria-live
+ * @param text The text to announce to screen readers
+ * @param duration How long to keep the announcer element in the DOM (in milliseconds)
+ */
+export declare function announceToScreenReader(text: string, duration?: number): void;

package/common/validators.d.ts

@@ -0,0 +1 @@
+export declare function isValidDimension(value: string): boolean;