@trimble-oss/moduswebcomponents
v1.0.4
Published
Modus Web Components is a modern, accessible UI library built with Stencil JS that provides reusable web components following Trimble's Modus design system. This updated version focuses on improved flexibility, enhanced theming options, comprehensive cust
Readme
Modus Web Components
A lightweight, flexible web component library built for enterprise applications. Create consistent, accessible, and beautiful user interfaces using framework-agnostic web components.
Features
- Framework Agnostic - Works with React, Angular, Vue, or plain HTML/JS
- Enterprise Ready - Built for scalability, accessibility, and performance
- Customizable - Easy theming and styling options
- Modern UI - Follows contemporary design patterns and best practices
Installation
Setup
npm install @trimble-oss/moduswebcomponentsImport our styling in your main JavaScript or CSS file:
import '@trimble-oss/moduswebcomponents/modus-wc-styles.css';Basic Usage
Import components where needed:
import '@trimble-oss/moduswebcomponents';<!-- Add components to your HTML -->
<modus-wc-button color="primary" aria-label="Example button"
>Click Me</modus-wc-button
>Documentation
For Developers
Getting Started
- Clone the repository
npm installnpm startto start a development version of Stencil and Storybook
Building
npm run build to build the component library & storybook for production.
Linting & Formatting
npm run format to format your code using Prettier and ESlint.
npm run lint to check your code for linting errors.
Testing
npm test to run the test suite.
There is also:
npm run test:coverage- Check the code coverage of our unit tests.npm run test:update-snapshot- Update the snapshot tests if you've changed a component.npm run test:watch- Watches for changes and re-runs unit tests.
Release
On PR creation and merge to main the "Publish Storybook" action will automatically run. Once complete, a comment will be added to the PR with a link to a hosted Storybook page.
Contributing
Please read the CONTRIBUTING doc for details on our code of conduct, and the process for submitting pull requests.
License
This project is licensed under the MIT License - see the LICENSE file for details.
