airi/packages/ui
2026-03-15 04:04:07 +08:00
..
src Revert "fix(stage-tamagotchi): fix model flickering and jumping on window res…" (#1364) 2026-03-15 03:07:03 +08:00
package.json release: v0.9.0-alpha.16 2026-03-15 04:04:07 +08:00
README.md fix(ui): update README.md for attributify and styles reset (#724) 2025-11-05 15:11:38 +08:00
tsconfig.json chore(tsconfig): clean useless mts part 2025-10-17 20:42:24 +08:00

@proj-airi/ui

A stylized UI component library built with Reka UI and UnoCSS.

To preview the components, refer to the stage-ui package for instructions for running the Histoire UI storyboard.

Get started

Install the library:

ni @proj-airi/ui -D # from @antfu/ni, can be installed via `npm i -g @antfu/ni`
pnpm i @proj-airi/ui -D
yarn i @proj-airi/ui -D
npm i @proj-airi/ui -D

This library requires unocss with Attributify Mode and a style reset.

First, install unocss if you haven't already:

pnpm i -D unocss

Next, in your uno.config.ts, add presetAttributify() to your presets array:

import { defineConfig, presetAttributify } from 'unocss'

export default defineConfig({
  presets: [
    presetAttributify(),
    // ...your other presets
  ],
})

Finally, import the reset styles in your main.ts:

import '@unocss/reset/tailwind.css'

Usage

<script setup lang="ts">
import { Button } from '@proj-airi/ui'
</script>

<template>
  <Button>Click me</Button>
</template>

Components

License

MIT