このプロジェクトについて

BraidはSEEK Group向けのテーマ変更可能なデザインシステムであり、npmにbraid-design-systemとして公開されています。READMEでは、skuプロジェクトに最適化されたセットアップについて説明されています。まずパッケージをインストールし、CSSの順序による問題を避けるため、アプリケーションの最上部でリセットスタイルを最初にインポートします。次にseekJobsなどのテーマをインポートし、BraidProviderとコンポーネントをインポートします。Providerはthemeプロップを受け取ってコンポーネントをレンダリングし、styleBody={false}を指定することでbodyスタイルを適用しないようにすることも可能です。また、linkComponentを通じてmakeLinkComponentを使用したカスタムリンクコンポーネントを提供でき、これによりReact Routerリンクの統合など、LinkおよびTextLinkの実装をカスタマイズできます。ローカル開発にはpnpmとStorybookを使用します。BraidはスタイリングにVanilla Extractを採用しており、TypeScriptでCSSを記述し、それを静的にアトミックCSSクラスへ抽出します。これにはバンドラープラグインが必要です。コンポーネントの使用チェックにはassertライブラリによるランタイムアサーションが使用されています。READMEでは、skuおよびBabel経由で行われているように、unassertを使用して本番環境でこれらを削除することを推奨しています。非推奨などの開発時およびビルド時の警告はprocess.env.NODE_ENVに依存しており、本番用バンドルから削除可能です。貢献に関する情報はCONTRIBUTING.mdに記載されています。Storybookを活用したコンポーネントのスクリーンショットテストを提供しているChromaticに謝辞が述べられています。ライセンスはMITです。