accessible-menu-bootstrap-5
Advanced tools
Comparing version 1.0.2 to 2.0.0-beta.0
import Bootstrap5DisclosureMenu from "./src/bootstrap5DisclosureMenu.js"; | ||
import Bootstrap5Menubar from "./src/bootstrap5Menubar.js"; | ||
import Bootstrap5TopLinkDisclosureMenu from "./src/bootstrap5TopLinkDisclosureMenu.js"; | ||
import Bootstrap5Treeview from "./src/bootstrap5Treeview.js"; | ||
@@ -8,5 +9,7 @@ | ||
const treeview = Bootstrap5Treeview; | ||
const topLinkDisclosureMenu = Bootstrap5TopLinkDisclosureMenu; | ||
export { disclosureMenu as Bootstrap5DisclosureMenu }; | ||
export { menubar as Bootstrap5Menubar }; | ||
export { topLinkDisclosureMenu as Bootstrap5TopLinkDisclosureMenu }; | ||
export { treeview as Bootstrap5Treeview }; | ||
@@ -16,3 +19,4 @@ export default { | ||
Bootstrap5Menubar, | ||
Bootstrap5TopLinkDisclosureMenu, | ||
Bootstrap5Treeview, | ||
}; |
{ | ||
"name": "accessible-menu-bootstrap-5", | ||
"version": "1.0.2", | ||
"version": "2.0.0-beta.0", | ||
"description": "A JavaScript library to help you generate WAI-ARIA accessible menus with in the DOM using Bootstrap 5.", | ||
@@ -17,8 +17,16 @@ "main": "index.js", | ||
"prettier": "prettier '**/*.js' --ignore-path .eslintignore", | ||
"prerelease": "npm run lint && npm run build && npm test", | ||
"prerelease": "npm run lint && npm run build && npm run test:run", | ||
"release": "git add dist/. && standard-version -a", | ||
"prebuild": "npm run build:docs", | ||
"build": "rollup --config .rollup.config.js", | ||
"build": "npm run build:default; npm run build:disclosure-menu; npm run build:menubar; npm run build:top-link-disclosure-menu; npm run build:treeview", | ||
"build:docs": "jsdoc -c jsdoc.config.js", | ||
"test": "jest" | ||
"build:default": "BUILD_TYPE=default vite build", | ||
"build:disclosure-menu": "BUILD_TYPE=DisclosureMenu vite build", | ||
"build:menubar": "BUILD_TYPE=Menubar vite build", | ||
"build:top-link-disclosure-menu": "BUILD_TYPE=TopLinkDisclosureMenu vite build", | ||
"build:treeview": "BUILD_TYPE=Treeview vite build", | ||
"dev": "vite", | ||
"test": "vitest", | ||
"test:ui": "vitest --ui", | ||
"test:run": "vitest run" | ||
}, | ||
@@ -49,6 +57,5 @@ "repository": { | ||
"dependencies": { | ||
"accessible-menu": "^3.0.4" | ||
"accessible-menu": "^4.0.0-beta.0" | ||
}, | ||
"devDependencies": { | ||
"@babel/cli": "^7.12.1", | ||
"@babel/core": "^7.12.3", | ||
@@ -59,4 +66,3 @@ "@babel/eslint-parser": "^7.14.7", | ||
"@commitlint/config-conventional": "^17.0.0", | ||
"@rollup/plugin-babel": "^6.0.0", | ||
"@rollup/plugin-node-resolve": "^15.0.0", | ||
"@vitest/ui": "^0.28.5", | ||
"commitizen": "^4.2.2", | ||
@@ -67,20 +73,15 @@ "cz-conventional-changelog": "^3.3.0", | ||
"eslint-config-standard": "^16.0.1", | ||
"eslint-plugin-import": "^2.22.1", | ||
"eslint-plugin-jsdoc": "^40.0.0", | ||
"eslint-plugin-node": "^11.1.0", | ||
"eslint-plugin-promise": "^5.1.0", | ||
"husky": "^8.0.1", | ||
"jest": "^29.0.0", | ||
"jest-environment-jsdom": "^29.0.0", | ||
"jest-extended": "^3.0.0", | ||
"jsdoc": "^4.0.0", | ||
"jsdoc-typeof-plugin": "^1.0.0", | ||
"jsdom": "^21.1.0", | ||
"lint-staged": "^13.0.1", | ||
"prettier": "^2.1.2", | ||
"rollup": "^2.33.1", | ||
"rollup-plugin-cleanup": "^3.2.1", | ||
"rollup-plugin-terser": "^7.0.2", | ||
"sass": "^1.58.2", | ||
"standard-version": "^9.0.0", | ||
"terser": "^5.6.1" | ||
"vite": "^4.1.2", | ||
"vite-plugin-browser-sync": "^1.0.2", | ||
"vitest": "^0.28.5" | ||
} | ||
} |
@@ -15,2 +15,3 @@ # accessible-menu-bootstrap-5 | ||
- [Disclosure Navigation Menus](https://www.w3.org/WAI/ARIA/apg/patterns/disclosure/examples/disclosure-navigation/), | ||
- [Disclosure Navigation Menus with Top-Level Links](https://www.w3.org/WAI/ARIA/apg/patterns/disclosure/examples/disclosure-navigation-hybrid/), | ||
- [Navigation Menubar](https://www.w3.org/WAI/ARIA/apg/patterns/menubar/examples/menubar-navigation/), and | ||
@@ -49,3 +50,3 @@ - [Navigation Treeview](https://www.w3.org/WAI/ARIA/apg/patterns/treeview/examples/treeview-navigation/) | ||
```html | ||
<script src="https://cdn.jsdelivr.net/npm/accessible-menu-bootstrap-5@1.0.2/dist/accessible-menu-bs5.min.js"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/accessible-menu-bootstrap-5@2.0.0-beta.0/dist/accessible-menu-bs5.min.js"></script> | ||
``` | ||
@@ -80,3 +81,3 @@ | ||
```html | ||
<script src="https://cdn.jsdelivr.net/npm/accessible-menu-bootstrap-5@1.0.2/dist/accessible-menu-bs5.min.js"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/accessible-menu-bootstrap-5@2.0.0-beta.0/dist/accessible-menu-bs5.min.js"></script> | ||
``` | ||
@@ -109,3 +110,3 @@ | ||
```html | ||
<script src="https://cdn.jsdelivr.net/npm/accessible-menu-bootstrap-5@1.0.2/dist/disclosure-menu-bs5.min.js"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/accessible-menu-bootstrap-5@2.0.0-beta.0/dist/disclosure-menu-bs5.min.js"></script> | ||
``` | ||
@@ -130,3 +131,3 @@ | ||
```html | ||
<script src="https://cdn.jsdelivr.net/npm/accessible-menu-bootstrap-5@1.0.2/dist/menubar-bs5.min.js"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/accessible-menu-bootstrap-5@2.0.0-beta.0/dist/menubar-bs5.min.js"></script> | ||
``` | ||
@@ -142,2 +143,22 @@ | ||
#### Bootstrap5TopLinkDisclosureMenu usage | ||
```js | ||
import { Bootstrap5TopLinkDisclosureMenu } from "accessible-menu"; | ||
``` | ||
or | ||
```html | ||
<script src="https://cdn.jsdelivr.net/npm/accessible-menu@4.0.0-beta.0/dist/top-link-disclosure-menu-bs5.min.js"></script> | ||
``` | ||
then | ||
```js | ||
const menu = new Bootstrap5TopLinkDisclosureMenu({ | ||
menuElement: document.querySelector("#example-menu"), | ||
}); | ||
``` | ||
#### Bootstrap5Treeview usage | ||
@@ -152,3 +173,3 @@ | ||
```html | ||
<script src="https://cdn.jsdelivr.net/npm/accessible-menu-bootstrap-5@1.0.2/dist/treeview-bs5.min.js"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/accessible-menu-bootstrap-5@2.0.0-beta.0/dist/treeview-bs5.min.js"></script> | ||
``` | ||
@@ -155,0 +176,0 @@ |
@@ -17,2 +17,3 @@ import DisclosureMenu from "accessible-menu/src/disclosureMenu.js"; | ||
* @type {typeof Bootstrap5DisclosureMenu} | ||
* | ||
* @protected | ||
@@ -26,2 +27,3 @@ */ | ||
* @type {typeof Bootstrap5DisclosureMenuItem} | ||
* | ||
* @protected | ||
@@ -35,2 +37,3 @@ */ | ||
* @type {typeof Bootstrap5DisclosureMenuToggle} | ||
* | ||
* @protected | ||
@@ -37,0 +40,0 @@ */ |
@@ -13,2 +13,3 @@ /* eslint-disable jsdoc/no-undefined-types */ | ||
* @type {Object<HTMLElement>} | ||
* | ||
* @property {HTMLElement} toggle - The menu toggle. | ||
@@ -15,0 +16,0 @@ * @property {HTMLElement} parent - The menu containing this toggle. |
@@ -15,2 +15,3 @@ import Menubar from "accessible-menu/src/menubar.js"; | ||
* @type {typeof Bootstrap5Menubar} | ||
* | ||
* @public | ||
@@ -24,2 +25,3 @@ */ | ||
* @type {typeof Bootstrap5MenubarItem} | ||
* | ||
* @public | ||
@@ -33,2 +35,3 @@ */ | ||
* @type {typeof Bootstrap5MenubarToggle} | ||
* | ||
* @public | ||
@@ -35,0 +38,0 @@ */ |
@@ -13,2 +13,3 @@ /* eslint-disable jsdoc/no-undefined-types */ | ||
* @type {Object<HTMLElement>} | ||
* | ||
* @property {HTMLElement} toggle - The menu toggle. | ||
@@ -15,0 +16,0 @@ * @property {HTMLElement} parent - The menu containing this toggle. |
@@ -15,2 +15,3 @@ import Treeview from "accessible-menu/src/treeview.js"; | ||
* @type {typeof Bootstrap5Treeview} | ||
* | ||
* @public | ||
@@ -24,2 +25,3 @@ */ | ||
* @type {typeof Bootstrap5TreeviewItem} | ||
* | ||
* @public | ||
@@ -33,2 +35,3 @@ */ | ||
* @type {typeof Bootstrap5TreeviewToggle} | ||
* | ||
* @public | ||
@@ -40,5 +43,2 @@ */ | ||
* Constructs the menu. | ||
/** | ||
* Constructs the menu. | ||
* | ||
@@ -45,0 +45,0 @@ * @param {object} options - The options for generating the menu. |
@@ -13,2 +13,3 @@ /* eslint-disable jsdoc/no-undefined-types */ | ||
* @type {Object<HTMLElement>} | ||
* | ||
* @property {HTMLElement} toggle - The menu toggle. | ||
@@ -15,0 +16,0 @@ * @property {HTMLElement} parent - The menu containing this toggle. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
23
13721
214
680533
26
1
1
+ Addedaccessible-menu@4.2.0(transitive)
- Removedaccessible-menu@3.0.9(transitive)