mirror of
https://github.com/moeru-ai/airi.git
synced 2026-07-09 15:58:27 +00:00
|
Some checks are pending
CI / Lint (push) Waiting to run
CI / Build Test (stage-tamagotchi) (push) Waiting to run
CI / Build Test (stage-tamagotchi-godot) (push) Waiting to run
CI / Build Test (stage-web) (push) Waiting to run
CI / Build Test (ui-loading-screens) (push) Waiting to run
CI / Build Test (ui-transitions) (push) Waiting to run
CI / Unit Test (push) Waiting to run
CI / Type Check (push) Waiting to run
CI / Check Provenance (push) Waiting to run
Cloudflare Pages (Auth UI) / Deploy - ui-server-auth (push) Waiting to run
Cloudflare Workers / Deploy - stage-web (push) Waiting to run
Update Nix pnpmDeps Hash / update (push) Waiting to run
|
||
|---|---|---|
| .. | ||
| src | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
@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>