https://github.com/linuxfoundation/lfx-ui
https://github.com/linuxfoundation/lfx-ui
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/linuxfoundation/lfx-ui
- Owner: linuxfoundation
- License: mit
- Created: 2024-11-11T20:06:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-03T23:34:00.000Z (6 months ago)
- Last Synced: 2025-12-07T05:30:00.107Z (6 months ago)
- Language: TypeScript
- Size: 1.96 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Maintainers: MAINTAINERS.md
Awesome Lists containing this project
README
# LFX UI Core
A package that contains core functionality for LFX UI products. It includes design tokens and PrimeOne theme configuration that is shared across LFX UI products.
## Overview
### Design Tokens
This package contains design tokens and PrimeTek theme configuration that is shared across LFX UI products.
The generated tokens are organized into three layers:
- **Primitive Tokens**: Base-level design values (colors, spacing, typography, etc.)
- **Semantic Tokens**: Purpose-driven tokens that reference primitive tokens
- **Component Tokens**: Component-specific tokens that reference semantic tokens
## Installation
```bash
npm install @linuxfoundation/lfx-ui-core
```
## Documentation
- Configurations
- [Design Tokens](docs/design-tokens.md)
- [Prettier Configuration](docs/prettier-config.md)
- Components
- [Components Overview](docs/components.md)
- [Footer Component](docs/footer.md)
- [Tools Component](docs/tools.md)
## Contributing
### Prerequisites
- Node.js 20.x
- npm
### Development Setup
1. Clone the repository:
```bash
git clone https://github.com/linuxfoundation/lfx-ui
cd lfx-ui-core
```
2. Install dependencies:
```bash
npm ci
```
3. Build the tokens and components:
```bash
npm run build
```
### Making Changes
1. The source tokens are defined in `src/design/tokens/tokens.json`
2. Modify the tokens file according to your needs, or update it in Figma using Tokens Studio
3. Run the build script to generate updated token files:
```bash
npm run build
```
### Release Process
1. Create a new version tag following semver conventions:
```bash
git tag v1.0.0
git push origin v1.0.0
```
2. The GitHub Action will automatically:
- Build the package
- Update the version
- Publish to npm
### Guidelines
- Follow semantic versioning for releases
- Update documentation when adding new token categories
- Add comments to explain complex token relationships
- Test tokens in a real application before releasing