atlas-react-kit
v1.2.5
Published
Shared React components and Tailwind theme for Atlas
Readme
Atlas React Kit
Shared React components and a Tailwind theme with square corners, semantic
colors, and distinct selected states. From 1.0 the API is stable: breaking
changes to stable components only ship in a major release (see
CONTRIBUTING.md).
The React, Tailwind, and Node versions it supports are peerDependencies
and engines in package.json.
npm install --save-exact atlas-react-kitImport components by subpath:
import { Button } from "atlas-react-kit/button"
import { Card, CardContent } from "atlas-react-kit/card"
export function Example() {
return (
<Card>
<CardContent>
<Button>Save</Button>
</CardContent>
</Card>
)
}Core entries need only the kit. Feature entries may need optional peers; see the component guide's install table.
In your global stylesheet, import the theme after Tailwind and register the
installed JavaScript directory. Paths in @source are relative to that stylesheet;
this example assumes it is one directory below the project root.
@import "tailwindcss";
@import "atlas-react-kit/theme.css";
@source "../node_modules/atlas-react-kit/dist";The theme includes animations and shared light/dark tokens. Wrap the tree with
ThemeProvider from atlas-react-kit/theme-provider (install next-themes
from the install table first),
or set the dark class on an ancestor to activate dark colors. Supply your
own font configuration;
font-heading uses the configured sans font. Application-specific tokens stay
with the application.
Documentation
- Component guide: imports, props, optional installs, and composition. This guide ships in the npm package.
- Design rules: tokens, accessibility, writing, and composition. This guide ships in the npm package.
- Contributing: component changes, checks, and releases.
- Decisions behind 1.0 (record): the closed roadmap that led to 1.0.0.
- Changelog: published and upcoming changes.
AI coding assistants
The package also ships an agent skill,
skills/atlas-react-kit/SKILL.md. It
tells an assistant to read the guides for the installed version, pick kit
components over hand-rolled markup, style with tokens, and check its work. Link
it into Claude Code from the app root, so it updates with the package:
mkdir -p .claude/skills
ln -s ../../node_modules/atlas-react-kit/skills/atlas-react-kit .claude/skills/atlas-react-kitOn Windows, or to commit a pinned copy, use
cp -r node_modules/atlas-react-kit/skills/atlas-react-kit .claude/skills/
instead. For Cursor, Codex, or other agents, point your AGENTS.md at
node_modules/atlas-react-kit/skills/atlas-react-kit/SKILL.md. Shared component changes belong in this repository;
applications compose their feature UI around the package and upgrade deliberately.
Public docs and a live playground are at
design.querobines.com. The site is Storybook:
tokens parsed from theme.css, these markdown guides rendered from source, and
editable component stories with light/dark themes, viewport previews, and
accessibility checks. Its build publishes docs-index.json with guide headings
and package entry points for search and indexing tools.
Development and releases
Setup, checks, the component checklist, and releases are in CONTRIBUTING.md.
Pin an exact package version in consuming applications. Roll back an upgrade by restoring the previous version and lockfile. License: MIT; upstream notices are preserved in NOTICE.
