npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vue2-simple-menu

v3.5.0

Published

Simple context-menu component built for Vue. Works well with both left and right clicks. Nothing too fancy, just works and is simple to use.

Downloads

21

Readme

vue2-simple-menu

Simple context-menu (forked from vue-simple-context-menu) component built for Vue. Works well with both left and right clicks. Nothing too fancy, just works and is simple to use.

Demo

View demo

View on npm

View on GitHub

Install

# npm
npm i vue2-simple-menu

# yarn
yarn add vue2-simple-menu

Or you can include it through the browser at the bottom of your page along with the css:

<script src="https://unpkg.com/vue2-simple-menu/dist/vue2-simple-menu.min.js"></script>

<link rel="stylesheet" type="text/css" href="https://unpkg.com/vue2-simple-menu/dist/vue2-simple-menu.css">

About

Just a simple little menu to be shown where a click happens - closes after use automatically by clicking an option or outside of the menu. Multiple menus are supported.

A nice feature that comes baked in is the menu placement after a click - it sits just ever so slightly under your click location - so that any hover style you had on the item that was clicked gets removed nicely. I modeled it after the macOS right click menu.

Usage Example

<!-- css import for when you want to import the component css into your css file/files  -->
@import '/path/to/node_modules/vue2-simple-menu.css';

<!-- css import for when you're importing the css directly in your js  -->
import 'vue2-simple-menu/dist/vue2-simple-menu.css'

import Vue2SimpleMenu from 'vue2-simple-menu'
Vue.component('vue2-simple-menu', Vue2SimpleMenu)
<!-- This is a basic use case where you have an array of items that you want
to allow to be clicked. In this case, `items` is an array of objects.
Each item has a click event that ties to a function. See the demo for a full example (with multiple menus as well). -->

<div class="item-wrapper">
  <div v-for="item in items" @click.prevent.stop="handleClick($event, item)" class="item-wrapper__item">
    {{item.name}}
  </div>
</div>

<!-- Make sure you add the `ref` attribute, as that is what gives you the ability
to open the menu. -->

<vue2-simple-menu
  :options="options"
  :ref="'vueSimpleContextMenu'"
  @option-clicked="optionClicked"
/>

<!-- The click-handler function -->
handleClick (event, item) {
  this.$refs.vueSimpleContextMenu.showMenu(event, item)
}

<!-- And for capturing the event -->
optionClicked (event) {
  window.alert(JSON.stringify(event))
}

Note - you must pass the click event-info variable to the showMenu() function because that's how we know where to show the menu.

Note - make sure to use @click.prevent.stop (or @contextmenu.prevent.stop for right click) when setting up the click handler.

Props

| prop | type | description | required | |---------|-------|--------------------------------|---| | options | Array | Array of menu options to show. Component will use the name parameter as the label. | Yes | | options.name | Array | Label for the option. | Yes | | options.class | String | A custom class that will be applied to the option. | No | | options.type | String | Only one possible value at the moment - divider. Pass this to set the object as a divider. | No | | ref | String | Unique String that allows you to show the menu on command. | Yes |

Methods

| method | parameters | description | |---------|-------|--------------------------------| | showMenu |event (MouseEvent), item (Object) | Used to show the menu. Make sure to pass a MouseEvent and an Object. |

Events

| event | value | description | |---------|-------|--------------------------------| | option-clicked | Object | When a menu item is clicked the component will emit an event with a value containing the clicked item and the menu option that was clicked. Register for this event to capture the selection result. |

SASS Structure

.vue2-simple-menu {
  &--active {
  }

  &__item {
    &:hover {
    }
  }

  &__divider {}
}

Development

# install dependencies
npm install

# serve with hot reload
npm run watch

# run the tests
npm run test

# build demo page
npm run build:example

# build library
npm run build:library

# build everything and run tests
npm run build

Other

Go ahead and fork the project! Submit an issue if needed. Have fun!

Thank You

Influenced by John Datserakis . Go ahead and check out his other work.

License

MIT

Packaged with a mixture of vue-simple-context-menu, vue-lib-template and vue-sfc-rollup.