@igloo-ui/action-menu
TypeScript icon, indicating that this package has built-in type declarations

1.5.8 • Public • Published

ActionMenu

This component is used to display a menu that will contain a list of menu options. The menu is dismissible if you click outside the dropdown.

Installation

To install @igloo-ui/action-menu in your project, you will need to run the following command using npm:

npm install @igloo-ui/action-menu

If you prefer Yarn, use the following command instead:

yarn add @igloo-ui/action-menu

Usage

Then to use the component in your code just import it!

Displaying an action menu

import ActionMenu from '@igloo-ui/action-menu';
import Button from '@igloo-ui/button';

<ActionMenu
  options={[
    {
      label: 'Add Item',
      value: 'add',
    },
    {
      label: 'Delete Item',
      value: 'delete',
      disabled: true,
    },
    {
      label: 'Copy Item',
      value: 'copy',
    },
  ]}
  renderReference={(refProps) => {
    return (
      <Button appearance="secondary" {...refProps}>
        Button
      </Button>
    );
  }}
/>;

Calling option events

import ActionMenu from '@igloo-ui/action-menu';
import Button from '@igloo-ui/button';

<ActionMenu
  options={[
    {
      label: 'Add Item',
      value: 'add',
      icon: <AddSolid size="medium" />,
      onClick: () => {
        alert('"Add Item" was clicked');
      },
    },
    {
      label: 'Delete Item',
      value: 'delete',
      icon: <Delete size="medium" />,
      onClick: () => {
        alert('"Delete Item" was clicked');
      },
      closeOnSelect: () => {
        // Put some condition here
        // It can also just be a boolean and not a function
        return false;
      },
    },
    {
      label: 'Copy Item',
      value: 'copy',
      icon: <Copy size="medium" />,
      onClick: () => {
        alert('"Copy Item" was clicked');
      },
    },
  ]}
  renderReference={(refProps) => {
    return (
      <Button appearance="secondary" {...refProps}>
        Button
      </Button>
    );
  }}
/>;

Readme

Keywords

none

Package Sidebar

Install

npm i @igloo-ui/action-menu

Weekly Downloads

245

Version

1.5.8

License

Apache-2.0

Unpacked Size

1.68 MB

Total Files

7

Last publish

Collaborators

  • infra.admin
  • franckgaudin