taga11y - v0.1.0
    Preparing search index...

    Interface Taga11yOptions

    interface Taga11yOptions {
        debounceMs?: number;
        delimiter?: string | string[];
        deserialize?: (raw: string) => SuggestionItem[];
        disabled?: boolean;
        enforceSuggestions?: boolean;
        i18n?: I18nOptions;
        label?: string;
        maxTags?: number;
        name?: string;
        serialize?: (tags: TagData[]) => string;
        suggestions?: SuggestionsSource;
        theme?: "dark" | "light" | null;
    }
    Index

    Properties

    debounceMs?: number

    Debounce delay in milliseconds for dynamic suggestion requests. Default: 200. Only applies to dynamic ({ query }) mode.

    delimiter?: string | string[]

    Characters that trigger tag commit when typed. Defaults to [, Enter]. Accepts a single character/string or an array.

    deserialize?: (raw: string) => SuggestionItem[]

    Custom deserializer for the original input's value on init and on form reset. Pairs with serialize to enable round-tripping a custom format. Returns the same SuggestionItem shape suggestions accepts: plain strings resolve labels from loaded suggestions (falling back to label === value); { label, value } objects are used as-is. Defaults to splitting on ",", trimming, and dropping empties.

    disabled?: boolean

    When true, the component is rendered in a disabled state.

    enforceSuggestions?: boolean

    When true, only suggestions from the source can be committed. Free-text entry is rejected with an error.

    Internationalisation: locale, optional direction, and partial string overrides. Init-only — ignored by settings(). Omit for built-in English with no lang/dir on the wrapper.

    label?: string

    Optional visible label rendered above the component.

    maxTags?: number

    Maximum number of tags the user can select. Undefined means no limit.

    name?: string

    Name attribute for the hidden form input. Defaults to the original input's name attribute.

    serialize?: (tags: TagData[]) => string

    Custom serializer for the hidden input value. Receives the current tag array and returns a string. Defaults to comma-joining values.

    suggestions?: SuggestionsSource

    Suggestion source: static array, pre-fetched async, or dynamic callback. Omit for free-text mode with no suggestions.

    theme?: "dark" | "light" | null

    Forced theme override. null (default) follows the OS preference. Use "dark" or "light" to override regardless of OS setting.