Skip to content

stormid/components

Repository files navigation

Components

This is a lerna monorepo containing a suite of UI components built, used and maintained by Storm Id.

Each package is available for use on npm. See the docs for details on each package.


Packages

Package Description
Boilerplate Boilerplate for developing new components
Cookie Banner GDPR compliant cookie banner
Modal Accessible modal dialog
Modal Gallery Accessible modal gallery
Outliner Hide CSS outline on mouse interactions, until :focus-visible has broader support
Scroll Points Trigger events based on element intersecting the viewport
Scroll Spy Update elements based on target element intersecting the viewport
Skip Ensure fragment identifier links focus on their target node
Tabs Accessible tabbed panelled content areas
Textarea Auto-resizing textarea
Toggle Accessible DOM element expand and collapse
Validate Client-side form validation library

Commands

Install lerna to use the Lerna CLI.

Package tasks

Task Command
Run the example app lerna run --scope PACKAGE_NAME dev --stream
Output the example app in prod mode lerna run --scope PACKAGE_NAME prod --stream
Run tests lerna run --scope PACKAGE_NAME test --stream
Build the package for distribution lerna run --scope PACKAGE_NAME build --stream

Monorepo tasks

Task Command
Build the docs npm run gh-pages
Lint all packages npm run lint -- --fix
Lerna changed List of packages that would be the subjects of the next version or publish
Lerna version Bump version of packages changed since the last release
Lerna publish Publish packages in the current project

The full list of Lerna commands is listed in the docs.