@openreachtech/furo-vue 1.3.1

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

@@ -0,0 +1,363 @@
+/**
+ * Context class for FuroAttachment molecule.
+ *
+ * One component covers both shapes the design draws. With no image source it
+ * renders a file row carrying a type glyph; with one it renders the preview at
+ * a single size and crop. A preview that fails to load falls back to the row,
+ * so a dead URL shows the glyph rather than a broken image.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroAttachmentContext extends BaseFuroContext<null, Props, "DOWNLOAD" | "REMOVE"> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroAttachmentContext ? X : never} T, X
+     * @override
+     * @param {FuroAttachmentContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroAttachmentContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroAttachmentContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     * @returns {FuroAttachmentContextParams['refHash']} Ref hash.
+     */
+    static override buildRefHash(): FuroAttachmentContextParams["refHash"];
+    /**
+     * Get emit event name.
+     *
+     * @override
+     * @returns {Readonly<{
+     *   DOWNLOAD: 'download'
+     *   REMOVE: 'remove'
+     * }>} Emit event names.
+     */
+    static override get EMIT_EVENT_NAME(): Readonly<{
+        DOWNLOAD: "download";
+        REMOVE: "remove";
+    }>;
+    /**
+     * Get emit options.
+     *
+     * @returns {{
+     *   download: (payload: FuroAttachmentEmitPayload) => void
+     *   remove: (payload: FuroAttachmentEmitPayload) => void
+     * }} Emit hash.
+     */
+    static get EMIT_EVENT_HASH(): {
+        download: (payload: FuroAttachmentEmitPayload) => void;
+        remove: (payload: FuroAttachmentEmitPayload) => void;
+    };
+    /**
+     * The glyph a file row shows when the caller names none.
+     *
+     * @returns {string} Icon name.
+     */
+    static get DEFAULT_ICON_NAME(): string;
+    /**
+     * The lowest share of an upload the bar can report.
+     *
+     * @returns {number} Percentage.
+     */
+    static get MINIMUM_UPLOAD_PROGRESS(): number;
+    /**
+     * The highest share of an upload the bar can report.
+     *
+     * @returns {number} Percentage.
+     */
+    static get MAXIMUM_UPLOAD_PROGRESS(): number;
+    /**
+     * Constructor.
+     *
+     * @param {FuroAttachmentContextParams} params - Parameters of this constructor.
+     */
+    constructor({ props, componentContext, refHash, }: FuroAttachmentContextParams);
+    refHash: {
+        imagePreviewFailedRef: import("vue").Ref<boolean>;
+    };
+    /**
+     * get: Constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroAttachmentContext} Constructor.
+     */
+    override get Ctor(): typeof FuroAttachmentContext;
+    /**
+     * get: whether the preview of the current source failed to load.
+     *
+     * @returns {import('vue').Ref<boolean>} Ref.
+     */
+    get imagePreviewFailedRef(): import("vue").Ref<boolean>;
+    /**
+     * get: name of the file.
+     *
+     * @returns {string} File name; empty string when unset.
+     */
+    get fileName(): string;
+    /**
+     * get: size of the file, already formatted for reading.
+     *
+     * @returns {string} Formatted size; empty string when unset.
+     */
+    get fileSize(): string;
+    /**
+     * get: source of the preview image.
+     *
+     * @returns {string | null} Source, or null when the file has no preview.
+     */
+    get imageSource(): string | null;
+    /**
+     * get: alternative text for the preview image.
+     *
+     * Falls back to the file name, which is what a caller would otherwise repeat.
+     *
+     * @returns {string} Alternative text.
+     */
+    get imageAlternativeText(): string;
+    /**
+     * get: name of the glyph a file row shows.
+     *
+     * @returns {string} Icon name.
+     */
+    get iconName(): string;
+    /**
+     * get: share of the upload already sent.
+     *
+     * @returns {number | null} Percentage, or null when the size is unknown.
+     */
+    get uploadProgress(): number | null;
+    /**
+     * get: accessible name of the download action.
+     *
+     * @returns {string} Label.
+     */
+    get downloadLabel(): string;
+    /**
+     * get: accessible name of the remove action.
+     *
+     * @returns {string} Label.
+     */
+    get removeLabel(): string;
+    /**
+     * get: accessible name of the upload bar.
+     *
+     * @returns {string} Label.
+     */
+    get uploadingLabel(): string;
+    /**
+     * Setup component.
+     *
+     * @template {X extends FuroAttachmentContext ? X : never} T, X
+     * @override
+     * @returns {T} For method chaining.
+     * @this {T}
+     */
+    override setupComponent<T extends X extends FuroAttachmentContext ? X : never, X>(this: T): T;
+    /**
+     * Whether the file is still being sent.
+     *
+     * @returns {boolean} true while the upload runs.
+     */
+    isUploading(): boolean;
+    /**
+     * Whether the caller allows the file to be downloaded.
+     *
+     * @returns {boolean} true when the download action may render.
+     */
+    isDownloadable(): boolean;
+    /**
+     * Whether the caller allows the file to be taken off the record.
+     *
+     * @returns {boolean} true when the remove action may render.
+     */
+    isRemovable(): boolean;
+    /**
+     * Whether the caller knows how large the upload is.
+     *
+     * @returns {boolean} true when a share was named, false when the size is unknown.
+     */
+    isUploadMeasured(): boolean;
+    /**
+     * Whether the preview renders in place of the file row.
+     *
+     * @returns {boolean} true when a source is set and it has loaded.
+     */
+    hasImagePreview(): boolean;
+    /**
+     * Whether the row shows the formatted size under the name.
+     *
+     * @returns {boolean} true when a size is set and no upload is running.
+     */
+    hasFileSizeCaption(): boolean;
+    /**
+     * Whether the row shows the upload bar in place of the size.
+     *
+     * @returns {boolean} true while a file with no preview uploads.
+     */
+    hasProgressBar(): boolean;
+    /**
+     * Whether the preview is veiled and marked as uploading.
+     *
+     * The preview has no room for a bar, so the design covers it and spins
+     * instead of reporting a share.
+     *
+     * @returns {boolean} true while a file with a preview uploads.
+     */
+    hasUploadingPreview(): boolean;
+    /**
+     * Whether the download action renders.
+     *
+     * @returns {boolean} true when the file is downloadable and settled.
+     */
+    hasDownloadAction(): boolean;
+    /**
+     * Whether the remove action renders.
+     *
+     * It stays through an upload of a file with no preview, where it cancels.
+     *
+     * @returns {boolean} true when the remove action renders.
+     */
+    hasRemoveAction(): boolean;
+    /**
+     * Whether anything renders in the action cluster.
+     *
+     * @returns {boolean} true when the cluster holds at least one control.
+     */
+    hasActions(): boolean;
+    /**
+     * Clamp the named share to the bar's own range, so a fill cannot outrun its track.
+     *
+     * @returns {number} Percentage between zero and one hundred.
+     */
+    calculateUploadProgress(): number;
+    /**
+     * Extract CSS class map for the root.
+     *
+     * @returns {Record<string, boolean>} Class map.
+     */
+    extractRootClassNames(): Record<string, boolean>;
+    /**
+     * Extract attributes forwarded to the root element.
+     *
+     * @returns {Record<string, unknown>} Passthrough attributes.
+     */
+    extractRootAttributes(): Record<string, unknown>;
+    /**
+     * Extract the attributes that let the bar report its share.
+     *
+     * @returns {{
+     *   role: 'progressbar'
+     *   'aria-label': string
+     *   'aria-valuemin': number
+     *   'aria-valuemax': number
+     *   'aria-valuenow'?: number
+     * }} Progress attributes.
+     */
+    extractProgressAttributes(): {
+        role: "progressbar";
+        "aria-label": string;
+        "aria-valuemin": number;
+        "aria-valuemax": number;
+        "aria-valuenow"?: number;
+    };
+    /**
+     * Build the attributes an upload of unknown size cannot answer.
+     *
+     * @returns {{
+     *   'aria-valuenow'?: number
+     * }} Progress attributes.
+     */
+    buildOptionalProgressAttributes(): {
+        "aria-valuenow"?: number;
+    };
+    /**
+     * Extract inline style for the filled part of the bar.
+     *
+     * @returns {{
+     *   width?: string
+     * }} Progress style.
+     */
+    extractProgressStyle(): {
+        width?: string;
+    };
+    /**
+     * Extract CSS class map for the filled part of the bar.
+     *
+     * @returns {Record<string, boolean>} Class map.
+     */
+    extractProgressFillClassNames(): Record<string, boolean>;
+    /**
+     * Build the parcel handed to one action button.
+     *
+     * @returns {{
+     *   variant: 'ghost'
+     *   size: 'icon'
+     * }} Button parcel.
+     */
+    buildActionParcel(): {
+        variant: "ghost";
+        size: "icon";
+    };
+    /**
+     * Build the payload an action carries.
+     *
+     * @returns {FuroAttachmentEmitPayload} Payload.
+     */
+    buildEmitPayload(): FuroAttachmentEmitPayload;
+    /**
+     * Handle the preview failing to load.
+     */
+    onImagePreviewError(): void;
+    /**
+     * Handle a click on the download action.
+     */
+    onDownloadClick(): void;
+    /**
+     * Handle a click on the remove action.
+     */
+    onRemoveClick(): void;
+}
+export type FuroAttachmentContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams & {
+    props: Props;
+    componentContext: ComponentContext;
+    refHash: {
+        imagePreviewFailedRef: import("vue").Ref<boolean>;
+    };
+};
+export type FuroAttachmentContextFactoryParams = Omit<FuroAttachmentContextParams, "refHash"> & {
+    refHash?: FuroAttachmentContextParams["refHash"];
+};
+export type EmitEventName = keyof typeof FuroAttachmentContext.EMIT_EVENT_NAME;
+export type FuroAttachmentEmitPayload = {
+    fileName: string;
+};
+export type Props = {
+    parcel: FuroAttachmentParcel | null;
+};
+export type FuroAttachmentParcel = {
+    fileName?: string;
+    fileSize?: string;
+    imageSource?: string;
+    imageAlternativeText?: string;
+    iconName?: string;
+    uploading?: boolean;
+    uploadProgress?: number | null;
+    downloadable?: boolean;
+    removable?: boolean;
+    downloadLabel?: string;
+    removeLabel?: string;
+    uploadingLabel?: string;
+};
+export type ComponentContext = import("vue").SetupContext<FuroAttachmentEmitHash, FuroAttachmentSlots>;
+export type FuroAttachmentEmitHash = typeof FuroAttachmentContext.EMIT_EVENT_HASH;
+export type FuroAttachmentSlots = import("vue").SlotsType<{
+    glyph: {};
+    actions: {};
+}>;
+export type FuroAttachmentSetup = (props: Props, componentContext: ComponentContext) => {
+    context: FuroAttachmentContext;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';

package/types/generated/components/molecules/FuroAutocompleteField/AutocompleteEmitPayload.d.ts

@@ -0,0 +1,129 @@
+/**
+ * AutocompleteEmitPayload.
+ *
+ * @extends {BaseEmitPayload<AutocompleteRawEvent, HTMLElement>}
+ */
+export default class AutocompleteEmitPayload extends BaseEmitPayload<AutocompleteRawEvent, HTMLElement> {
+    constructor({ rawEvent, }: import("../../../emit-payload/BaseEmitPayload.js").BaseEmitPayloadParams<AutocompleteRawEvent>);
+    /**
+     * Get the event detail.
+     *
+     * @returns {AutocompleteRawEvent['detail'] | null}
+     */
+    get eventDetail(): AutocompleteRawEvent["detail"] | null;
+    /**
+     * Search keyword at emit time.
+     *
+     * @returns {string}
+     */
+    get searchKeyword(): string;
+    /**
+     * Matched option for the selected value.
+     *
+     * @returns {FuroAutocompleteOption | FuroAcceptableValue}
+     */
+    get selectedOption(): FuroAutocompleteOption | FuroAcceptableValue;
+    /**
+     * Zero-based selected option index.
+     *
+     * @returns {number | null}
+     */
+    get selectedIndex(): number | null;
+    /**
+     * Selected options for multi-select mode.
+     *
+     * @returns {Array<FuroAutocompleteOption | FuroAcceptableValue>}
+     */
+    get selectedOptions(): Array<FuroAutocompleteOption | FuroAcceptableValue>;
+    /**
+     * Zero-based group index for the selected option.
+     *
+     * @returns {number | null}
+     */
+    get selectedGroupIndex(): number | null;
+    /**
+     * Extract value from the selected option.
+     *
+     * @param {{
+     *   option?: FuroAutocompleteOption | FuroAcceptableValue
+     * }} [params] - Parameters of this method.
+     * @returns {FuroAutocompleteOption | FuroAcceptableValue}
+     */
+    extractValue({ option, }?: {
+        option?: FuroAutocompleteOption | FuroAcceptableValue;
+    }): FuroAutocompleteOption | FuroAcceptableValue;
+    /**
+     * Extract selected values from selected options.
+     *
+     * @returns {Array<FuroAcceptableValue>}
+     */
+    extractValues(): Array<FuroAcceptableValue>;
+    /**
+     * Whether the autocomplete value is empty.
+     *
+     * @returns {boolean}
+     */
+    hasEmptyValue(): boolean;
+    /**
+     * Whether the autocomplete has a selected value.
+     *
+     * @returns {boolean}
+     */
+    hasSelectedValue(): boolean;
+    /**
+     * Extract trimmed search keyword.
+     *
+     * @returns {string}
+     */
+    extractTrimmedSearchKeyword(): string;
+    /**
+     * Whether the selected value matches the given option value (strict equality).
+     *
+     * @param {{
+     *   value?: FuroAcceptableValue
+     * }} [params] - Parameters of this method.
+     * @returns {boolean}
+     */
+    matchesOption({ value, }?: {
+        value?: FuroAcceptableValue;
+    }): boolean;
+}
+export type FuroAcceptableValue = string | number | bigint | Record<string, any> | null;
+/**
+ * Public list row shape for applications. Additional JSON-serializable keys are allowed.
+ */
+export type FuroAutocompleteOption = {
+    label: string;
+    value: FuroAcceptableValue;
+    disabled?: boolean;
+    icon?: IconProps;
+    indicatorIcon?: IconProps;
+    separator?: boolean;
+    options?: Array<FuroAutocompleteOption | FuroAcceptableValue>;
+    [key: string]: any;
+};
+/**
+ * Internal Reka row props. Not part of the public application API.
+ */
+export type RekaComboboxOptionProps = Reka.AutocompleteItemProps & Reka.AutocompleteItemIndicatorProps;
+export type IconProps = {
+    name: string;
+    size?: string;
+    style?: import("vue").CSSProperties;
+    class?: string;
+};
+export type AutocompleteRawEvent = CustomEvent<{
+    target: HTMLElement | null;
+    searchKeyword: string;
+    isMultiple: boolean;
+    selectedOption: FuroAutocompleteOption | FuroAcceptableValue;
+    selectedOptions: Array<FuroAutocompleteOption | FuroAcceptableValue>;
+    selectedIndex: number;
+    selectedGroupIndex: number | null;
+}>;
+export type AutocompleteEmitPayloadParams = {
+    rawEvent: AutocompleteRawEvent;
+};
+export type AutocompleteEmitPayloadFactoryParams = AutocompleteEmitPayloadParams;
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js';
+import type * as Reka from 'reka-ui';