Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

wx-svelte-menu

svar-widgets15.6kMIT2.1.1

Svelte menu component for creating dropdown menus, context menus, or complex menu bars

svelte, svelte menu, menu, menu component, svelte component, menubar, menu bar, context menu, dropdown, dropdown menu, svar widgets

readme

SVAR Svelte Menu

npm License npm downloads

SVAR Menu is a ready to use Svelte component for creating context and popup menus. Easily customize each menu item with text, icons, and sub-items, and control the menu's position relative to its parent element.

How to Use

To use SVAR Svelte Menu, simply import the package and include the component in your Svelte file:

<script>
    import { Menu } from "wx-svelte-menu";

    function onClick(item) {
        const action = ev.detail.action;
        message = action ? `clicked on ${action.id}` : "closed";
    }

    const options = [
        { id: "edit-cut", text: "Cut", icon: "wxi wxi-content-cut" },
        { id: "edit-copy", text: "Copy", icon: "wxi wxi-content-copy" },
        {
            id: "edit-paste",
            text: "Paste",
            icon: "wxi wxi-content-paste",
        },
    ];
</script>

<Menu {options} on:click={clicked} />

For more details, visit the documentation.

How to Modify

Typically, you don't need to modify the code. However, if you wish to do so, follow these steps:

  1. Run yarn to install dependencies. Note that this project is a monorepo using yarn workspaces, so npm will not work
  2. Start the project in development mode with yarn start

Run Tests

To run the test:

  1. Start the test examples with:
     yarn start:tests
  2. In a separate console, run the end-to-end tests with:
     yarn test:cypress

Need Help?

Join our community forum to get help or post feature requests.