@openreachtech/furo-vue 1.3.1

package/types/generated/components/organisms/FuroDrawer/FuroDrawerContext.d.ts

@@ -0,0 +1,347 @@
+/**
+ * Context class for FuroDrawer organism.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroDrawerContext extends BaseFuroContext<null, Props, "UPDATE_OPEN" | "OPEN_CHANGE" | "SNAP_CHANGE" | "UPDATE_ACTIVE_SNAP_POINT"> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroDrawerContext ? X : never} T, X
+     * @override
+     * @param {FuroDrawerContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroDrawerContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroDrawerContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     * @returns {FuroDrawerContextParams['refHash']}
+     */
+    static override buildRefHash(): FuroDrawerContextParams["refHash"];
+    /**
+     * Get emit event name.
+     *
+     * @override
+     * @returns {Readonly<{
+     *   OPEN_CHANGE: 'open:change'
+     *   UPDATE_OPEN: 'update:open'
+     *   SNAP_CHANGE: 'snap:change'
+     *   UPDATE_ACTIVE_SNAP_POINT: 'update:activeSnapPoint'
+     * }>}
+     */
+    static override get EMIT_EVENT_NAME(): Readonly<{
+        OPEN_CHANGE: "open:change";
+        UPDATE_OPEN: "update:open";
+        SNAP_CHANGE: "snap:change";
+        UPDATE_ACTIVE_SNAP_POINT: "update:activeSnapPoint";
+    }>;
+    /**
+     * Get emit options.
+     *
+     * @returns {{
+     *   'open:change': (payload: { open: boolean }) => void
+     *   'update:open': (open: boolean) => void
+     *   'snap:change': (payload: { snapPoint: number | string | null }) => void
+     *   'update:activeSnapPoint': (snapPoint: number | string | null) => void
+     * }}
+     */
+    static get EMIT_EVENT_HASH(): {
+        "open:change": (payload: {
+            open: boolean;
+        }) => void;
+        "update:open": (open: boolean) => void;
+        "snap:change": (payload: {
+            snapPoint: number | string | null;
+        }) => void;
+        "update:activeSnapPoint": (snapPoint: number | string | null) => void;
+    };
+    /**
+     * Constructor.
+     *
+     * @param {FuroDrawerContextParams} params - Parameters of this constructor.
+     */
+    constructor({ props, componentContext, refHash, }: FuroDrawerContextParams);
+    refHash: {
+        openRef: import("vue").Ref<boolean>;
+        snapPointRef: import("vue").Ref<number | string | null>;
+    };
+    /**
+     * get: Constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroDrawerContext}
+     */
+    override get Ctor(): typeof FuroDrawerContext;
+    /**
+     * Get internal open ref.
+     *
+     * @returns {import('vue').Ref<boolean>}
+     */
+    get openRef(): import("vue").Ref<boolean>;
+    /**
+     * Get internal active snap point ref.
+     *
+     * @returns {import('vue').Ref<number | string | null>}
+     */
+    get snapPointRef(): import("vue").Ref<number | string | null>;
+    /**
+     * Whether open state is controlled via parcel.
+     *
+     * @returns {boolean}
+     */
+    isOpenControlled(): boolean;
+    /**
+     * Whether the trigger is disabled.
+     *
+     * @returns {boolean}
+     */
+    isDisabled(): boolean;
+    /**
+     * Resolve the modality of the drawer (`true` | `'trap-focus'` | `false`).
+     *
+     * @returns {boolean | 'trap-focus'}
+     */
+    extractModal(): boolean | "trap-focus";
+    /**
+     * Resolve open state for the root host element.
+     *
+     * @returns {boolean}
+     */
+    extractOpenValue(): boolean;
+    /**
+     * Resolve the edge the drawer docks to and slides in from.
+     *
+     * @returns {FuroDrawerSide}
+     */
+    extractSide(): FuroDrawerSide;
+    /**
+     * Resolve the underlying swipe-to-dismiss direction from the docking side.
+     *
+     * @returns {'left' | 'right' | 'up' | 'down'}
+     */
+    extractSwipeDirection(): "left" | "right" | "up" | "down";
+    /**
+     * Resolve the content size variant.
+     *
+     * @returns {FuroDrawerSize}
+     */
+    extractSize(): FuroDrawerSize;
+    /**
+     * Resolve the preset snap positions.
+     *
+     * @returns {Array<number | string> | null}
+     */
+    extractSnapPoints(): Array<number | string> | null;
+    /**
+     * Whether snap points are configured.
+     *
+     * @returns {boolean}
+     */
+    hasSnapPoints(): boolean;
+    /**
+     * Whether snapping advances one sequential point at a time.
+     *
+     * @returns {boolean}
+     */
+    isSequentialSnap(): boolean;
+    /**
+     * Whether the active snap point is controlled via parcel.
+     *
+     * @returns {boolean}
+     */
+    isActiveSnapPointControlled(): boolean;
+    /**
+     * Resolve the active snap point for the root host element.
+     *
+     * @returns {number | string | null}
+     */
+    extractActiveSnapPointValue(): number | string | null;
+    /**
+     * Whether the panel may be swiped open from its closed state.
+     *
+     * @returns {boolean}
+     */
+    shouldEnableSwipeToOpen(): boolean;
+    /**
+     * Whether to render the drag handle.
+     *
+     * @returns {boolean}
+     */
+    shouldShowDragHandle(): boolean;
+    /**
+     * Whether the drawer is in a busy state (blocks dismissal during async work).
+     *
+     * @returns {boolean}
+     */
+    isBusy(): boolean;
+    /**
+     * Extract root class names.
+     *
+     * @returns {Record<string, boolean>}
+     */
+    extractRootClassNames(): Record<string, boolean>;
+    /**
+     * Extract content class names (side + size variant + busy state).
+     *
+     * @returns {Record<string, boolean>}
+     */
+    extractContentClassNames(): Record<string, boolean>;
+    /**
+     * CSS selector (scoped to drawer content) for the element to focus on open.
+     *
+     * @returns {string | null}
+     */
+    extractInitialFocusSelector(): string | null;
+    /**
+     * Title text rendered in the drawer heading.
+     *
+     * @returns {string | null}
+     */
+    extractTitle(): string | null;
+    /**
+     * Description text rendered below the heading.
+     *
+     * @returns {string | null}
+     */
+    extractDescription(): string | null;
+    /**
+     * Whether a description region should render (parcel text or `description` slot).
+     *
+     * @returns {boolean}
+     */
+    hasDescription(): boolean;
+    /**
+     * Accessible label for the built-in close button.
+     *
+     * @returns {string}
+     */
+    extractCloseText(): string;
+    /**
+     * Whether an outside click (overlay / outside interaction) dismisses the drawer.
+     *
+     * @returns {boolean}
+     */
+    shouldCloseOnOutsideClick(): boolean;
+    /**
+     * Whether the Escape key dismisses the drawer.
+     *
+     * @returns {boolean}
+     */
+    shouldCloseOnEscape(): boolean;
+    /**
+     * Handle outside interaction — veto dismissal when disabled.
+     *
+     * @param {{
+     *   rawEvent: Event
+     * }} params
+     */
+    onInteractOutside({ rawEvent, }: {
+        rawEvent: Event;
+    }): void;
+    /**
+     * Handle Escape key — veto dismissal when disabled.
+     *
+     * @param {{
+     *   rawEvent: Event
+     * }} params
+     */
+    onEscapeKeyDown({ rawEvent, }: {
+        rawEvent: Event;
+    }): void;
+    /**
+     * Handle the drawer's initial-focus moment — focus a custom element when configured.
+     *
+     * @param {{
+     *   rawEvent: Event
+     * }} params
+     */
+    onOpenAutoFocus({ rawEvent, }: {
+        rawEvent: Event;
+    }): void;
+    /**
+     * Request the drawer to close. Exposed to slots so action buttons can dismiss
+     * the drawer (works for both controlled and uncontrolled open state).
+     */
+    requestClose(): void;
+    /**
+     * Handle open state updates from the root host element.
+     *
+     * @param {{
+     *   isOpen: boolean
+     * }} params
+     */
+    onOpenChange({ isOpen, }: {
+        isOpen: boolean;
+    }): void;
+    /**
+     * Handle active snap point updates from the root host element.
+     *
+     * @param {{
+     *   snapPoint: number | string | null
+     * }} params
+     */
+    onSnapPointChange({ snapPoint, }: {
+        snapPoint: number | string | null;
+    }): void;
+}
+export type FuroDrawerContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams & {
+    props: Props;
+    componentContext: ComponentContext;
+    refHash: {
+        openRef: import("vue").Ref<boolean>;
+        snapPointRef: import("vue").Ref<number | string | null>;
+    };
+};
+export type FuroDrawerContextFactoryParams = Omit<FuroDrawerContextParams, "refHash"> & {
+    refHash?: FuroDrawerContextParams["refHash"];
+};
+export type EmitEventName = keyof typeof FuroDrawerContext.EMIT_EVENT_NAME;
+export type Props = import("vue").HTMLAttributes & {
+    parcel?: FuroDrawerParcel | null;
+};
+/**
+ * Closed-set Furo behavior for `<FuroDrawer>`.
+ * JSON-serializable only. Not an open passthrough to the internal drawer library.
+ */
+export type FuroDrawerParcel = {
+    open?: boolean | null;
+    disabled?: boolean;
+    modal?: boolean | "trap-focus";
+    title?: string | null;
+    description?: string | null;
+    closeText?: string;
+    closeOnOutsideClick?: boolean;
+    closeOnEscape?: boolean;
+    side?: FuroDrawerSide;
+    size?: FuroDrawerSize;
+    snapPoints?: Array<number | string> | null;
+    activeSnapPoint?: number | string | null;
+    sequentialSnap?: boolean;
+    swipeToOpen?: boolean;
+    dragHandle?: boolean;
+    busy?: boolean;
+    initialFocus?: string | null;
+};
+export type FuroDrawerSide = "left" | "right" | "top" | "bottom";
+export type FuroDrawerSize = "sm" | "default" | "lg" | "fullscreen";
+export type ComponentContext = import("vue").SetupContext<FuroDrawerEmitHash, FuroDrawerSlots>;
+export type FuroDrawerEmitHash = typeof FuroDrawerContext.EMIT_EVENT_HASH;
+export type FuroDrawerSlots = import("vue").SlotsType<{
+    trigger: {};
+    title: {};
+    description: {};
+    default: {
+        close: () => void;
+    };
+    footer: {
+        close: () => void;
+    };
+    close: {};
+}>;
+export type FuroDrawerSetup = (props: Props, componentContext: ComponentContext) => {
+    context: FuroDrawerContext;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';