Merge pull request #49 from johndatserakis/jd-tidy-before-v-4

Tidy before merge
johndatserakis · Mar 20, 2022 · 68a8fc2 · 68a8fc2
2 parents ad7ef5e + e8704b2
commit 68a8fc2
Show file tree

Hide file tree

Showing 24 changed files with 8,232 additions and 23,342 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -1,14 +1,12 @@
-# editorconfig.org
-
 root = true
 
 [*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
 charset = utf-8
-trim_trailing_whitespace = true
+end_of_line = lf
+indent_size = 2
+indent_style = space
 insert_final_newline = true
+trim_trailing_whitespace = true
 
 [*.md]
 trim_trailing_whitespace = false
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,8 @@
+{
+  "printWidth": 100,
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "useTabs": false
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # CHANGELOG.md
 
+## 4.0.0
+
+- Upgrade package to support Vue 3. Vue 2 support can be found at `v3.4.2`. Thank you @danielelkington.
+
+## 3.4.2
+
+- Add menu-closed event. Thank you @rttmax.
+
 ## 3.4.1
 
 - Add support for HTML content in `option.name`. Thank you @mikeerickson.

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Promosis, Inc.
+Copyright (c) 2018 John Datserakis, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -10,21 +10,15 @@ Simple context-menu component built for Vue. Works well with both left and right
   <img src="https://img.shields.io/twitter/url/https/github.com/johndatserakis/vue-simple-context-menu.svg?style=social" alt="Tweet"></a>
 </p>
 
-### Demo
+[View Demo](https://johndatserakis.github.io/vue-simple-context-menu/) | [GitHub](https://github.com/johndatserakis/vue-simple-context-menu) | [npm](https://www.npmjs.com/package/vue-simple-context-menu)
 
-[View demo](https://johndatserakis.github.io/vue-simple-context-menu/)
+## Vue 3 Support
 
-[View on npm](https://www.npmjs.com/package/vue-simple-context-menu)
+Vue 3 is supported from `v4.0.0` and beyond (current `master`). To use `vue-simple-context-menu` with Vue 2, use `v3.4.2`.
 
-[View on GitHub](https://github.com/johndatserakis/vue-simple-context-menu)
-
-### Install
+## Install
 
 ```
-# npm
-npm i vue-simple-context-menu
-
-# yarn
 yarn add vue-simple-context-menu
 ```
 
@@ -40,25 +34,25 @@ Or you can include it through the browser at the bottom of your page along with
 />
 ```
 
-### About
+## 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 - just make sure to use a unique string as your `elementId` prop value.
+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 - just make sure to use a unique string as your `element-id` prop value.
 
 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
+## Usage Example
 
 ```css
-/* css import for when you want to import the component css into your css file/files */
-@import "/path/to/node_modules/vue-simple-context-menu.css";
+/* CSS import for when you want to import the component CSS into your CSS file/files */
+@import '/path/to/node_modules/vue-simple-context-menu.css';
 ```
 
 ```js
-// css import for when you're importing the css directly in your js
-import "vue-simple-context-menu/dist/vue-simple-context-menu.css";
-import VueSimpleContextMenu from "vue-simple-context-menu";
+// CSS import for when you're importing the CSS directly in your JS
+import 'vue-simple-context-menu/dist/vue-simple-context-menu.css';
+import VueSimpleContextMenu from 'vue-simple-context-menu';
 
-Vue.component("vue-simple-context-menu", VueSimpleContextMenu);
+Vue.component('vue-simple-context-menu', VueSimpleContextMenu);
 ```
 
 ```html
@@ -78,9 +72,9 @@ Each item has a click event that ties to a function. See the demo for a full exa
 <!-- Make sure you add the `ref` attribute, as that is what gives you the ability
 to open the menu. -->
 <vue-simple-context-menu
-  :elementId="'myUniqueId'"
+  element-id="myUniqueId"
   :options="options"
-  :ref="'vueSimpleContextMenu'"
+  ref="vueSimpleContextMenu"
   @option-clicked="optionClicked"
 />
 ```
@@ -100,31 +94,31 @@ Note - you must pass the click event-info variable to the `showMenu()` function
 
 Note - make sure to use `@click.prevent.stop` (or `@contextmenu.prevent.stop` for right click) when setting up the click handler.
 
-### Props
+## Props
 
 | prop            | type   | description                                                                                  | required |
 | --------------- | ------ | -------------------------------------------------------------------------------------------- | -------- |
 | `elementId`     | String | Unique String that acts as the id of your menu.                                              | Yes      |
 | `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.name`  | String | 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
+## Methods
 
 | method     | parameters                        | description                                                          |
 | ---------- | --------------------------------- | -------------------------------------------------------------------- |
 | `showMenu` | event (MouseEvent), item (Object) | Used to show the menu. Make sure to pass a MouseEvent and an Object. |
 
-### Events
+## 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. |
 | `menu-closed`    |        | Emitted when the menu is closed                                                                                                                                                                      |
 
-### SASS Structure
+## SASS Structure
 
 ```scss
 .vue-simple-context-menu {
@@ -141,38 +135,36 @@ Note - make sure to use `@click.prevent.stop` (or `@contextmenu.prevent.stop` fo
 }
 ```
 
-### Development
+## Development
 
 ```bash
-# install dependencies
-npm install
+# Install dependencies
+yarn
 
-# serve with hot reload
-npm run watch
+# Serve with hot reload
+yarn watch
 
-# run the tests
-npm run test
+# Run the tests
+yarn test
 
-# build demo page
-npm run build:example
+# Build demo page
+yarn build:example
 
-# build library
-npm run build:library
+# Build library
+yarn build:library
 
-# build everything and run tests
-npm run build
+# Build everything and run tests
+yarn build
 ```
 
-### Other
+## Other
 
 Go ahead and fork the project! Submit an issue if needed. Have fun!
 
-### Thank You
+## Thank You
 
 Influenced by [Lucas Calazans](https://codepen.io/lucascalazans)'s [pen](https://codepen.io/lucascalazans/pen/ALvVVw). Go ahead and check out his other work.
 
-### License
+## License
 
 [MIT](http://opensource.org/licenses/MIT)
-
-Packaged with a mixture of [vue-lib-template](https://github.com/biigpongsatorn/vue-lib-template) and [vue-sfc-rollup](https://github.com/team-innovation/vue-sfc-rollup).
diff --git a/dist/vue-simple-context-menu.css b/dist/vue-simple-context-menu.css
@@ -1,38 +1,38 @@
 .vue-simple-context-menu {
-  top: 0;
+  background-color: #ecf0f1;
+  border-bottom-width: 0px;
+  border-radius: 4px;
+  box-shadow: 0 3px 6px 0 rgba(51, 51, 51, 0.2);
+  display: none;
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif;
   left: 0;
+  list-style: none;
   margin: 0;
   padding: 0;
-  display: none;
-  list-style: none;
   position: absolute;
+  top: 0;
   z-index: 1000000;
-  background-color: #ecf0f1;
-  border-bottom-width: 0px;
-  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif;
-  box-shadow: 0 3px 6px 0 rgba(51, 51, 51, 0.2);
-  border-radius: 4px;
 }
 .vue-simple-context-menu--active {
   display: block;
 }
 .vue-simple-context-menu__item {
-  display: flex;
+  align-items: center;
   color: #333;
   cursor: pointer;
+  display: flex;
   padding: 5px 15px;
-  align-items: center;
 }
 .vue-simple-context-menu__item:hover {
   background-color: #007aff;
   color: #fff;
 }
 .vue-simple-context-menu__divider {
+  background-clip: content-box;
+  background-color: #c0cdd1;
   box-sizing: content-box;
   height: 2px;
-  background-color: #c0cdd1;
   padding: 4px 0;
-  background-clip: content-box;
   pointer-events: none;
 }
 .vue-simple-context-menu li:first-of-type {