1+ [ ![ Build Status] ( https://dev.azure.com/prabhummurthy/float-menu/_apis/build/status/prabhuignoto.vue-float-menu?branchName=master )] ( https://dev.azure.com/prabhummurthy/float-menu/_build/latest?definitionId=9&branchName=master )
12[ ![ Maintainability] ( https://api.codeclimate.com/v1/badges/a591487451582a389126/maintainability )] ( https://codeclimate.com/github/prabhuignoto/float-menu/maintainability )
2- [ ![ Codacy Badge] ( https://app.codacy.com/project/badge/Grade/499d76a8a8904a628827f937c6b57268 )] ( https://www.codacy.com/manual/prabhuignoto/float-menu?utm_source=github.com& ; utm_medium=referral& ; utm_content=prabhuignoto/float-menu& ; utm_campaign=Badge_Grade )
33[ ![ DeepScan grade] ( https://deepscan.io/api/teams/10074/projects/13372/branches/223016/badge/grade.svg )] ( https://deepscan.io/dashboard#view=project&tid=10074&pid=13372&bid=223016 )
44[ ![ Language grade: JavaScript] ( https://img.shields.io/lgtm/grade/javascript/g/prabhuignoto/float-menu.svg?logo=lgtm&logoWidth=18 )] ( https://lgtm.com/projects/g/prabhuignoto/float-menu/context:javascript )
55![ Snyk Vulnerabilities for GitHub Repo] ( https://img.shields.io/snyk/vulnerabilities/github/prabhuignoto/float-menu )
1111
1212[ ![ Edit vue-float-menu] ( https://codesandbox.io/static/img/play-codesandbox.svg )] ( https://codesandbox.io/s/vue-float-menu-e09z4?fontsize=14&hidenavigation=1&theme=dark )
1313
14- ## Features
14+ < h2 > Features</ h2 >
1515
1616✅ ** Draggable Menu Handle** - Drag and easily place the menu anywhere on screen.
1717
2121
2222✅ ** Nested Menus** - Support for Nested menus.
2323
24+ <h2 >Table of Contents</h2 >
25+
26+ - [ ⚙ Installation] ( #-installation )
27+ - [ 🚀 Getting Started] ( #-getting-started )
28+ - [ Demo] ( #demo )
29+ - [ Props] ( #props )
30+ - [ Dimension] ( #dimension )
31+ - [ Position] ( #position )
32+ - [ Fixed position] ( #fixed-position )
33+ - [ Menu orientation] ( #menu-orientation )
34+ - [ Menu head dimension] ( #menu-head-dimension )
35+ - [ Populating Menu] ( #populating-menu )
36+ - [ on-select] ( #on-select )
37+ - [ Flip on edges] ( #flip-on-edges )
38+ - [ 🎨 Custom icon] ( #-custom-icon )
39+ - [ 🌈 Theme] ( #-theme )
40+ - [ ⚙ Build Setup] ( #-build-setup )
41+ - [ Contributing] ( #contributing )
42+ - [ 🔨 Built with] ( #-built-with )
43+ - [ Notes] ( #notes )
44+ - [ Meta] ( #meta )
45+
2446## ⚙ Installation
2547
2648``` sh
@@ -29,9 +51,9 @@ yarn install vue-float-menu
2951
3052## 🚀 Getting Started
3153
32- float-menu has some great defaults. Please check the props list for details on all available options.
54+ float-menu has some great defaults. Please check the [ props] ( #props ) section for all available options.
3355
34- The following snippet sets the default position of the menu as ` top left ` and default menu direction as ` bottom ` .
56+ Here is a basic example that sets the default position of the menu as ` top left ` and menu orientation to ` bottom ` .
3557
3658``` sh
3759< template>
@@ -86,7 +108,7 @@ export default {
86108< /script>
87109` ` `
88110
89- # # 📺 Demo
111+ # # Demo
90112
91113! [demo](./readme-assets/demo.gif)
92114
@@ -249,7 +271,7 @@ setting this prop `flips` the menu content on the right edges of the screen. Thi
249271
250272! [flip](./readme-assets/flip.png)
251273
252- # ## Custom icon
274+ # ## 🎨 Custom icon
253275
254276To customize the Menu Icon, simply pass any content in between the ` float-menu` tags. Here we render a custom icon.
255277
@@ -277,7 +299,7 @@ and here we render a text `Click` inside the Menu handle
277299
278300! [example2](./readme-assets/example2.png)
279301
280- # ## Theme
302+ # ## 🌈 Theme
281303
282304Customize the color schemes with the ` theme` prop.
283305
@@ -298,7 +320,7 @@ Customize the color schemes with the `theme` prop.
298320
299321! [theme](./readme-assets/theme.png)
300322
301- # # Build Setup
323+ # # ⚙ Build Setup
302324
303325` ` ` bash
304326# install dependencies
@@ -326,7 +348,7 @@ npm run rollup
326348
327349- [Vue.JS](vue) - The Component is written in Vue + [Typescript](typescript).
328350
329- # # 📄 Notes
351+ # # Notes
330352
331353- The project uses [vite](vite) instead of @vue/cli. I choose vite for speed and i also believe [vite](vite) will be the future.
332354
0 commit comments