@openreachtech/furo-vue 1.3.1

package/types/generated/components/molecules/FuroAccordion/FuroAccordionContext.d.ts

@@ -0,0 +1,279 @@
+/**
+ * Context class for managing FuroAccordion molecule.
+ *
+ * Multi-section collapse: a vertical stack of headers, each toggling its own
+ * content region. `single` mode keeps at most one section open; `multiple`
+ * mode allows several. The public value (`v-model:value`, `parcel.value`) is a
+ * single value in `single` mode and an array in `multiple` mode.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroAccordionContext extends BaseFuroContext<null, Props, "CHANGE_VALUE" | "UPDATE_VALUE"> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroAccordionContext ? X : never} T, X
+     * @override
+     * @param {FuroAccordionContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroAccordionContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroAccordionContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     */
+    static override buildRefHash(): {
+        internalValueRef: import("vue").Ref<any, any>;
+        accordionRootElementRef: 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('./AccordionEmitPayload.js').default) => void
+     *   'update:value': (value: FuroAccordionValue) => void
+     * }}
+     */
+    static get EMIT_EVENT_HASH(): {
+        "change-value": (payload: import("./AccordionEmitPayload.js").default) => void;
+        "update:value": (value: FuroAccordionValue) => void;
+    };
+    /**
+     * get: Constructor of `EmitPayload`.
+     *
+     * @returns {typeof AccordionEmitPayload}
+     */
+    static get EmitPayloadCtor(): typeof AccordionEmitPayload;
+    /**
+     * Constructor.
+     *
+     * @param {FuroAccordionContextParams} params
+     */
+    constructor({ props, componentContext, refHash, }: FuroAccordionContextParams);
+    refHash: {
+        internalValueRef: import("vue").Ref<FuroAccordionValue>;
+        accordionRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+    /**
+     * get: Constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroAccordionContext}
+     */
+    override get Ctor(): typeof FuroAccordionContext;
+    /**
+     * Get internal value ref (synced expansion model).
+     *
+     * @returns {import('vue').Ref<FuroAccordionValue>}
+     */
+    get internalValueRef(): import("vue").Ref<FuroAccordionValue>;
+    /**
+     * Get accordion root element ref.
+     *
+     * @returns {import('vue').Ref<HTMLElement | null>}
+     */
+    get accordionRootElementRef(): import("vue").Ref<HTMLElement | null>;
+    /**
+     * Get the section options.
+     *
+     * @returns {Array<FuroAccordionOption>}
+     */
+    get options(): Array<FuroAccordionOption>;
+    /**
+     * Resolve the selection mode (maps to the primitive's type prop).
+     *
+     * @returns {FuroAccordionSelectionMode}
+     */
+    resolveSelectionMode(): FuroAccordionSelectionMode;
+    /**
+     * Resolve the layout orientation.
+     *
+     * @returns {FuroAccordionOrientation}
+     */
+    resolveOrientation(): FuroAccordionOrientation;
+    /**
+     * Whether multiple sections can be open at once.
+     *
+     * @returns {boolean}
+     */
+    isMultiple(): boolean;
+    /**
+     * Whether an open section can be closed by clicking its header.
+     * Only meaningful in `single` mode; `multiple` mode is always collapsible.
+     *
+     * @returns {boolean}
+     */
+    isCollapsible(): boolean;
+    /**
+     * Resolve the default empty expansion for the current selection mode.
+     *
+     * @returns {FuroAccordionValue}
+     */
+    resolveDefaultValue(): FuroAccordionValue;
+    /**
+     * Whether the parent controls `parcel.value`.
+     *
+     * @returns {boolean}
+     */
+    isControlled(): boolean;
+    /**
+     * Resolve synced expansion value from parcel or fallthrough attrs.
+     *
+     * @returns {FuroAccordionValue}
+     */
+    resolveSyncedValue(): FuroAccordionValue;
+    /**
+     * Whether the accordion is disabled.
+     *
+     * @returns {boolean}
+     */
+    isDisabled(): boolean;
+    /**
+     * Whether a single section is disabled.
+     *
+     * @param {{
+     *   option: FuroAccordionOption
+     * }} params - Parameters.
+     * @returns {boolean}
+     */
+    isOptionDisabled({ option, }: {
+        option: FuroAccordionOption;
+    }): boolean;
+    /**
+     * Whether the given section value is currently expanded.
+     *
+     * @param {{
+     *   value: string
+     * }} params - Parameters.
+     * @returns {boolean}
+     */
+    isExpanded({ value, }: {
+        value: string;
+    }): boolean;
+    /**
+     * Extract the display label for a section.
+     *
+     * @param {{
+     *   option: FuroAccordionOption
+     * }} params - Parameters.
+     * @returns {string}
+     */
+    extractOptionLabel({ option, }: {
+        option: FuroAccordionOption;
+    }): string;
+    /**
+     * Extract CSS class map for the accordion root.
+     *
+     * @returns {Record<string, boolean>}
+     */
+    extractRootClassNames(): Record<string, boolean>;
+    /**
+     * Extract CSS class map for a single accordion item.
+     *
+     * @param {{
+     *   option: FuroAccordionOption
+     * }} params - Parameters.
+     * @returns {Record<string, boolean>}
+     */
+    extractItemClassNames({ option, }: {
+        option: FuroAccordionOption;
+    }): Record<string, boolean>;
+    /**
+     * Extract root attributes forwarded to the underlying primitive.
+     *
+     * @returns {Record<string, unknown>}
+     */
+    extractRootAttributes(): Record<string, unknown>;
+    /**
+     * Build a custom event for expansion changes.
+     *
+     * @param {{
+     *   name: string
+     *   value: FuroAccordionValue
+     * }} params - Parameters.
+     * @returns {import('./AccordionEmitPayload.js').AccordionRawEvent}
+     */
+    buildCustomEvent({ name, value, }: {
+        name: string;
+        value: FuroAccordionValue;
+    }): import("./AccordionEmitPayload.js").AccordionRawEvent;
+    /**
+     * Setup component context.
+     *
+     * @template {X extends FuroAccordionContext ? X : never} T, X
+     * @override
+     * @returns {T} - For method chaining.
+     * @this {T}
+     */
+    override setupComponent<T extends X extends FuroAccordionContext ? X : never, X>(this: T): T;
+    /**
+     * Handle expansion update emitted by the underlying primitive.
+     *
+     * @param {{
+     *   rawValue: FuroAccordionValue
+     * }} params - Parameters.
+     */
+    onChangeValue({ rawValue, }: {
+        rawValue: FuroAccordionValue;
+    }): void;
+}
+export type FuroAccordionContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams & {
+    props: Props;
+    componentContext: ComponentContext;
+    refHash: {
+        internalValueRef: import("vue").Ref<FuroAccordionValue>;
+        accordionRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+};
+export type FuroAccordionContextFactoryParams = Omit<FuroAccordionContextParams, "refHash"> & {
+    refHash?: {
+        internalValueRef: import("vue").Ref<FuroAccordionValue>;
+        accordionRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+};
+export type EmitEventName = keyof typeof FuroAccordionContext.EMIT_EVENT_NAME;
+/**
+ * Public expansion model (`v-model:value`, `parcel.value`).
+ * A single value in `single` mode, an array in `multiple` mode.
+ */
+export type FuroAccordionValue = string | Array<string> | null;
+export type FuroAccordionSelectionMode = "single" | "multiple";
+export type FuroAccordionOrientation = "vertical" | "horizontal";
+export type FuroAccordionOption = {
+    value: string;
+    label?: string;
+    disabled?: boolean;
+};
+export type Props = {
+    parcel?: FuroAccordionParcel | null;
+};
+export type FuroAccordionParcel = {
+    value?: FuroAccordionValue;
+    selectionMode?: FuroAccordionSelectionMode;
+    options?: Array<FuroAccordionOption>;
+    collapsible?: boolean;
+    disabled?: boolean;
+    orientation?: FuroAccordionOrientation;
+};
+export type FuroAccordionEmitHash = typeof FuroAccordionContext.EMIT_EVENT_HASH;
+export type ComponentContext = import("vue").SetupContext<FuroAccordionEmitHash>;
+export type FuroAccordionSetup = (props: Props, componentContext: ComponentContext) => {
+    context: FuroAccordionContext;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';
+import AccordionEmitPayload from './AccordionEmitPayload.js';

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

@@ -0,0 +1,79 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import("vue").DefineComponent<{
+    parcel: import("./FuroAttachmentContext.js").FuroAttachmentParcel | null;
+}, {
+    context: FuroAttachmentContext;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    download: (payload: FuroAttachmentEmitPayload) => void;
+    remove: (payload: FuroAttachmentEmitPayload) => void;
+}, string, import("vue").PublicProps, Readonly<{
+    parcel: import("./FuroAttachmentContext.js").FuroAttachmentParcel | null;
+}> & Readonly<{
+    onDownload?: (payload: import("./FuroAttachmentContext.js").FuroAttachmentEmitPayload) => any;
+    onRemove?: (payload: import("./FuroAttachmentContext.js").FuroAttachmentEmitPayload) => any;
+}>, {
+    parcel: import("./FuroAttachmentContext.js").FuroAttachmentParcel;
+}, import("./FuroAttachmentContext.js").FuroAttachmentSlots, {
+    FuroButton: import("vue").DefineComponent<{
+        parcel?: import("../../atoms/FuroButton/FuroButtonContext.js").FuroButtonParcel | null;
+    }, {
+        context: import("../../atoms/FuroButton/FuroButtonContext.js").default;
+    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+        click: (payload: import("../../atoms/FuroButton/ButtonEmitPayload.js").default) => void;
+    }, string, import("vue").PublicProps, Readonly<{
+        parcel?: import("../../atoms/FuroButton/FuroButtonContext.js").FuroButtonParcel | null;
+    }> & Readonly<{
+        onClick?: (payload: import("../../atoms/FuroButton/ButtonEmitPayload.js").default) => any;
+    }>, {
+        parcel: import("../../atoms/FuroButton/FuroButtonContext.js").FuroButtonParcel;
+    }, import("../../atoms/FuroButton/FuroButtonContext.js").FuroButtonSlots, {
+        FuroIcon: import("vue").DefineComponent<{
+            name: string;
+            size?: string | number | null;
+        }, {
+            context: import("../../atoms/FuroIcon/FuroIconContext.js").default;
+        }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{
+            name: string;
+            size?: string | number | null;
+        }> & Readonly<{}>, {
+            size: string | number;
+        }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+        Primitive: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+            asChild: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            as: {
+                type: import("vue").PropType<import("reka-ui").AsTag | import("vue").Component>;
+                default: string;
+            };
+        }>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+            [key: string]: any;
+        }>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+            asChild: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            as: {
+                type: import("vue").PropType<import("reka-ui").AsTag | import("vue").Component>;
+                default: string;
+            };
+        }>> & Readonly<{}>, {
+            asChild: boolean;
+            as: import("reka-ui").AsTag | import("vue").Component;
+        }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+    }, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+    FuroIcon: import("vue").DefineComponent<{
+        name: string;
+        size?: string | number | null;
+    }, {
+        context: import("../../atoms/FuroIcon/FuroIconContext.js").default;
+    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{
+        name: string;
+        size?: string | number | null;
+    }> & Readonly<{}>, {
+        size: string | number;
+    }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+import FuroAttachmentContext from './FuroAttachmentContext.js';