https://github.com/brightspaceui/labs
A collection of experimental web components and tools for building Brightspace applications.
https://github.com/brightspaceui/labs
Last synced: about 2 months ago
JSON representation
A collection of experimental web components and tools for building Brightspace applications.
- Host: GitHub
- URL: https://github.com/brightspaceui/labs
- Owner: BrightspaceUI
- License: apache-2.0
- Created: 2022-01-07T18:47:47.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-04-15T21:11:47.000Z (about 2 months ago)
- Last Synced: 2026-04-15T22:28:13.921Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 131 MB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# @brightspace-ui/labs
[](https://www.npmjs.org/package/@brightspace-ui/labs)
A collection of experimental web components and tools for building Brightspace applications.
## Installation
Install from NPM:
```shell
npm install @brightspace-ui/labs
```
## Developing and Contributing
After cloning the repo, run `npm install` to install dependencies.
### Testing
To run the full suite of tests:
```shell
npm test
```
Alternatively, tests can be selectively run:
```shell
# eslint
npm run lint:eslint
# stylelint
npm run lint:style
# translations
npm run test:translations
# accessibility tests
npm run test:axe
# unit tests
npm run test:unit
```
This repo uses [@brightspace-ui/testing](https://github.com/BrightspaceUI/testing)'s vdiff command to perform visual regression testing:
```shell
# vdiff
npm run test:vdiff
# re-generate goldens
npm run test:vdiff golden
```
### Running the demos
To start a [@web/dev-server](https://modern-web.dev/docs/dev-server/overview/) that hosts the demo pages and tests:
```shell
npm start
```
D2L employees can also view the latest main-branch demos at https://live.d2l.dev/BrightspaceUI/labs/.
### Versioning and Releasing
This 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](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) documentation.