diff --git a/README.md b/README.md index 9dec7ee..8dc145b 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,82 @@ 右键菜单组件 demo ## 安装 -``` -npm install @gahing/vcontextmenu +```sh +npm install @gahing/vcontextmenu # yarn add @gahing/vcontextmenu ``` ## 在线demo -[vcontextmenu](https://francecil.github.io/vue-contextmenu/) +[demo](https://francecil.github.io/vue-contextmenu/) ## 使用 + +如果是用 vue-cli3 构建的,可以利用 [vue-cli-plugin-contextmenu](https://github.com/francecil/vue-cli-plugin-contextmenu) +```sh +vue add contextmenu +``` + +手动注册: ```js import ContextMenu from '@gahing/vcontextmenu' import '@gahing/vcontextmenu/lib/vcontextmenu.css' Vue.use(ContextMenu) +// or +import { ContextMenu } from '@gahing/vcontextmenu' +import '@gahing/vcontextmenu/lib/vcontextmenu.css' +Vue.component(ContextMenu.name, ContextMenu); // 可以在这里定义自己的组件名 ``` -或者采用 [vue-cli-plugin-contextmenu](https://github.com/francecil/vue-cli-plugin-contextmenu) + +### demo + +```html + + +``` + +## 开发 + ```sh -vue add contextmenu +npm start ``` +## 构建 +```sh +# 构建demo +npm run build:demo +# 源码打包,生成lib目录 +npm run build:lib +``` \ No newline at end of file