@numiko/dropdown-toggle
    Preparing search index...

    Type Alias DropdownOptions

    Options that are considered "public" and can be passed to the constructor.

    type DropdownOptions = {
        buttonLabelEl?: HTMLElement | string;
        closeLabel?: string;
        closeOnEsc?: boolean;
        closeOnFocusLeave?: boolean;
        closeOnOutsideClick?: boolean;
        closeOptions?: AnimationOptions;
        closeTween?: (
            dropdownItem: HTMLElement,
        ) => gsap.core.Timeline | gsap.core.Tween;
        group?: string;
        groupMode?: GroupMode;
        onCloseEnd?: (dropdownItem: HTMLElement) => void;
        onCloseStart?: (dropdownItem: HTMLElement) => void;
        onDestroy?: (dropdownItem: HTMLElement) => void;
        onOpenEnd?: (dropdownItem: HTMLElement) => void;
        onOpenStart?: (dropdownItem: HTMLElement) => void;
        openClass?: string;
        openLabel?: string;
        openOnLoad?: boolean;
        openOptions?: AnimationOptions;
        openTween?: (
            dropdownItem: HTMLElement,
        ) => gsap.core.Timeline | gsap.core.Tween;
    }
    Index

    Properties

    buttonLabelEl? closeLabel? closeOnEsc? closeOnFocusLeave? closeOnOutsideClick? closeOptions? closeTween? group? groupMode? onCloseEnd? onCloseStart? onDestroy? onOpenEnd? onOpenStart? openClass? openLabel? openOnLoad? openOptions? openTween?

    Properties

    buttonLabelEl?: HTMLElement | string

    The element to set for the label when the dropdown is open. This can be a valid CSS selector or an element.

    closeLabel?: string

    The text to set for the label when the dropdown is open.

    closeOnEsc?: boolean
    closeOnFocusLeave?: boolean
    closeOnOutsideClick?: boolean
    closeOptions?: AnimationOptions

    Options for the close animation.

    These are ignored if a custom tween is provided.

    closeTween?: (dropdownItem: HTMLElement) => gsap.core.Timeline | gsap.core.Tween
    group?: string
    groupMode?: GroupMode
    onCloseEnd?: (dropdownItem: HTMLElement) => void
    onCloseStart?: (dropdownItem: HTMLElement) => void
    onDestroy?: (dropdownItem: HTMLElement) => void
    onOpenEnd?: (dropdownItem: HTMLElement) => void
    onOpenStart?: (dropdownItem: HTMLElement) => void
    openClass?: string

    A space-separated list of classes to add to the button when the dropdown is open.

    openLabel?: string

    The text to set for the label when the dropdown is closed.

    openOnLoad?: boolean
    openOptions?: AnimationOptions

    Options for the open animation.

    These are ignored if a custom tween is provided.

    openTween?: (dropdownItem: HTMLElement) => gsap.core.Timeline | gsap.core.Tween

    Settings

    Member Visibility

    On This Page

    Properties