Getting Started
Introduction
The purpose, principles, and current scope of Orkest UI.
Orkest UI is a reusable React component library built with TypeScript. It provides a neutral-first visual language, semantic design tokens, and accessible primitives that can be shared across React and Next.js applications.
The library is intentionally small. Each component is expected to have a clear API, documented states, tests for user-observable behavior, and a place in the design system.
What is included#
- Design tokens for color, typography, spacing, radius, elevation, motion, and layering.
- Light and dark themes driven by semantic CSS variables.
- Primitives for layout and typography:
Box,Stack,Grid,Text,Icon, andSeparator. - Documentation built from MDX and rendered with the actual library components.
Current scope
The component list reflects what is implemented today. Components from the roadmap are documented
once they exist in packages/ui.
Principles#
- Content leads. Neutral surfaces and restrained color keep the interface focused.
- Tokens first. Components consume semantic variables instead of raw color values.
- Native semantics. Use the right HTML element before adding ARIA.
- Predictable APIs. Shared concepts use the same prop names and value sets.
- Accessibility is part of the definition of done. Focus, keyboard behavior, and accessible names are not optional polish.
Start here#
- Installation explains how to add the package to a workspace.
- Quick Start shows a first composition with the current primitives.
- Colors and Typography describe the visual language.
- Components contains the live component references.