Skip to content

openmfp/webcomponents

OpenMFP Web Components Library

A modern Angular 21 web components library featuring declarative UI components built with the latest signal-based APIs.

Build Status

✨ Features

  • Angular 21 - Built with the latest Angular features and signal-based APIs
  • Web Components Ready - Exportable as native web components via Angular Elements
  • Declarative UI - Intuitive generic ui component
  • Vitest Testing - Fast, modern testing framework
  • TypeScript - Full type safety with strict mode
  • Tree-Shakeable - Optimized bundle size with ES modules

🚀 Getting Started

Installation

# Install dependencies
npm install

# Build the library
npm run build

Build Commands

Run npm run build to build the project. The build artifacts will be stored in the dist/ directory.

# Build once
npm run build

# Build in watch mode (for development)
npm run build:watch

# Build and publish to yalc (for local testing)
npm run build:watch:yalc

Testing

Run npm run test to execute unit tests with Vitest.

# Run tests once
npm test

# Run tests in watch mode
npm run test:watch

# Generate coverage report
npm run test:cov

Code Quality

# Lint code
npm run lint

# Fix linting issues
npm run lint:fix

# Format code with Prettier
npm run format

# Check code formatting
npm run check-format

Web Components Support

Components can be exported as native web components using Angular Elements, making them framework-agnostic.

Components

Angular tag Web Component tag Documentation
<mfp-declarative-table> <mfp-wc-declarative-table> docs/declarative-table.md
<mfp-declarative-form> <mfp-wc-declarative-form> docs/declarative-form.md
<mfp-declarative-table-card> <mfp-wc-declarative-table-card> docs/declarative-table-card.md
<mfp-dashboard> <mfp-wc-dashboard> docs/dashboard.md

NeoNephos Foundation

This project is part of the NeoNephos Foundation, a Linux Foundation Europe initiative.

Bundesministerium für Wirtschaft und Energie (BMWE)-EU funding logo

About

No description, website, or topics provided.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors