@k8ordo/ui

はじめる

@k8ordo/uiをインストールして、最初のコンポーネントを表示します。

このページの内容

インストール

bash
npm install @k8ordo/ui @k8ordo/i18n

次の環境で動きます。

  • React 19.3以上
  • TypeScriptで書くなら、TypeScript 7以上

エージェント向けのガイドはnode_modules/@k8ordo/ui/docs/GUIDE.mdに入っています。AGENTS.mdなどからこのパスを参照させてください。

生成UIとAIチャットのパッケージは、その機能を使うときだけ入れます。入れ方は、AIからたどれるそれぞれのページにあります。

スタイルシート

main.tsx
import '@k8ordo/ui/styles.css';

アプリのエントリーポイントで、トークンとリセットを持つスタイルシートを1回だけ読み込みます。部品のCSSは、部品が自分で読み込みます。Tailwind CSSは要りません。

app.css
@import 'tailwindcss';
@import '@k8ordo/ui/tailwind.css';

Tailwind CSS 4のプロジェクトでは、代わりにtailwindcssの後にtailwind.cssを読み込みます。デザイントークンがbg-bg-baseのようなTailwindのクラスになり、自分のマークアップでも使えます。tailwind.cssはプロジェクトのTailwindの上で働くので、@k8ordo/uiはTailwindに依存しません。

ダークモードの切り替えは、テーマの「ダークモード」の節を見てください。

情報

メモ

どちらのスタイルシートも、ページ全体に基本のスタイルを当てます。見出しやリストの余白を消し、bとstrongの太字も外します。既存のアプリに足すと、ライブラリ以外の見た目も変わります。

Markdownから作った文章は、Proseで囲むと見出しや太字のスタイルが戻ります。

プロバイダ

main.tsx
import { UIProvider } from '@k8ordo/ui';

export function Root() {
  return (
    <UIProvider>
      <App />
    </UIProvider>
  );
}

アプリのルートをUIProviderで1回だけ囲みます。トーストを表示するには、このプロバイダが必要です。

コンポーネントに組み込まれた「閉じる」などの文言は、@k8ordo/i18nの現在のロケールに従います。言語の選択はコンポーネントの文言で説明しています。

コンポーネント

subscribe-form.tsx
import { Button, FormControl, TextField } from '@k8ordo/ui';

export function SubscribeForm() {
  return (
    <form>
      <FormControl
        label="Email"
        renderInput={(props) => <TextField {...props} type="email" />}
      />
      <Button type="submit" variant="solid">
        Subscribe
      </Button>
    </form>
  );
}

使いたいコンポーネントをimportして置きます。

どのコンポーネントもclassNameとstyleを受け取りません。見た目はvariantやsizeなどのpropsで選びます。それでも足りないときは、ButtonのrenderItemのようなrender propで要素を差し替えます。

k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。