{"id":19555056,"url":"https://github.com/kanety/stimulus-menu","last_synced_at":"2025-04-26T22:32:12.066Z","repository":{"id":57123862,"uuid":"413025171","full_name":"kanety/stimulus-menu","owner":"kanety","description":null,"archived":false,"fork":false,"pushed_at":"2024-08-05T06:41:57.000Z","size":64,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-16T09:04:14.065Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kanety.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-03T08:55:57.000Z","updated_at":"2024-08-05T06:38:55.000Z","dependencies_parsed_at":"2024-06-26T06:27:09.758Z","dependency_job_id":"e056898b-540e-429e-8efe-34c94efca605","html_url":"https://github.com/kanety/stimulus-menu","commit_stats":{"total_commits":35,"total_committers":1,"mean_commits":35.0,"dds":0.0,"last_synced_commit":"42745f573e1a8422c595923e0d190a1f6fecfccd"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kanety%2Fstimulus-menu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kanety%2Fstimulus-menu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kanety%2Fstimulus-menu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kanety%2Fstimulus-menu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kanety","download_url":"https://codeload.github.com/kanety/stimulus-menu/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223153671,"owners_count":17096582,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T04:31:29.286Z","updated_at":"2024-11-11T04:31:33.156Z","avatar_url":"https://github.com/kanety.png","language":"JavaScript","readme":"# stimulus-menu\n\nA stimulus controller for simple menu.\n\n## Dependencies\n\n* @hotwired/stimulus 3.0+\n\n## Installation\n\nInstall from npm:\n\n    $ npm install @kanety/stimulus-menu --save\n\n## Usage\n\nRegister controller:\n\n```javascript\nimport { Application } from '@hotwired/stimulus';\nimport MenuController from '@kanety/stimulus-menu';\n\nconst application = Application.start();\napplication.register('menu', MenuController);\n```\n\nImport css:\n\n```css\n@import '@kanety/stimulus-menu';\n```\n\nBuild html as follows:\n\n```html\n\u003cul class=\"st-menu st-menu--horizontal\" data-controller=\"menu\"\u003e\n  \u003cli\u003e\n    \u003cspan class=\"st-menu__icon\"\u003e\u003ca href=\"#\"\u003eMenu1\u003c/a\u003e\u003c/span\u003e\n    \u003cul class=\"st-menu--vertical\"\u003e\n      \u003cli\u003e\u003ca href=\"#\"\u003eMenu1-1\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#\"\u003eMenu1-2\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#\"\u003eMenu1-3\u003c/a\u003e\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/li\u003e\n  \u003cli\u003e\n    \u003cspan class=\"st-menu__icon\"\u003e\u003ca href=\"#\"\u003eMenu2\u003c/a\u003e\u003c/span\u003e\n    \u003cul class=\"st-menu--vertical\"\u003e\n      \u003cli\u003e\u003ca href=\"#\"\u003eMenu2-1\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#\"\u003eMenu2-2\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#\"\u003eMenu2-3\u003c/a\u003e\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/li\u003e\n\u003c/ul\u003e\n```\n\nYou can also build vertical menu as follows:\n\n```html\n\u003c!-- set st-menu--vertial --\u003e\n\u003cul class=\"st-menu st-menu--vertical\" data-controller=\"menu\"\u003e\n  \u003cli\u003e\n    \u003cspan class=\"st-menu__icon\"\u003e\u003ca href=\"#\"\u003eMenu1\u003c/a\u003e\u003c/span\u003e\n    \u003cul class=\"st-menu--vertical\"\u003e\n      \u003cli\u003e\u003ca href=\"#\"\u003eMenu1-1\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#\"\u003eMenu1-2\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#\"\u003eMenu1-3\u003c/a\u003e\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/li\u003e\n  \u003cli\u003e\n    \u003cspan class=\"st-menu__icon\"\u003e\u003ca href=\"#\"\u003eMenu2\u003c/a\u003e\u003c/span\u003e\n    \u003cul class=\"st-menu--vertical\"\u003e\n      \u003cli\u003e\u003ca href=\"#\"\u003eMenu2-1\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#\"\u003eMenu2-2\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#\"\u003eMenu2-3\u003c/a\u003e\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/li\u003e\n\u003c/ul\u003e\n```\n\n### Options\n\n#### auto-open\n\nOpen menu by mouse hovering:\n\n```javascript\n\u003cul data-controller=\"menu\"\n    data-menu-auto-open-value=\"true\"\u003e\n\u003c/ul\u003e\n```\n\n#### keep-open\n\nKeep menu opened after clicking menu items:\n\n```javascript\n\u003cul data-controller=\"menu\"\n    data-menu-keep-open-value=\"true\"\u003e\n\u003c/ul\u003e\n```\n\n#### toggle-element\n\nYou can change toggle element (default is `a`). For example:\n\n```javascript\n\u003cul data-controller=\"menu\"\n    data-menu-toggle-element-value=\"button\"\u003e\n  \u003cli\u003e\u003cbutton type=\"button\"\u003eButton\u003c/button\u003e\u003c/li\u003e\n\u003c/ul\u003e\n```\n\n### Callbacks\n\nSet callbacks fired when a menu item is opened / closed:\n\n```javascript\nlet element = document.querySelector('[data-controller=\"menu\"]');\nelement.addEventListener('menu:opened', (e) =\u003e {\n  console.log('opened: ' + e.detail.item.querySelector('a').href);\n});\nelement.addEventListener('menu:closed', (e) =\u003e {\n  console.log('closed: ' + e.detail.item.querySelector('a').href);\n});\n```\n\n## License\n\nThe library is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkanety%2Fstimulus-menu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkanety%2Fstimulus-menu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkanety%2Fstimulus-menu/lists"}