@openreachtech/furo-vue 1.3.1

package/types/generated/components/atoms/FuroSwitch/FuroSwitchContext.d.ts

@@ -0,0 +1,218 @@
+/**
+ * Context class for managing FuroSwitch component.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroSwitchContext extends BaseFuroContext<null, Props, "CHANGE_VALUE" | "UPDATE_VALUE"> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroSwitchContext ? X : never} T, X
+     * @override
+     * @param {FuroSwitchContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroSwitchContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroSwitchContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     * @returns {{
+     *   internalValueRef: import('vue').Ref<FuroSwitchValue>
+     *   switchRootElementRef: import('vue').Ref<HTMLElement | null>
+     * }} Ref hash.
+     */
+    static override buildRefHash(): {
+        internalValueRef: import("vue").Ref<FuroSwitchValue>;
+        switchRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+    /**
+     * Get emit event name.
+     *
+     * @override
+     * @returns {Readonly<{
+     *   CHANGE_VALUE: 'change-value'
+     *   UPDATE_VALUE: 'update:value'
+     * }>} Emit event names.
+     */
+    static override get EMIT_EVENT_NAME(): Readonly<{
+        CHANGE_VALUE: "change-value";
+        UPDATE_VALUE: "update:value";
+    }>;
+    /**
+     * Get emit options.
+     *
+     * @returns {{
+     *   'change-value': (payload: import('./SwitchEmitPayload.js').default) => void
+     *   'update:value': (value: FuroSwitchValue) => void
+     * }} Emit event hash.
+     */
+    static get EMIT_EVENT_HASH(): {
+        "change-value": (payload: import("./SwitchEmitPayload.js").default) => void;
+        "update:value": (value: FuroSwitchValue) => void;
+    };
+    /**
+     * Sizes the switch can take.
+     *
+     * @returns {Array<FuroSwitchSize>} Sizes, largest first.
+     */
+    static get SIZES(): Array<FuroSwitchSize>;
+    /**
+     * Default size.
+     *
+     * @returns {FuroSwitchSize} Default size.
+     */
+    static get DEFAULT_SIZE(): FuroSwitchSize;
+    /**
+     * get: Constructor of `EmitPayload`.
+     *
+     * @returns {typeof SwitchEmitPayload} Constructor of the emit payload.
+     */
+    static get EmitPayloadCtor(): typeof SwitchEmitPayload;
+    /**
+     * Constructor.
+     *
+     * @param {FuroSwitchContextParams} params - Parameters.
+     */
+    constructor({ props, componentContext, refHash, }: FuroSwitchContextParams);
+    refHash: {
+        internalValueRef: import("vue").Ref<FuroSwitchValue>;
+        switchRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+    /**
+     * get: Constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroSwitchContext} Constructor of this class.
+     */
+    override get Ctor(): typeof FuroSwitchContext;
+    /**
+     * Get internal value ref.
+     *
+     * @returns {import('vue').Ref<FuroSwitchValue>} Internal on/off model.
+     */
+    get internalValueRef(): import("vue").Ref<FuroSwitchValue>;
+    /**
+     * Get switch root element ref.
+     *
+     * @returns {import('vue').Ref<HTMLElement | null>} Root element of the switch.
+     */
+    get switchRootElementRef(): import("vue").Ref<HTMLElement | null>;
+    /**
+     * get: size of the switch.
+     *
+     * @returns {FuroSwitchSize} Size; defaults to medium.
+     */
+    get size(): FuroSwitchSize;
+    /**
+     * Whether the parent controls `parcel.value`.
+     *
+     * @returns {boolean} Whether the parent owns the value.
+     */
+    isControlled(): boolean;
+    /**
+     * Resolve synced on/off value from parcel or fallthrough attrs.
+     *
+     * @returns {FuroSwitchValue} Value the parent currently declares.
+     */
+    resolveSyncedValue(): FuroSwitchValue;
+    /**
+     * Whether the switch is disabled.
+     *
+     * @returns {boolean} Whether the switch is disabled.
+     */
+    isDisabled(): boolean;
+    /**
+     * Whether the switch is required.
+     *
+     * @returns {boolean} Whether the switch is required.
+     */
+    isRequired(): boolean;
+    /**
+     * Extract CSS class map for the root.
+     *
+     * @returns {Record<string, boolean>} Class map for the root element.
+     */
+    extractRootClassNames(): Record<string, boolean>;
+    /**
+     * Extract attributes forwarded to the underlying primitive.
+     *
+     * @returns {Record<string, unknown>} Attributes for the root element.
+     */
+    extractRootAttributes(): Record<string, unknown>;
+    /**
+     * Build a custom event for switch value changes.
+     *
+     * @param {{
+     *   name: string
+     *   value: FuroSwitchValue
+     * }} params - Parameters.
+     * @returns {import('./SwitchEmitPayload.js').SwitchRawEvent} Raw event carrying the new value.
+     */
+    buildCustomEvent({ name, value, }: {
+        name: string;
+        value: FuroSwitchValue;
+    }): import("./SwitchEmitPayload.js").SwitchRawEvent;
+    /**
+     * Setup component context.
+     *
+     * @template {X extends FuroSwitchContext ? X : never} T, X
+     * @override
+     * @returns {T} - For method chaining.
+     * @this {T}
+     */
+    override setupComponent<T extends X extends FuroSwitchContext ? X : never, X>(this: T): T;
+    /**
+     * Handle a value update emitted by the underlying primitive.
+     *
+     * @param {{
+     *   rawValue: FuroSwitchValue
+     * }} params - Parameters.
+     */
+    onChangeValue({ rawValue, }: {
+        rawValue: FuroSwitchValue;
+    }): void;
+    /**
+     * Whether the switch is on.
+     *
+     * @returns {boolean} Whether the switch is on.
+     */
+    isChecked(): boolean;
+}
+export type FuroSwitchContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams & {
+    props: Props;
+    componentContext: ComponentContext;
+    refHash: {
+        internalValueRef: import("vue").Ref<FuroSwitchValue>;
+        switchRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+};
+export type FuroSwitchContextFactoryParams = Omit<FuroSwitchContextParams, "refHash"> & {
+    refHash?: {
+        internalValueRef: import("vue").Ref<FuroSwitchValue>;
+        switchRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+};
+export type EmitEventName = keyof typeof FuroSwitchContext.EMIT_EVENT_NAME;
+/**
+ * Public on/off model (`v-model:value`, `parcel.value`).
+ */
+export type FuroSwitchValue = boolean;
+export type FuroSwitchSize = "medium" | "small";
+export type Props = {
+    parcel?: FuroSwitchParcel | null;
+};
+export type FuroSwitchParcel = {
+    value?: FuroSwitchValue;
+    size?: FuroSwitchSize;
+    disabled?: boolean;
+    required?: boolean;
+};
+export type FuroSwitchEmitHash = typeof FuroSwitchContext.EMIT_EVENT_HASH;
+export type ComponentContext = import("vue").SetupContext<FuroSwitchEmitHash>;
+export type FuroSwitchSetup = (props: Props, componentContext: ComponentContext) => {
+    context: FuroSwitchContext;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';
+import SwitchEmitPayload from './SwitchEmitPayload.js';

package/types/generated/components/atoms/FuroSwitch/SwitchEmitPayload.d.ts

@@ -0,0 +1,42 @@
+/**
+ * SwitchEmitPayload.
+ *
+ * @extends {BaseEmitPayload<SwitchRawEvent, HTMLElement>}
+ */
+export default class SwitchEmitPayload extends BaseEmitPayload<SwitchRawEvent, HTMLElement> {
+    constructor({ rawEvent, }: import("../../../emit-payload/BaseEmitPayload.js").BaseEmitPayloadParams<SwitchRawEvent>);
+    /**
+     * Get the event detail.
+     *
+     * @returns {SwitchRawEvent['detail'] | null} Detail of the raw event, or null when absent.
+     */
+    get eventDetail(): SwitchRawEvent["detail"] | null;
+    /**
+     * Current checked state after the change.
+     *
+     * @returns {FuroSwitchValue | null} Checked state, or null when absent.
+     */
+    get value(): FuroSwitchValue | null;
+    /**
+     * Whether the switch is on after the change.
+     *
+     * @returns {boolean | null} Whether the switch is on, or null when the value is absent.
+     */
+    isChecked(): boolean | null;
+    /**
+     * Whether the switch is off after the change.
+     *
+     * @returns {boolean | null} Whether the switch is off, or null when the value is absent.
+     */
+    isUnchecked(): boolean | null;
+}
+export type FuroSwitchValue = import("./FuroSwitchContext.js").FuroSwitchValue;
+export type SwitchEmitPayloadParams = {
+    rawEvent: SwitchRawEvent;
+};
+export type SwitchRawEvent = CustomEvent<{
+    target: HTMLElement | null;
+    value: FuroSwitchValue | null;
+}>;
+export type SwitchEmitPayloadFactoryParams = SwitchEmitPayloadParams;
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js';