@openreachtech/furo-vue 1.3.1

package/types/generated/components/atoms/FuroToggle/FuroToggle.vue.d.ts

@@ -0,0 +1,51 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import("vue").DefineComponent<{
+    parcel?: import("./FuroToggleContext.js").FuroToggleParcel | null;
+}, {
+    context: FuroToggleContext;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    'change-value': (payload: import("./ToggleEmitPayload.js").default) => void;
+    'update:value': (value: FuroToggleValue) => void;
+}, string, import("vue").PublicProps, Readonly<{
+    parcel?: import("./FuroToggleContext.js").FuroToggleParcel | null;
+}> & Readonly<{
+    "onChange-value"?: (payload: import("./ToggleEmitPayload.js").default) => any;
+    "onUpdate:value"?: (value: boolean) => any;
+}>, {
+    parcel: import("./FuroToggleContext.js").FuroToggleParcel;
+}, {}, {
+    RekaToggle: {
+        new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").ToggleProps> & Readonly<{
+            "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
+        }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+            "update:modelValue": (value: 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").ToggleProps> & Readonly<{
+            "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
+        }>, {}, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").ToggleProps> & Readonly<{
+        "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
+    }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+        "update:modelValue": (value: 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: {
+                modelValue: boolean;
+                state: "off" | "on";
+                pressed: boolean;
+                disabled: boolean;
+            }) => any;
+        };
+    });
+}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+import FuroToggleContext from './FuroToggleContext.js';

package/types/generated/components/atoms/FuroToggle/FuroToggleContext.d.ts

@@ -0,0 +1,191 @@
+/**
+ * Context class for managing FuroToggle component.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroToggleContext extends BaseFuroContext<null, Props, "CHANGE_VALUE" | "UPDATE_VALUE"> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroToggleContext ? X : never} T, X
+     * @override
+     * @param {FuroToggleContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroToggleContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroToggleContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     */
+    static override buildRefHash(): {
+        internalValueRef: import("vue").Ref<boolean, boolean>;
+        toggleRootElementRef: 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('./ToggleEmitPayload.js').default) => void
+     *   'update:value': (value: FuroToggleValue) => void
+     * }}
+     */
+    static get EMIT_EVENT_HASH(): {
+        "change-value": (payload: import("./ToggleEmitPayload.js").default) => void;
+        "update:value": (value: FuroToggleValue) => void;
+    };
+    /**
+     * get: Constructor of `EmitPayload`.
+     *
+     * @returns {typeof ToggleEmitPayload}
+     */
+    static get EmitPayloadCtor(): typeof ToggleEmitPayload;
+    /**
+     * Constructor.
+     *
+     * @param {FuroToggleContextParams} params
+     */
+    constructor({ props, componentContext, refHash, }: FuroToggleContextParams);
+    refHash: {
+        internalValueRef: import("vue").Ref<FuroToggleValue>;
+        toggleRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+    /**
+     * get: Constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroToggleContext}
+     */
+    override get Ctor(): typeof FuroToggleContext;
+    /**
+     * Get internal value ref (Reka pressed model).
+     *
+     * @returns {import('vue').Ref<FuroToggleValue>}
+     */
+    get internalValueRef(): import("vue").Ref<FuroToggleValue>;
+    /**
+     * Get toggle root element ref.
+     *
+     * @returns {import('vue').Ref<HTMLElement | null>}
+     */
+    get toggleRootElementRef(): import("vue").Ref<HTMLElement | null>;
+    /**
+     * Whether the parent controls `parcel.value`.
+     *
+     * @returns {boolean}
+     */
+    isControlled(): boolean;
+    /**
+     * Resolve synced pressed value from parcel or fallthrough attrs.
+     *
+     * @returns {FuroToggleValue}
+     */
+    resolveSyncedValue(): FuroToggleValue;
+    /**
+     * Whether the toggle is disabled.
+     *
+     * @returns {boolean}
+     */
+    isDisabled(): boolean;
+    /**
+     * Extract CSS class map for the toggle root.
+     *
+     * @returns {Record<string, boolean>}
+     */
+    extractRootClassNames(): Record<string, boolean>;
+    /**
+     * Extract root attributes forwarded to Reka Toggle.
+     *
+     * @returns {Record<string, unknown>}
+     */
+    extractRootAttributes(): Record<string, unknown>;
+    /**
+     * Build a custom event for toggle value changes.
+     *
+     * @param {{
+     *   name: string
+     *   value: FuroToggleValue
+     * }} params - Parameters.
+     * @returns {import('./ToggleEmitPayload.js').ToggleRawEvent}
+     */
+    buildCustomEvent({ name, value, }: {
+        name: string;
+        value: FuroToggleValue;
+    }): import("./ToggleEmitPayload.js").ToggleRawEvent;
+    /**
+     * Setup component context.
+     *
+     * @template {X extends FuroToggleContext ? X : never} T, X
+     * @override
+     * @returns {T} - For method chaining.
+     * @this {T}
+     */
+    override setupComponent<T extends X extends FuroToggleContext ? X : never, X>(this: T): T;
+    /**
+     * Handle value update emitted by Reka Toggle.
+     *
+     * @param {{
+     *   rawValue: FuroToggleValue
+     * }} params - Parameters.
+     */
+    onChangeValue({ rawValue, }: {
+        rawValue: FuroToggleValue;
+    }): void;
+    /**
+     * Whether the toggle is pressed.
+     *
+     * @returns {boolean}
+     */
+    isPressed(): boolean;
+}
+export type FuroToggleContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams & {
+    props: Props;
+    componentContext: ComponentContext;
+    refHash: {
+        internalValueRef: import("vue").Ref<FuroToggleValue>;
+        toggleRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+};
+export type FuroToggleContextFactoryParams = Omit<FuroToggleContextParams, "refHash"> & {
+    refHash?: {
+        internalValueRef: import("vue").Ref<FuroToggleValue>;
+        toggleRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+};
+export type EmitEventName = keyof typeof FuroToggleContext.EMIT_EVENT_NAME;
+/**
+ * Public pressed model (`v-model:value`, `parcel.value`).
+ */
+export type FuroToggleValue = boolean;
+export type FuroToggleVariant = "default" | "outline";
+export type FuroToggleSize = "default" | "sm" | "lg";
+export type Props = {
+    parcel?: FuroToggleParcel | null;
+};
+export type FuroToggleParcel = {
+    value?: FuroToggleValue;
+    variant?: FuroToggleVariant;
+    size?: FuroToggleSize;
+    disabled?: boolean;
+};
+export type FuroToggleEmitHash = typeof FuroToggleContext.EMIT_EVENT_HASH;
+export type ComponentContext = import("vue").SetupContext<FuroToggleEmitHash>;
+export type FuroToggleSetup = (props: Props, componentContext: ComponentContext) => {
+    context: FuroToggleContext;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';
+import ToggleEmitPayload from './ToggleEmitPayload.js';

package/types/generated/components/atoms/FuroToggle/ToggleEmitPayload.d.ts

@@ -0,0 +1,42 @@
+/**
+ * ToggleEmitPayload.
+ *
+ * @extends {BaseEmitPayload<ToggleRawEvent, HTMLElement>}
+ */
+export default class ToggleEmitPayload extends BaseEmitPayload<ToggleRawEvent, HTMLElement> {
+    constructor({ rawEvent, }: import("../../../emit-payload/BaseEmitPayload.js").BaseEmitPayloadParams<ToggleRawEvent>);
+    /**
+     * Get the event detail.
+     *
+     * @returns {ToggleRawEvent['detail'] | null}
+     */
+    get eventDetail(): ToggleRawEvent["detail"] | null;
+    /**
+     * Current pressed state after the change.
+     *
+     * @returns {FuroToggleValue | null}
+     */
+    get value(): FuroToggleValue | null;
+    /**
+     * Whether the toggle is pressed after the change.
+     *
+     * @returns {boolean | null}
+     */
+    isPressed(): boolean | null;
+    /**
+     * Whether the toggle is released after the change.
+     *
+     * @returns {boolean | null}
+     */
+    isReleased(): boolean | null;
+}
+export type FuroToggleValue = import("./FuroToggleContext.js").FuroToggleValue;
+export type ToggleEmitPayloadParams = {
+    rawEvent: ToggleRawEvent;
+};
+export type ToggleRawEvent = CustomEvent<{
+    target: HTMLElement | null;
+    value: FuroToggleValue | null;
+}>;
+export type ToggleEmitPayloadFactoryParams = ToggleEmitPayloadParams;
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js';

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

@@ -0,0 +1,41 @@
+/**
+ * AccordionEmitPayload.
+ *
+ * @extends {BaseEmitPayload<AccordionRawEvent, HTMLElement>}
+ */
+export default class AccordionEmitPayload extends BaseEmitPayload<AccordionRawEvent, HTMLElement> {
+    constructor({ rawEvent, }: import("../../../emit-payload/BaseEmitPayload.js").BaseEmitPayloadParams<AccordionRawEvent>);
+    /**
+     * Get the event detail.
+     *
+     * @returns {AccordionRawEvent['detail'] | null}
+     */
+    get eventDetail(): AccordionRawEvent["detail"] | null;
+    /**
+     * Expanded value(s) after the change.
+     *
+     * @returns {FuroAccordionValue | null}
+     */
+    get value(): FuroAccordionValue | null;
+    /**
+     * Whether the given section value is expanded after the change.
+     *
+     * @param {{
+     *   value: string
+     * }} params - Parameters.
+     * @returns {boolean}
+     */
+    isExpanded({ value, }: {
+        value: string;
+    }): boolean;
+}
+export type FuroAccordionValue = import("./FuroAccordionContext.js").FuroAccordionValue;
+export type AccordionEmitPayloadParams = {
+    rawEvent: AccordionRawEvent;
+};
+export type AccordionRawEvent = CustomEvent<{
+    target: HTMLElement | null;
+    value: FuroAccordionValue | null;
+}>;
+export type AccordionEmitPayloadFactoryParams = AccordionEmitPayloadParams;
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js';

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

@@ -0,0 +1,133 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import("vue").DefineComponent<{
+    parcel?: import("./FuroAccordionContext.js").FuroAccordionParcel | null;
+}, {
+    context: FuroAccordionContext;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    'change-value': (payload: import("./AccordionEmitPayload.js").default) => void;
+    'update:value': (value: FuroAccordionValue) => void;
+}, string, import("vue").PublicProps, Readonly<{
+    parcel?: import("./FuroAccordionContext.js").FuroAccordionParcel | null;
+}> & Readonly<{
+    "onChange-value"?: (payload: import("./AccordionEmitPayload.js").default) => any;
+    "onUpdate:value"?: (value: import("./FuroAccordionContext.js").FuroAccordionValue) => any;
+}>, {
+    parcel: import("./FuroAccordionContext.js").FuroAccordionParcel;
+}, {}, {
+    AccordionRoot: <T extends (string | string[]), ExplicitType extends import("reka-ui").SingleOrMultipleType>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: {
+        attrs: any;
+        slots: {
+            default?: (props: {
+                modelValue: import("reka-ui").AcceptableValue | import("reka-ui").AcceptableValue[] | undefined;
+            }) => any;
+        };
+        emit: (evt: "update:modelValue", value: (ExplicitType extends "single" ? string : string[]) | undefined) => void;
+    }, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+        props: import("vue").PublicProps & {
+            collapsible?: boolean;
+            disabled?: boolean;
+            dir?: import("reka-ui").Direction;
+            orientation?: import("reka-ui").DataOrientation;
+            unmountOnHide?: boolean;
+            asChild?: boolean;
+            as?: import("reka-ui").AsTag | import("vue").Component;
+            type?: import("reka-ui").SingleOrMultipleType;
+            modelValue?: T;
+            defaultValue?: T;
+            "onUpdate:modelValue"?: ((value: (ExplicitType extends "single" ? string : string[]) | undefined) => any) | undefined;
+        } & (typeof globalThis extends {
+            __VLS_PROPS_FALLBACK: infer P;
+        } ? P : {});
+        expose: (exposed: {}) => void;
+        attrs: any;
+        slots: {
+            default?: (props: {
+                modelValue: import("reka-ui").AcceptableValue | import("reka-ui").AcceptableValue[] | undefined;
+            }) => any;
+        };
+        emit: (evt: "update:modelValue", value: (ExplicitType extends "single" ? string : string[]) | undefined) => void;
+    }>) => import("vue").VNode & {
+        __ctx?: Awaited<typeof __VLS_setup>;
+    };
+    AccordionSection: {
+        new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").AccordionItemProps> & Readonly<{}>, {
+            open: import("vue").ComputedRef<boolean>;
+            dataDisabled: import("vue").ComputedRef<"" | undefined>;
+        }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, 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").AccordionItemProps> & Readonly<{}>, {
+            open: import("vue").ComputedRef<boolean>;
+            dataDisabled: import("vue").ComputedRef<"" | undefined>;
+        }, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").AccordionItemProps> & Readonly<{}>, {
+        open: import("vue").ComputedRef<boolean>;
+        dataDisabled: import("vue").ComputedRef<"" | undefined>;
+    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, 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: {
+                open: boolean;
+            }) => any;
+        };
+    });
+    AccordionHeader: {
+        new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").AccordionHeaderProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, 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").AccordionHeaderProps> & Readonly<{}>, {}, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").AccordionHeaderProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, 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;
+        };
+    });
+    AccordionTrigger: {
+        new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").AccordionTriggerProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, 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").AccordionTriggerProps> & Readonly<{}>, {}, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").AccordionTriggerProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, 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;
+        };
+    });
+    AccordionContent: {
+        new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").AccordionContentProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, 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").AccordionContentProps> & Readonly<{}>, {}, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").AccordionContentProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, 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 FuroAccordionContext from './FuroAccordionContext.js';