0.0.2 • Published 5 months ago
@popgrids/ui v0.0.2
@popgrids/ui
A modern, reusable UI component library built with Lit for Popgrids applications.
Installation
npm install @popgrids/uiUsage
Import the package to register all components:
import "@popgrids/ui";Then use the components in your HTML:
<pop-button>Click me</pop-button>
<pop-icon name="star"></pop-icon>
<pop-toast message="Hello!"></pop-toast>Available Components
The library includes the following components:
<pop-button>- Standard button component<pop-button-vertical>- Vertical button variant<pop-button-link>- Button that acts as a link<pop-code-input-field>- Input field for code entry<pop-comment-avatar>- Avatar component for comments<pop-comment-icon>- Icon component for comments<pop-element>- Base element component<pop-focus-indicator>- Focus indicator component<pop-form-input-simple>- Simple form input component<pop-icon>- Icon component<pop-loader>- Loading indicator component<pop-logo>- Logo component<pop-sum>- Sum display component<pop-timestamp-countdown>- Countdown timer component<pop-toast>- Toast notification component
Development
Prerequisites
- Node.js
- npm
Scripts
npm run build- Build the packagenpm run dev- Watch mode for developmentnpm run clean- Clean build artifactsnpm run lint- Run ESLintnpm run test- Run testsnpm run generate:component- Generate a new componentnpm run check-types- Check TypeScript types
Adding New Components
To add a new component, use the generator:
npm run generate:componentDependencies
- Lit - Web Components library
- @popgrids/theme - Theme package
License
Private - All rights reserved