carbon-components-svelte/types/OverflowMenu/OverflowMenu.d.ts

/// <reference types="svelte" />

export default class OverflowMenu {
  $$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["button"]> & {
    /**
     * Specify the size of the overflow menu
     */
    size?: "sm" | "xl";

    /**
     * Specify the direction of the overflow menu relative to the button
     * @default "bottom"
     */
    direction?: "top" | "bottom";

    /**
     * Set to `true` to open the menu
     * @default false
     */
    open?: boolean;

    /**
     * Set to `true` to enable the light variant
     * @default false
     */
    light?: boolean;

    /**
     * Set to `true` to flip the menu relative to the button
     * @default false
     */
    flipped?: boolean;

    /**
     * Specify the menu options class
     */
    menuOptionsClass?: string;

    /**
     * Specify the icon from `carbon-icons-svelte` to render
     */
    icon?: typeof import("carbon-icons-svelte/lib/Add16").default;

    /**
     * Specify the icon class
     */
    iconClass?: string;

    /**
     * Specify the ARIA label for the icon
     * @default "Open and close list of options"
     */
    iconDescription?: string;

    /**
     * Set an id for the button element
     */
    id?: string;

    /**
     * Obtain a reference to the trigger button element
     * @default null
     */
    buttonRef?: null | HTMLButtonElement;

    /**
     * Obtain a reference to the overflow menu element
     * @default null
     */
    menuRef?: null | HTMLUListElement;
  };

  $$slot_def: {
    default: {};
    menu: {};
  };

  $on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
  $on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
  $on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
  $on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
  $on(eventname: "keydown", cb: (event: WindowEventMap["keydown"]) => void): () => void;
  $on(eventname: "close", cb: (event: CustomEvent<any>) => void): () => void;
  $on(eventname: string, cb: (event: Event) => void): () => void;
}