@brightspace-ui/core

@brightspace-ui/core

A collection of accessible, free, open-source web components and tools for building Brightspace applications.

Installation

npm install @brightspace-ui/core

README Index

• Components
  • Alert: alert components for displaying important information
  • Breadcrumbs: component to help users understand where they are within an application
  • Backdrop: component for displaying backdrop behind a target element
  • Buttons: normal, primary, icon and subtle buttons
  • Calendar: calendar component
  • Card: card components
  • Colors: color palette
  • Dialogs: generic and confirmation dialogs
  • Dropdowns: dropdown openers and content containers
  • Expand Collapse: component to create expandable and collapsible content
  • Focus Trap: generic container that traps focus
  • Forms: aggregate data for submission and validation
  • Hierarchical View: nested container component that shows the active container
  • HTML Block: component for rendering user-authored HTML
  • Icons: iconography SVGs and web components
  • Inputs:
    • Checkbox: checkbox components and styles
    • Date and time: date and time picker components including ranges
    • Number: number input component
    • Radio: radio input styles
    • Search: search input component
    • Select styles: select input styles
    • Text: text input component and styles
    • Text Area: multi-line text component
  • Links: link component and styles
  • List: list and list-item components
  • Loading Spinner: loading-spinner components
  • Menu: menu and menu item components
  • Meter: linear, radial, circle meter web components
  • More/less: constrain long bits of content
  • Off-screen: component and styles for positioning content off-screen
  • Skeleton: apply low-fidelity skeletons to your application as it loads
  • Status Indicator: status-indicator components
  • Switch: switch component with on/off semantics
  • Tabs: tab and tab-panel components
  • Tooltip: tooltip components
  • Typography: typography styles and components
  • Validation: plugin custom validation logic to native and custom form elements
• Helpers
  • Helpers: helpers for composed DOM, unique ids, etc.
• Mixins
  • ArrowKeysMixin: manage focus with arrow keys
  • AsyncContainerMixin: manage collective async state
  • FocusVisiblePolyfillMixin: components can use the :focus-visible pseudo-class polyfill
  • FormElementMixin: allow components to participate in forms and validation
  • LocalizeMixin: localize text in your components
  • ProviderMixin: provide and consume data across elements in a DI-like fashion
  • RtlMixin: enable components to define RTL styles
  • SkeletonMixin: make components skeleton-aware
  • VisibleOnAncestorMixin: display element on-hover of an ancestor
• Templates
  • PrimarySecondaryTemplate: Two Panel (primary and secondary) page template with header and optional footer

Developing

After cloning the repo, run npm install to install dependencies.

Run npm run build once, or any time icon or Sass files are changed.

Running the demos

Start an es-dev-server that hosts the demo pages:

npm start

Linting

# eslint and lit-analyzer
npm run lint

# eslint only
npm run lint:eslint

# lit-analyzer only
npm run lint:lit

Testing

# lint, unit tests and axe tests
npm test

# unit tests
npm run test:headless

# debug or run a subset of local unit tests
# then navigate to `http://localhost:9876/debug.html`
npm run test:headless:watch

Visual Diff Testing

This 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 Github Actions. If your PR's code changes result in visual differences, a PR with the new goldens will be automatically opened for you against your branch.

If you'd like to run the tests locally to help troubleshoot or develop new tests, you can use these commands:

# Install dependencies locally
npm i mocha -g
npm i @brightspace-ui/visual-diff puppeteer --no-save

# run visual-diff tests
mocha './**/*.visual-diff.js' -t 10000

# subset of visual-diff tests:
mocha './**/*.visual-diff.js' -t 10000 -g some-pattern

# update visual-diff goldens
mocha './**/*.visual-diff.js' -t 10000 --golden

Versioning & Releasing

TL;DR: Commits prefixed with fix: and feat: will trigger patch and minor releases when merged to master. Read on for more details...

The sematic-release GitHub Action is called from the release.yml GitHub Action workflow to handle version changes and releasing.

Version Changes

All version changes should obey semantic versioning rules:

• MAJOR version when you make incompatible API changes,
• MINOR version when you add functionality in a backwards compatible manner, and
• PATCH version when you make backwards compatible bug fixes.

The next version number will be determined from the commit messages since the previous release. Our semantic-release configuration uses the Angular convention when analyzing commits:

• Commits which are prefixed with fix: or perf: will trigger a patch release. Example: fix: validate input before using
• Commits which are prefixed with feat: will trigger a minor release. Example: feat: add toggle() method
• To trigger a MAJOR release, include BREAKING CHANGE: with a space or two newlines in the footer of the commit message
• Other suggested prefixes which will NOT trigger a release: build:, ci:, docs:, style:, refactor: and test:. Example: docs: adding README for new component

To revert a change, add the revert: prefix to the original commit message. This will cause the reverted change to be omitted from the release notes. Example: revert: fix: validate input before using.

Releases

When a release is triggered, it will:

• Update the version in package.json
• Tag the commit
• Create a GitHub release (including release notes)
• Deploy a new package to NPM

Releasing from Maintenance Branches

Occasionally you'll want to backport a feature or bug fix to an older release. semantic-release refers to these as maintenance branches.

Maintenance branch names should be of the form: +([0-9])?(.{+([0-9]),x}).x.

Regular expressions are complicated, but this essentially means branch names should look like:

• 1.15.x for patch releases on top of the 1.15 release (after version 1.16 exists)
• 2.x for feature releases on top of the 2 release (after version 3 exists)

Future Enhancements

Looking for a new component or an enhancement not listed here? Create a GitHub issue!