{"_id":"@craydel/craydel-sidebar-menu","_rev":"1-42a2be83ea19c4fbe8c1bd5b76edd2d1","name":"@craydel/craydel-sidebar-menu","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@craydel/craydel-sidebar-menu","version":"1.0.0","description":"A custom Vuetify sidebar menu component for Craydel.","author":{"name":"Wasim Al-Haddad"},"keywords":["vuetify","sidebar","menu","vue","nuxt"],"publishConfig":{"access":"public"},"gitHead":"3668af05beca36d618dc087e8459240f8e107dbf","_id":"@craydel/craydel-sidebar-menu@1.0.0","_nodeVersion":"16.14.0","_npmVersion":"lerna/7.3.0/node@v16.14.0+x64 (win32)","dist":{"integrity":"sha512-pgcElaqT8ewcF/e+dB2z1ovE5RSFalajkIPK4QHimMctwdkV/sANg5aqCnSyVIEMBuSRhC3x2KcztVm8aiQ5vA==","shasum":"f938f104ab0cfdaf3616b07540dc2a21afb54f6c","tarball":"https://registry.npmjs.org/@craydel/craydel-sidebar-menu/-/craydel-sidebar-menu-1.0.0.tgz","fileCount":4,"unpackedSize":8487,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFNVgDhSbTzs8vY8oU+3rspbDPxeAhENR6GRry/mnmr3AiBVJ3dK38BlutTHcfPiflGxeKLfx2NiEQdKCv/AiXogxQ=="}]},"_npmUser":{"name":"sayedwasim","email":"wasimalhaddad@gmail.com"},"directories":{},"maintainers":[{"name":"sayedwasim","email":"wasimalhaddad@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/craydel-sidebar-menu_1.0.0_1695201942583_0.3333410973679687"},"_hasShrinkwrap":false},"1.0.1":{"name":"@craydel/craydel-sidebar-menu","version":"1.0.1","description":"A custom Vuetify sidebar menu component for Craydel.","author":{"name":"Wasim Al-Haddad"},"license":"MIT","keywords":["vuetify","sidebar","menu","vue","nuxt"],"publishConfig":{"access":"public"},"gitHead":"dcab0c7dceab40486e8eab7a571b75fdce0e93e5","_id":"@craydel/craydel-sidebar-menu@1.0.1","_nodeVersion":"16.14.0","_npmVersion":"lerna/7.3.0/node@v16.14.0+x64 (win32)","dist":{"integrity":"sha512-6XpidFSPo/SD/RlUVA4WL2FTdX0/ScDNDzcfvSeMQ/pcSXf96jaU4Kn27uETSRwjZ0S1qoPpI7y0pz6ehYFycA==","shasum":"d15cb055523f8ddc951597210cbc4351ef65314b","tarball":"https://registry.npmjs.org/@craydel/craydel-sidebar-menu/-/craydel-sidebar-menu-1.0.1.tgz","fileCount":5,"unpackedSize":9560,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIF5pgrm09vymqToOL7C/RuoJxue3qvIccg0GZFlx6F0cAiEA7/y5gH8CQp2eL5U32y/h+P1Nr+8A4mQey0VXkXNX0cs="}]},"_npmUser":{"name":"sayedwasim","email":"wasimalhaddad@gmail.com"},"directories":{},"maintainers":[{"name":"sayedwasim","email":"wasimalhaddad@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/craydel-sidebar-menu_1.0.1_1695211465270_0.5349800767696629"},"_hasShrinkwrap":false}},"time":{"created":"2023-09-20T09:25:42.479Z","1.0.0":"2023-09-20T09:25:42.821Z","modified":"2023-09-20T12:04:25.693Z","1.0.1":"2023-09-20T12:04:25.483Z"},"maintainers":[{"name":"sayedwasim","email":"wasimalhaddad@gmail.com"}],"description":"A custom Vuetify sidebar menu component for Craydel.","keywords":["vuetify","sidebar","menu","vue","nuxt"],"author":{"name":"Wasim Al-Haddad"},"readme":"# CraydelSidebarMenu\n\n## Installation\n\nGet the latest version by NPM:\n\n```bash\n$ npm i @craydel/craydel-sidebar-menu\n```\n\n## Register Plugin\n\nIf you use the plugin API, the component will be registered as a global component just like when\nincluding it with the script tag, but you won't need to re-register it through the `components` property in your own\ncomponents.\n\nCreate the plugin file e.g `craydel-components.js` file.\n\n```javascript\n// craydel-components.js\nimport Vue from 'vue'\nimport CraydelSidebarMenu from '@craydel/craydel-sidebar-menu/src/CraydelSidebarMenu.vue'\n\nconst Components = {\n CraydelSidebarMenu,\n};\n\nObject.keys(Components).forEach(name => {\n Vue.component(name, Components[name]);\n});\n\nexport default Components;\n```\n\nNext reference the plugin file in your nuxt.config.js\n\n```javascript\n// Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins\nplugins: [\n '~/plugins/craydel-components.js'\n]\n```\n\n## Props\n\n| Name | Type | Default | Description |\n|------------|---------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| show-menu | boolean | false | Controls whether the component is visible or hidden. |\n| menu-items | array | [] | Array of objects that will look for the keys **text**, **icon** (mdi icons), **link**, **target** (default href target options) and if required **sub_menu** array with **text** and **link** keys. |\n\n \n\n## Events\n\n| Name | Description |\n|----------|:---------------------------------|\n| hideMenu | Emitted when the menu is closed. |\n\n \n\n## Slots\n\n| Name | Description |\n|---------|:----------------------------------------------------------------------------------|\n| header | A slot at the top of the menu. |\n| default | The default Vue slot. Used for any content that will appear after the menu items. |\n\n \n\n## Usage\n\nAn example showing a sidebar menu. The sidebar menu has a header and default slot that is visible only on mobile.\n\n```html\nOpen menu\n\n\n \n\n
© Copyright 2023. All Rights Reserved.
\n\n```\n\n```javascript\ndata()\n{\n return {\n show_menu: false,\n menu_items: [\n {\n text: 'Home',\n icon: 'mdi-home',\n link: '/',\n },\n {\n text: 'About Us',\n icon: 'mdi-account-group',\n link: '',\n sub_menu: [\n {\n text: 'Our Team',\n link: '#'\n },\n {\n text: 'Our History',\n link: '#'\n }\n ]\n },\n {\n text: 'Contacts',\n icon: 'mdi-phone',\n link: '/contacts',\n target: '_blank'\n },\n ]\n }\n}\n```","readmeFilename":"README.md","license":"MIT"}