Spindle UI (In development)
Spindle (Ameba Design System) UI Components
Spindle UIは試験開発中のため、大幅に変更される可能性があります。安定版リリースまでの間はバージョン番号は0となり、バージョンに関わらずbreaking changeが行われることがありますので、利用時には注意してください。変更内容は、CHANGELOGに記載されています。
Spindle UIは、Amebaのデザインシステム「Spindle」で定義されたコンポーネントを配布するライブラリです。様々なタイプのプロジェクトに導入できるように設計されています。
コンポーネント一覧
利用可能なコンポーネントは、Storybookで公開されています。各コンポーネントの開発状況はStoybook DocのStability Budgeで以下のように表されています。
-
想定された機能が実装、テストされており本番環境で利用できます
-
足りていない機能や不安定な動作があり、まだ完全ではないですが、本番環境で利用できます
-
開発中のため、本番環境での利用はしない方がよいでしょう
-
実験的な機能で大きな変更や削除される可能性があります
-
廃止される予定のため、できるだけはやく利用を停止してください
インストール
npm install @openameba/spindle-ui
yarn add @openameba/spindle-ui
利用方法
Spindle UIは様々なパターンのアプリケーションで利用できます。詳細は各サンプルコードを閲覧してください。
ブラウザサポート
Spindle UIはFirefox、Google Chrome、Microsoft Edge、Safariの最新版とInternet Explorer 11で動作確認しています。ただし、CSS custom propertiesを使用しているため、Internet Explorer 11での利用時にはie11-custom-propertiesやcss-vars-ponyfillなどpolyfillとの併用が必要です。
開発方法
yarn install
yarn dev # storybookが起動します
ライセンス
Spindle IconsはMITライセンスで公開されています。ただし、アイコンはSpindle Iconsに準じて、Creative Commons BY-NC-ND 4.0ライセンスで公開されています。