@openreachtech/furo-vue 1.3.1

package/types/generated/components/organisms/FuroSidebar/FuroSidebarContext.d.ts

@@ -0,0 +1,596 @@
+/**
+ * Context class for FuroSidebar organism.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroSidebarContext extends BaseFuroContext<null, Props, "NAVIGATE" | "UPDATE_ACTIVE_KEY" | "EXPAND_CHANGE" | "UPDATE_EXPANDED_KEYS" | "SEARCH_CHANGE" | "SEARCH_COMMIT" | "UPDATE_SEARCH_VALUE"> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroSidebarContext ? X : never} T, X
+     * @override
+     * @param {FuroSidebarContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroSidebarContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroSidebarContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     * @returns {FuroSidebarContextParams['refHash']} Ref hash.
+     */
+    static override buildRefHash(): FuroSidebarContextParams["refHash"];
+    /**
+     * Icon marking an open disclosure.
+     *
+     * @returns {string} Name of a built-in icon.
+     */
+    static get OPEN_DISCLOSURE_ICON_NAME(): string;
+    /**
+     * Icon marking a closed disclosure.
+     *
+     * @returns {string} Name of a built-in icon.
+     */
+    static get CLOSED_DISCLOSURE_ICON_NAME(): string;
+    /**
+     * Get emit event name.
+     *
+     * @override
+     * @returns {Readonly<{
+     *   NAVIGATE: 'navigate'
+     *   UPDATE_ACTIVE_KEY: 'update:activeKey'
+     *   EXPAND_CHANGE: 'expand-change'
+     *   UPDATE_EXPANDED_KEYS: 'update:expandedKeys'
+     *   SEARCH_CHANGE: 'search-change'
+     *   SEARCH_COMMIT: 'search-commit'
+     *   UPDATE_SEARCH_VALUE: 'update:searchValue'
+     * }>} Emit event names.
+     */
+    static override get EMIT_EVENT_NAME(): Readonly<{
+        NAVIGATE: "navigate";
+        UPDATE_ACTIVE_KEY: "update:activeKey";
+        EXPAND_CHANGE: "expand-change";
+        UPDATE_EXPANDED_KEYS: "update:expandedKeys";
+        SEARCH_CHANGE: "search-change";
+        SEARCH_COMMIT: "search-commit";
+        UPDATE_SEARCH_VALUE: "update:searchValue";
+    }>;
+    /**
+     * Get emit options.
+     *
+     * @returns {{
+     *   'navigate': (payload: NavigatePayload) => boolean
+     *   'update:activeKey': (key: string) => boolean
+     *   'expand-change': (payload: ExpandChangePayload) => boolean
+     *   'update:expandedKeys': (keys: Array<string>) => boolean
+     *   'search-change': (payload: SidebarSearchPayload) => boolean
+     *   'search-commit': (payload: SidebarSearchPayload) => boolean
+     *   'update:searchValue': (value: string | null) => boolean
+     * }} Emit event hash.
+     */
+    static get EMIT_EVENT_HASH(): {
+        "navigate": (payload: NavigatePayload) => boolean;
+        "update:activeKey": (key: string) => boolean;
+        "expand-change": (payload: ExpandChangePayload) => boolean;
+        "update:expandedKeys": (keys: Array<string>) => boolean;
+        "search-change": (payload: SidebarSearchPayload) => boolean;
+        "search-commit": (payload: SidebarSearchPayload) => boolean;
+        "update:searchValue": (value: string | null) => boolean;
+    };
+    /**
+     * Constructor.
+     *
+     * @param {FuroSidebarContextParams} params - Parameters of this constructor.
+     */
+    constructor({ props, componentContext, refHash, }: FuroSidebarContextParams);
+    refHash: {
+        activeKeyRef: import("vue").Ref<string | null>;
+        expandedKeysRef: import("vue").Ref<Array<string>>;
+    };
+    /**
+     * get: Constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroSidebarContext} Constructor of this class.
+     */
+    override get Ctor(): typeof FuroSidebarContext;
+    /**
+     * get: the internally held active key, used while uncontrolled.
+     *
+     * @returns {import('vue').Ref<string | null>} Ref of the active key.
+     */
+    get activeKeyRef(): import("vue").Ref<string | null>;
+    /**
+     * get: the internally held open disclosures, used while uncontrolled.
+     *
+     * @returns {import('vue').Ref<Array<string>>} Ref of the open keys.
+     */
+    get expandedKeysRef(): import("vue").Ref<Array<string>>;
+    /**
+     * Normalized groups for rendering.
+     *
+     * @returns {Array<GroupEntry>} Group entries.
+     */
+    get groupEntries(): Array<GroupEntry>;
+    /**
+     * Whether the rail is drawn as the narrow icon-only form.
+     *
+     * @returns {boolean} Whether the rail is collapsed.
+     */
+    isCollapsed(): boolean;
+    /**
+     * Whether the active key arrives from the parcel rather than from within.
+     *
+     * @returns {boolean} Whether the active key is controlled.
+     */
+    isControlledActiveKey(): boolean;
+    /**
+     * Whether the open disclosures arrive from the parcel rather than from within.
+     *
+     * @returns {boolean} Whether the open disclosures are controlled.
+     */
+    isControlledExpandedKeys(): boolean;
+    /**
+     * Whether a given key is the one the application currently shows.
+     *
+     * @param {{
+     *   key: string
+     * }} params - Parameters.
+     * @returns {boolean} Whether the key is active.
+     */
+    isActiveEntry({ key, }: {
+        key: string;
+    }): boolean;
+    /**
+     * Whether a given key has its sub-items revealed.
+     *
+     * @param {{
+     *   key: string
+     * }} params - Parameters.
+     * @returns {boolean} Whether the disclosure is open.
+     */
+    isExpandedEntry({ key, }: {
+        key: string;
+    }): boolean;
+    /**
+     * Whether the header region renders.
+     *
+     * @returns {boolean} Whether the header slot was filled.
+     */
+    hasHeaderSlot(): boolean;
+    /**
+     * Whether the footer region renders.
+     *
+     * @returns {boolean} Whether the footer slot was filled.
+     */
+    hasFooterSlot(): boolean;
+    /**
+     * Whether the search entry renders.
+     *
+     * A collapsed rail is one icon box wide, which no text control fits in, so the
+     * entry is dropped there rather than squeezed.
+     *
+     * @returns {boolean} Whether the search entry renders.
+     */
+    shouldShowSearch(): boolean;
+    /**
+     * Whether a group draws its heading.
+     *
+     * @param {{
+     *   group: GroupEntry
+     * }} params - Parameters.
+     * @returns {boolean} Whether the heading renders.
+     */
+    shouldShowGroupLabel({ group, }: {
+        group: GroupEntry;
+    }): boolean;
+    /**
+     * Whether item labels render.
+     *
+     * @returns {boolean} Whether labels render.
+     */
+    shouldShowLabel(): boolean;
+    /**
+     * Whether an item draws its disclosure caret.
+     *
+     * @param {{
+     *   entry: ItemEntry
+     * }} params - Parameters.
+     * @returns {boolean} Whether the caret renders.
+     */
+    shouldShowDisclosureIcon({ entry, }: {
+        entry: ItemEntry;
+    }): boolean;
+    /**
+     * Whether an item reveals its sub-items.
+     *
+     * @param {{
+     *   entry: ItemEntry
+     * }} params - Parameters.
+     * @returns {boolean} Whether the sub-items render.
+     */
+    shouldShowSubItems({ entry, }: {
+        entry: ItemEntry;
+    }): boolean;
+    /**
+     * Resolve the key the application currently shows.
+     *
+     * @returns {string | null} The active key.
+     */
+    extractActiveKey(): string | null;
+    /**
+     * Resolve the keys whose sub-items are revealed.
+     *
+     * @returns {Array<string>} The open keys.
+     */
+    extractExpandedKeys(): Array<string>;
+    /**
+     * Resolve the caret an item draws.
+     *
+     * @param {{
+     *   entry: ItemEntry
+     * }} params - Parameters.
+     * @returns {string} Name of a built-in icon.
+     */
+    extractDisclosureIconName({ entry, }: {
+        entry: ItemEntry;
+    }): string;
+    /**
+     * Resolve the name a collapsed item is announced and titled with.
+     *
+     * An expanded rail shows the label as text, so repeating it as an attribute
+     * would have a screen reader read it twice.
+     *
+     * @param {{
+     *   entry: ItemEntry
+     * }} params - Parameters.
+     * @returns {string | null} The label, or null while the rail is expanded.
+     */
+    extractCollapsedItemLabel({ entry, }: {
+        entry: ItemEntry;
+    }): string | null;
+    /**
+     * Resolve the aria-current value of an item.
+     *
+     * @param {{
+     *   entry: ItemEntry | SubItemEntry
+     * }} params - Parameters.
+     * @returns {'page' | null} The aria-current value.
+     */
+    extractCurrentValue({ entry, }: {
+        entry: ItemEntry | SubItemEntry;
+    }): "page" | null;
+    /**
+     * Resolve the aria-expanded value of an item.
+     *
+     * @param {{
+     *   entry: ItemEntry
+     * }} params - Parameters.
+     * @returns {'true' | 'false' | null} The aria-expanded value, null when the item discloses nothing.
+     */
+    extractDisclosureExpandedValue({ entry, }: {
+        entry: ItemEntry;
+    }): "true" | "false" | null;
+    /**
+     * Resolve the accessible name of the navigation landmark.
+     *
+     * @returns {string} Name of the landmark.
+     */
+    extractNavigationLabel(): string;
+    /**
+     * Resolve the placeholder of the search control.
+     *
+     * @returns {string | null} Placeholder of the search control.
+     */
+    extractSearchPlaceholder(): string | null;
+    /**
+     * Resolve the accessible name of the search control.
+     *
+     * @returns {string} Name of the search control.
+     */
+    extractSearchLabel(): string;
+    /**
+     * Resolve the text the search control holds.
+     *
+     * @returns {string | null} The search text.
+     */
+    extractSearchValue(): string | null;
+    /**
+     * Extract attributes handed to the search control.
+     *
+     * @returns {{
+     *   placeholder: string | null
+     *   'aria-label': string
+     * }} Attributes of the search control.
+     */
+    extractSearchAttributes(): {
+        placeholder: string | null;
+        "aria-label": string;
+    };
+    /**
+     * Extract CSS class map for the root.
+     *
+     * @returns {Record<string, boolean>} Class map of the root.
+     */
+    extractRootClassNames(): Record<string, boolean>;
+    /**
+     * Extract CSS class map for a primary item.
+     *
+     * @param {{
+     *   entry: ItemEntry
+     * }} params - Parameters.
+     * @returns {Record<string, boolean>} Class map of the item.
+     */
+    extractItemClassNames({ entry, }: {
+        entry: ItemEntry;
+    }): Record<string, boolean>;
+    /**
+     * Extract CSS class map for a nested sub-item.
+     *
+     * @param {{
+     *   entry: SubItemEntry
+     * }} params - Parameters.
+     * @returns {Record<string, boolean>} Class map of the sub-item.
+     */
+    extractSubItemClassNames({ entry, }: {
+        entry: SubItemEntry;
+    }): Record<string, boolean>;
+    /**
+     * Build the entries of one group.
+     *
+     * @param {{
+     *   items: Array<FuroSidebarItem>
+     * }} params - Parameters.
+     * @returns {Array<ItemEntry>} Item entries.
+     */
+    buildItemEntries({ items, }: {
+        items: Array<FuroSidebarItem>;
+    }): Array<ItemEntry>;
+    /**
+     * Build the entries nested under one item.
+     *
+     * @param {{
+     *   items: Array<FuroSidebarSubItem>
+     * }} params - Parameters.
+     * @returns {Array<SubItemEntry>} Sub-item entries.
+     */
+    buildSubItemEntries({ items, }: {
+        items: Array<FuroSidebarSubItem>;
+    }): Array<SubItemEntry>;
+    /**
+     * Build attributes of the root host element.
+     *
+     * @param {{
+     *   attrs: Record<string, *>
+     * }} params - Parameters.
+     * @returns {Record<string, *>} Attributes of the root.
+     */
+    buildRootAttributes({ attrs, }: {
+        attrs: Record<string, any>;
+    }): Record<string, any>;
+    /**
+     * Build attributes of a primary item.
+     *
+     * @param {{
+     *   entry: ItemEntry
+     * }} params - Parameters.
+     * @returns {{
+     *   disabled: boolean
+     *   title: string | null
+     *   'aria-label': string | null
+     *   'aria-current': 'page' | null
+     *   'aria-expanded': 'true' | 'false' | null
+     * }} Attributes of the item.
+     */
+    buildItemAttributes({ entry, }: {
+        entry: ItemEntry;
+    }): {
+        disabled: boolean;
+        title: string | null;
+        "aria-label": string | null;
+        "aria-current": "page" | null;
+        "aria-expanded": "true" | "false" | null;
+    };
+    /**
+     * Build attributes of a nested sub-item.
+     *
+     * @param {{
+     *   entry: SubItemEntry
+     * }} params - Parameters.
+     * @returns {{
+     *   disabled: boolean
+     *   'aria-current': 'page' | null
+     * }} Attributes of the sub-item.
+     */
+    buildSubItemAttributes({ entry, }: {
+        entry: SubItemEntry;
+    }): {
+        disabled: boolean;
+        "aria-current": "page" | null;
+    };
+    /**
+     * Build the parcel handed to the search control.
+     *
+     * @returns {{
+     *   value: string | null
+     * }} Parcel of the search control.
+     */
+    buildSearchParcel(): {
+        value: string | null;
+    };
+    /**
+     * Build the open keys a disclosure toggle results in.
+     *
+     * @param {{
+     *   key: string
+     * }} params - Parameters.
+     * @returns {Array<string>} The next open keys.
+     */
+    buildNextExpandedKeys({ key, }: {
+        key: string;
+    }): Array<string>;
+    /**
+     * Handle a click on a primary item.
+     *
+     * An item that discloses sub-items opens and closes them; the design gives it
+     * a caret rather than a destination, so it never reports navigation.
+     *
+     * @param {{
+     *   entry: ItemEntry
+     * }} params - Parameters.
+     */
+    onActivateEntry({ entry, }: {
+        entry: ItemEntry;
+    }): void;
+    /**
+     * Handle a click on a nested sub-item.
+     *
+     * @param {{
+     *   entry: SubItemEntry
+     *   parentEntry: ItemEntry
+     * }} params - Parameters.
+     */
+    onActivateSubEntry({ entry, parentEntry, }: {
+        entry: SubItemEntry;
+        parentEntry: ItemEntry;
+    }): void;
+    /**
+     * Handle a keystroke reported by the search control.
+     *
+     * @param {{
+     *   payload: SidebarSearchPayload
+     * }} params - Parameters.
+     */
+    onSearchChange({ payload, }: {
+        payload: SidebarSearchPayload;
+    }): void;
+    /**
+     * Handle a settled value reported by the search control.
+     *
+     * @param {{
+     *   payload: SidebarSearchPayload
+     * }} params - Parameters.
+     */
+    onSearchCommit({ payload, }: {
+        payload: SidebarSearchPayload;
+    }): void;
+    /**
+     * Report that a key is the one the application should show.
+     *
+     * @param {{
+     *   key: string
+     *   parentKey: string | null
+     * }} params - Parameters.
+     */
+    selectKey({ key, parentKey, }: {
+        key: string;
+        parentKey: string | null;
+    }): void;
+    /**
+     * Open or close the sub-items of one item.
+     *
+     * @param {{
+     *   entry: ItemEntry
+     * }} params - Parameters.
+     */
+    toggleDisclosure({ entry, }: {
+        entry: ItemEntry;
+    }): void;
+}
+export type FuroSidebarContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams & {
+    props: Props;
+    componentContext: ComponentContext;
+    refHash: {
+        activeKeyRef: import("vue").Ref<string | null>;
+        expandedKeysRef: import("vue").Ref<Array<string>>;
+    };
+};
+export type FuroSidebarContextFactoryParams = Omit<FuroSidebarContextParams, "refHash"> & {
+    refHash?: FuroSidebarContextParams["refHash"];
+};
+export type EmitEventName = keyof typeof FuroSidebarContext.EMIT_EVENT_NAME;
+export type Props = import("vue").HTMLAttributes & {
+    parcel?: FuroSidebarParcel | null;
+};
+/**
+ * Closed-set Furo behavior for `<FuroSidebar>`.
+ * JSON-serializable only.
+ */
+export type FuroSidebarParcel = {
+    groups?: Array<FuroSidebarGroup>;
+    activeKey?: string | null;
+    expandedKeys?: Array<string> | null;
+    collapsed?: boolean;
+    searchable?: boolean;
+    searchValue?: string | null;
+    searchPlaceholder?: string | null;
+    searchLabel?: string;
+    label?: string;
+};
+export type FuroSidebarGroup = {
+    key: string;
+    label?: string | null;
+    items?: Array<FuroSidebarItem>;
+};
+export type FuroSidebarItem = {
+    key: string;
+    label: string;
+    icon?: string | null;
+    disabled?: boolean;
+    items?: Array<FuroSidebarSubItem>;
+};
+export type FuroSidebarSubItem = {
+    key: string;
+    label: string;
+    disabled?: boolean;
+};
+export type GroupEntry = {
+    key: string;
+    label: string | null;
+    items: Array<ItemEntry>;
+};
+export type ItemEntry = {
+    key: string;
+    label: string;
+    icon: string | null;
+    hasIcon: boolean;
+    disabled: boolean;
+    subItems: Array<SubItemEntry>;
+    hasSubItems: boolean;
+};
+export type SubItemEntry = {
+    key: string;
+    label: string;
+    disabled: boolean;
+};
+export type NavigatePayload = {
+    key: string;
+    parentKey: string | null;
+};
+export type ExpandChangePayload = {
+    key: string;
+    expanded: boolean;
+};
+export type SidebarSearchPayload = import("../../atoms/FuroTextField/TextFieldEmitPayload.js").default;
+export type ComponentContext = import("vue").SetupContext<typeof FuroSidebarContext.EMIT_EVENT_HASH, FuroSidebarSlots>;
+export type FuroSidebarSlots = import("vue").SlotsType<{
+    header: {};
+    footer: {};
+    search: {};
+    item: {
+        entry: ItemEntry;
+        active: boolean;
+        expanded: boolean;
+        collapsed: boolean;
+    };
+    "sub-item": {
+        entry: SubItemEntry;
+        parent: ItemEntry;
+        active: boolean;
+    };
+}>;
+export type FuroSidebarSetup = (props: Props, componentContext: ComponentContext) => {
+    context: FuroSidebarContext;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';