https://github.com/trimble-oss/modus-wc-2.0
Modus Web Components built with Stencil
https://github.com/trimble-oss/modus-wc-2.0
frontend modus
Last synced: about 1 month ago
JSON representation
Modus Web Components built with Stencil
- Host: GitHub
- URL: https://github.com/trimble-oss/modus-wc-2.0
- Owner: trimble-oss
- License: mit
- Created: 2024-10-04T15:26:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-28T09:47:22.000Z (about 1 month ago)
- Last Synced: 2026-04-28T10:12:53.023Z (about 1 month ago)
- Topics: frontend, modus
- Language: TypeScript
- Homepage: https://modus-web-components-v2.trimble.com
- Size: 81.9 MB
- Stars: 10
- Watchers: 6
- Forks: 0
- Open Issues: 69
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Modus Web Components
[](https://raw.githubusercontent.com/trimble-oss/moduswebcomponents/main/LICENSE)
[](https://www.npmjs.com/package/@trimble-oss/moduswebcomponents)
[](https://www.npmjs.com/package/@trimble-oss/moduswebcomponents)
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
```bash
npm install @trimble-oss/moduswebcomponents
```
Import our styling in your main JavaScript or CSS file:
```javascript
import '@trimble-oss/moduswebcomponents/modus-wc-styles.css';
```
## Basic Usage
Import components where needed:
```javascript
import '@trimble-oss/moduswebcomponents';
```
```html
Click Me
```
## Documentation
- [Build Scripts](./docs/build-scripts.md)
- [Component Documentation](https://modus-web-components-v2.trimble.com)
- [Considerations](./docs/considerations.md)
- [Custom Themes](./docs/custom-themes.md)
- [Project Design](./docs/project-design.md)
- [Responsive Design](./docs/responsive-design.md)
## For Developers
### Getting Started
1. Clone the repository
2. `npm install`
3. `npm start` to 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](./CONTRIBUTING.md) 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](./LICENSE) file for details.