@openreachtech/furo-vue 1.3.1

package/types/generated/components/molecules/FuroSplitter/FuroSplitter.vue.d.ts

@@ -0,0 +1,139 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import("vue").DefineComponent<{
+    parcel?: import("./FuroSplitterContext.js").FuroSplitterParcel | null;
+}, {
+    context: FuroSplitterContext;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    'change-value': (payload: import("./SplitterEmitPayload.js").default) => void;
+    'update:value': (layout: Array<number>) => void;
+}, string, import("vue").PublicProps, Readonly<{
+    parcel?: import("./FuroSplitterContext.js").FuroSplitterParcel | null;
+}> & Readonly<{
+    "onChange-value"?: (payload: import("./SplitterEmitPayload.js").default) => any;
+    "onUpdate:value"?: (layout: number[]) => any;
+}>, {
+    parcel: import("./FuroSplitterContext.js").FuroSplitterParcel;
+}, {}, {
+    SplitterGroup: {
+        new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").SplitterGroupProps> & Readonly<{
+            onLayout?: ((val: number[]) => any) | undefined;
+        }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+            layout: (val: number[]) => any;
+        }, import("vue").PublicProps, {}, false, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import("reka-ui").SplitterGroupProps> & Readonly<{
+            onLayout?: ((val: number[]) => any) | undefined;
+        }>, {}, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").SplitterGroupProps> & Readonly<{
+        onLayout?: ((val: number[]) => any) | undefined;
+    }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+        layout: (val: number[]) => any;
+    }, string, {}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+        $slots: {
+            default?: (props: {
+                layout: number[];
+            }) => any;
+        };
+    });
+    SplitterPanel: {
+        new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").SplitterPanelProps> & Readonly<{
+            onResize?: ((size: number, prevSize: number | undefined) => any) | undefined;
+            onCollapse?: (() => any) | undefined;
+            onExpand?: (() => any) | undefined;
+        }>, {
+            collapse: () => void;
+            expand: () => void;
+            getSize(): number;
+            resize: (size: number) => void;
+            isCollapsed: import("vue").ComputedRef<boolean>;
+            isExpanded: import("vue").ComputedRef<boolean>;
+        }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+            resize: (size: number, prevSize: number | undefined) => any;
+            collapse: () => any;
+            expand: () => any;
+        }, import("vue").PublicProps, {}, false, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import("reka-ui").SplitterPanelProps> & Readonly<{
+            onResize?: ((size: number, prevSize: number | undefined) => any) | undefined;
+            onCollapse?: (() => any) | undefined;
+            onExpand?: (() => any) | undefined;
+        }>, {
+            collapse: () => void;
+            expand: () => void;
+            getSize(): number;
+            resize: (size: number) => void;
+            isCollapsed: import("vue").ComputedRef<boolean>;
+            isExpanded: import("vue").ComputedRef<boolean>;
+        }, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").SplitterPanelProps> & Readonly<{
+        onResize?: ((size: number, prevSize: number | undefined) => any) | undefined;
+        onCollapse?: (() => any) | undefined;
+        onExpand?: (() => any) | undefined;
+    }>, {
+        collapse: () => void;
+        expand: () => void;
+        getSize(): number;
+        resize: (size: number) => void;
+        isCollapsed: import("vue").ComputedRef<boolean>;
+        isExpanded: import("vue").ComputedRef<boolean>;
+    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+        resize: (size: number, prevSize: number | undefined) => any;
+        collapse: () => any;
+        expand: () => any;
+    }, string, {}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+        $slots: {
+            default?: (props: {
+                isCollapsed: boolean;
+                isExpanded: boolean;
+                collapse: () => void;
+                expand: () => void;
+                resize: (size: number) => void;
+            }) => any;
+        };
+    });
+    SplitterResizeHandle: {
+        new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").SplitterResizeHandleProps> & Readonly<{
+            onDragging?: ((isDragging: boolean) => any) | undefined;
+        }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+            dragging: (isDragging: boolean) => any;
+        }, import("vue").PublicProps, {}, false, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import("reka-ui").SplitterResizeHandleProps> & Readonly<{
+            onDragging?: ((isDragging: boolean) => any) | undefined;
+        }>, {}, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").SplitterResizeHandleProps> & Readonly<{
+        onDragging?: ((isDragging: boolean) => any) | undefined;
+    }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+        dragging: (isDragging: boolean) => any;
+    }, string, {}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+        $slots: {
+            default?: (props: {}) => any;
+        };
+    });
+}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+import FuroSplitterContext from './FuroSplitterContext.js';

package/types/generated/components/molecules/FuroSplitter/FuroSplitterContext.d.ts

@@ -0,0 +1,226 @@
+/**
+ * Context class for managing FuroSplitter component.
+ *
+ * Presentational container that renders resizable panes from a declarative
+ * `panels` array. It owns no inbound value — the layout is driven by the
+ * underlying primitive and surfaced outward via `change-value` / `update:value`.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroSplitterContext extends BaseFuroContext<null, Props, "CHANGE_VALUE" | "UPDATE_VALUE"> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroSplitterContext ? X : never} T, X
+     * @override
+     * @param {FuroSplitterContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroSplitterContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroSplitterContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     */
+    static override buildRefHash(): {
+        internalLayoutRef: import("vue").Ref<any[], any[]>;
+        groupRootElementRef: import("vue").Ref<any, any>;
+    };
+    /**
+     * Get emit event name.
+     *
+     * @override
+     * @returns {Readonly<{
+     *   CHANGE_VALUE: 'change-value'
+     *   UPDATE_VALUE: 'update:value'
+     * }>}
+     */
+    static override get EMIT_EVENT_NAME(): Readonly<{
+        CHANGE_VALUE: "change-value";
+        UPDATE_VALUE: "update:value";
+    }>;
+    /**
+     * Get emit options.
+     *
+     * @returns {{
+     *   'change-value': (payload: import('./SplitterEmitPayload.js').default) => void
+     *   'update:value': (layout: Array<number>) => void
+     * }}
+     */
+    static get EMIT_EVENT_HASH(): {
+        "change-value": (payload: import("./SplitterEmitPayload.js").default) => void;
+        "update:value": (layout: Array<number>) => void;
+    };
+    /**
+     * get: Constructor of `EmitPayload`.
+     *
+     * @returns {typeof SplitterEmitPayload}
+     */
+    static get EmitPayloadCtor(): typeof SplitterEmitPayload;
+    /**
+     * Constructor.
+     *
+     * @param {FuroSplitterContextParams} params
+     */
+    constructor({ props, componentContext, refHash, }: FuroSplitterContextParams);
+    refHash: {
+        internalLayoutRef: import("vue").Ref<Array<number>>;
+        groupRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+    /**
+     * get: Constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroSplitterContext}
+     */
+    override get Ctor(): typeof FuroSplitterContext;
+    /**
+     * Get internal layout ref (latest pane sizes).
+     *
+     * @returns {import('vue').Ref<Array<number>>}
+     */
+    get internalLayoutRef(): import("vue").Ref<Array<number>>;
+    /**
+     * Get group root element ref.
+     *
+     * @returns {import('vue').Ref<HTMLElement | null>}
+     */
+    get groupRootElementRef(): import("vue").Ref<HTMLElement | null>;
+    /**
+     * Get the pane descriptors.
+     *
+     * @returns {Array<FuroSplitterPanel>}
+     */
+    get panels(): Array<FuroSplitterPanel>;
+    /**
+     * Resolve the layout orientation.
+     *
+     * @returns {FuroSplitterOrientation}
+     */
+    resolveOrientation(): FuroSplitterOrientation;
+    /**
+     * Resolve the visual appearance.
+     *
+     * `default` shows a divider line between panes; `plain` hides it so panes
+     * read as separated cards (the grip appears on hover / focus only).
+     *
+     * @returns {FuroSplitterAppearance}
+     */
+    resolveAppearance(): FuroSplitterAppearance;
+    /**
+     * Resolve a stable key for a single pane.
+     *
+     * @param {{
+     *   panel: FuroSplitterPanel
+     *   index: number
+     * }} params - Parameters.
+     * @returns {string}
+     */
+    resolvePanelKey({ panel, index, }: {
+        panel: FuroSplitterPanel;
+        index: number;
+    }): string;
+    /**
+     * Whether the pane at the given index is the last one.
+     *
+     * @param {{
+     *   index: number
+     * }} params - Parameters.
+     * @returns {boolean}
+     */
+    isLastPanel({ index, }: {
+        index: number;
+    }): boolean;
+    /**
+     * Extract CSS class map for the group root.
+     *
+     * @returns {Record<string, boolean>}
+     */
+    extractRootClassNames(): Record<string, boolean>;
+    /**
+     * Extract attributes forwarded to a single pane primitive.
+     *
+     * @param {{
+     *   panel: FuroSplitterPanel
+     * }} params - Parameters.
+     * @returns {Record<string, unknown>}
+     */
+    extractPanelAttributes({ panel, }: {
+        panel: FuroSplitterPanel;
+    }): Record<string, unknown>;
+    /**
+     * Extract root attributes forwarded to the underlying primitive.
+     *
+     * @returns {Record<string, unknown>}
+     */
+    extractRootAttributes(): Record<string, unknown>;
+    /**
+     * Build a custom event for layout changes.
+     *
+     * @param {{
+     *   name: string
+     *   layout: Array<number>
+     * }} params - Parameters.
+     * @returns {import('./SplitterEmitPayload.js').SplitterRawEvent}
+     */
+    buildCustomEvent({ name, layout, }: {
+        name: string;
+        layout: Array<number>;
+    }): import("./SplitterEmitPayload.js").SplitterRawEvent;
+    /**
+     * Handle a layout change emitted by the underlying primitive.
+     *
+     * @param {{
+     *   rawLayout: Array<number>
+     * }} params - Parameters.
+     */
+    onLayoutChange({ rawLayout, }: {
+        rawLayout: Array<number>;
+    }): void;
+}
+export type FuroSplitterContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams & {
+    props: Props;
+    componentContext: ComponentContext;
+    refHash: {
+        internalLayoutRef: import("vue").Ref<Array<number>>;
+        groupRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+};
+export type FuroSplitterContextFactoryParams = Omit<FuroSplitterContextParams, "refHash"> & {
+    refHash?: {
+        internalLayoutRef: import("vue").Ref<Array<number>>;
+        groupRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+};
+export type EmitEventName = keyof typeof FuroSplitterContext.EMIT_EVENT_NAME;
+export type FuroSplitterOrientation = "horizontal" | "vertical";
+export type FuroSplitterAppearance = "default" | "plain";
+/**
+ * A single resizable pane descriptor. Sizes are interpreted in `sizeUnit`
+ * (percent by default).
+ */
+export type FuroSplitterPanel = {
+    id?: string;
+    defaultSize?: number;
+    minSize?: number;
+    maxSize?: number;
+    collapsible?: boolean;
+    collapsedSize?: number;
+    sizeUnit?: "%" | "px";
+};
+export type Props = {
+    parcel?: FuroSplitterParcel | null;
+};
+export type FuroSplitterParcel = {
+    orientation?: FuroSplitterOrientation;
+    appearance?: FuroSplitterAppearance;
+    panels?: Array<FuroSplitterPanel>;
+};
+export type FuroSplitterEmitHash = typeof FuroSplitterContext.EMIT_EVENT_HASH;
+export type ComponentContext = import("vue").SetupContext<FuroSplitterEmitHash>;
+export type FuroSplitterSetup = (props: Props, componentContext: ComponentContext) => {
+    context: FuroSplitterContext;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';
+import SplitterEmitPayload from './SplitterEmitPayload.js';

package/types/generated/components/molecules/FuroSplitter/SplitterEmitPayload.d.ts

@@ -0,0 +1,41 @@
+/**
+ * SplitterEmitPayload.
+ *
+ * Wraps the layout change emitted when a pane is resized.
+ *
+ * @extends {BaseEmitPayload<SplitterRawEvent, HTMLElement>}
+ */
+export default class SplitterEmitPayload extends BaseEmitPayload<SplitterRawEvent, HTMLElement> {
+    constructor({ rawEvent, }: import("../../../emit-payload/BaseEmitPayload.js").BaseEmitPayloadParams<SplitterRawEvent>);
+    /**
+     * Get the event detail.
+     *
+     * @returns {SplitterRawEvent['detail'] | null}
+     */
+    get eventDetail(): SplitterRawEvent["detail"] | null;
+    /**
+     * The pane sizes after the resize, in order.
+     *
+     * @returns {Array<number>}
+     */
+    get layout(): Array<number>;
+    /**
+     * Read the size of a single pane by index.
+     *
+     * @param {{
+     *   index: number
+     * }} params - Parameters.
+     * @returns {number | null}
+     */
+    extractPaneSize({ index, }: {
+        index: number;
+    }): number | null;
+}
+export type SplitterRawEvent = CustomEvent<{
+    target: HTMLElement | null;
+    layout: Array<number>;
+}>;
+export type SplitterEmitPayloadParams = {
+    rawEvent: SplitterRawEvent;
+};
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js';