✨ Overview

@oniratec/onira-react-ui is the official React UI component library for Onira projects.

The library focuses on:

• predictable and explicit APIs
• accessibility by default
• strong TypeScript typing
• long-term maintainability
• automated quality and release processes

This repository is intended to be shared, versioned, and contributed to safely.

📦 Installation

npm install @oniratec/onira-react-ui

pnpm add @oniratec/onira-react-ui

🚀 Getting started

import { Button } from '@oniratec/onira-react-ui'

Component usage, props, and examples are documented in Storybook.

📖 Documentation

Project & usage

• 📘 Getting Started → docs/getting-started.md
• 🧩 Components overview → docs/components.md
• 🎨 Theming → docs/theming.md
• ♿ Accessibility → docs/accessibility.md

Quality & contribution

• 🧪 CI & Code Quality → docs/ci-quality.md
• 🚀 Release process → docs/release-process.md
• 🤝 Contributing → docs/contributing.md

🧩 Component documentation (Storybook)

This project uses Storybook as the source of truth for component documentation.

Local Storybook:

npm install
npm run storybook

Runs at http://localhost:6006

🧠 Versioning & releases

This library follows Semantic Versioning and uses Changesets.

• versions are bumped automatically
• changelogs are generated
• publishing is handled by GitHub Actions
• no package is published without an explicit version decision

Current version: 0.0.1 (alpha)

🛠️ Development

npm install
npm run lint
npm run typecheck
npm run test
npm run build

🤝 Contributing

Please read docs/contributing.md before opening a PR.

📄 License

MIT