ChatiumFor developersPlaygroundPricing
Sign in

Dropdown

Properties

  • input (any):
    The element used to display a button or area that, when clicked, reveals the contents of the Dropdown.
  • popupDirection (['left' | 'right', 'up' | 'down']):
    Determines the direction in which the content will expand. Both horizontal and vertical directions can be specified (e.g., ['right', 'down']). If not specified, the direction is calculated automatically based on the available space on the screen.
  • onOutsideClick:
    A handler that is called when the user clicks outside the dropdown. Typically used to hide the Dropdown.
  • onShow:
    A handler function that is called when the dropdown is opened.
  • onHide:
    A handler function that is called when the dropdown is hidden.
  • style (JSX.CSSProperties):
    Inline styles for the main container of the Dropdown.
  • ref (Ref<DropdownRefMethods>):
    A reference to methods for controlling the component (e.g., programmatically opening and closing).

Events

  • overflowHandler:
    A click handler for the area outside the dropdown. Hides the Dropdown and calls the onOutsideClick handler.
  • componentMethods:
    An object containing methods for managing the visibility of the Dropdown. Includes methods hide(), show(), and dropdownVisible() for programmatic control over the component.
  • dispatchDropDownHideEvent:
    A function for programmatically hiding the dropdown. It dispatches a custom event dropdownHide, which the component handles to hide the content.

Methods DropdownRefMethods

  • hide(): Programmatically hides the Dropdown.
  • show(): Programmatically opens the Dropdown.
  • dropdownVisible(): Returns the current visibility state of the dropdown (open or closed).