Note: this is a "labs" component. While functional, these tasks are prerequisites to promotion to BrightspaceUI "official" status:
- [ ] Design organization buy-in
- [ ] design.d2l entry
- [ ] Architectural sign-off
- [ ] Continuous integration
- [ ] Cross-browser testing
- [ ] Unit tests (if applicable)
- [ ] Accessibility tests
- [ ] Visual diff tests
- [ ] Localization with Serge (if applicable)
- [ ] Demo page
- [ ] README documentation
A Lit component for navigating between webpages.
Install from NPM:
npm install @brightspace-ui-labs/immersive-nav<script type="module">
import '@brightspace-ui-labs/immersive-nav/immersive-nav.js';
</script>
<d2l-labs-immersive-nav>My element</d2l-labs-immersive-nav>Properties:
| Property | Type | Description |
|---|---|---|
Accessibility:
To make your usage of d2l-labs-immersive-nav accessible, use the following properties when applicable:
| Attribute | Description |
|---|---|
After cloning the repo, run npm install to install dependencies.
# eslint and lit-analyzer
npm run lint
# eslint only
npm run lint:eslint# lint & run headless unit tests
npm test
# unit tests only
npm run test:headless
# debug or run a subset of local unit tests
npm run test:headless:watchThis repo uses the @brightspace-ui/visual-diff utility to compare current snapshots against a set of golden snapshots stored in source control.
The golden snapshots in source control must be updated by the visual-diff GitHub Action. If a pull request results in visual differences, a draft pull request with the new goldens will automatically be opened against its branch.
To run the tests locally to help troubleshoot or develop new tests, first install these dependencies:
npm install @brightspace-ui/visual-diff@X mocha@Y puppeteer@Z --no-saveReplace X, Y and Z with the current versions the action is using.
Then run the tests:
# run visual-diff tests
npx mocha './test/**/*.visual-diff.js' -t 10000
# subset of visual-diff tests:
npx mocha './test/**/*.visual-diff.js' -t 10000 -g some-pattern
# update visual-diff goldens
npx mocha './test/**/*.visual-diff.js' -t 10000 --goldenTo start a @web/dev-server that hosts the demo page and tests:
npm startThis repo is configured to use semantic-release. Commits prefixed with fix: and feat: will trigger patch and minor releases when merged to main.
To learn how to create major releases and release from maintenance branches, refer to the semantic-release GitHub Action documentation.