@nextop-os/ui-system

Shared Nextop UI tokens, styles, icons, and low-level React primitives.

This package is published to npm as @nextop-os/ui-system.

Import the stylesheet once from the renderer or application shell:

import "@nextop-os/ui-system/styles.css";

Application code should prefer the root package export and the documented stable subpaths over deep imports from internal files.

External Development

External consumers should install the package normally:

pnpm add @nextop-os/ui-system

For local source sync from a Nextop checkout, start the UI system dev server:

pnpm --filter @nextop-os/ui-system dev:server

Then add the Vite plugin in the external app:

import { nextopUISystemDev } from "@nextop-os/ui-system/dev-vite";

export default defineConfig({
  plugins: [nextopUISystemDev()]
});

When the dev server is reachable, the plugin mirrors the allowed UI-system source files into .nextop-ui-system-dev/ and aliases the stable package entrypoints to that cache. When the dev server is unavailable, resolution falls back to the installed package in node_modules.

Add the generated cache to the external app's .gitignore:

.nextop-ui-system-dev/

If the external app uses Tailwind CSS, include both the installed package output and the generated dev cache in the app's Tailwind source scan:

@source "../node_modules/@nextop-os/ui-system/dist";
@source "../.nextop-ui-system-dev";

Agent Usage

Coding agents should read component metadata before creating or promoting UI:

import { uiSystemMetadata } from "@nextop-os/ui-system/metadata";

When promoting business UI into this package, use the bundled agent/nextop-ui-system/SKILL.md skill when it is available. The durable rules are:

1. prefer existing metadata entries before creating a component
2. classify the component as base or business
3. keep business components host-agnostic and side-effect-free
4. compose business components from base primitives
5. add metadata, stable exports, and storyboard examples for public UI
6. run metadata and boundary validation before shipping

External repositories can install the bundled skill into their local Codex skill directory with one command:

pnpm exec nextop-ui-system-install-skill

This copies the package skill into:

.codex/skills/nextop-ui-system/SKILL.md

The installer does not overwrite a locally modified skill unless --force is provided.