From 1970d61c116dcf278637bf7f1920059e2733a5b3 Mon Sep 17 00:00:00 2001 From: Kazunari Hara Date: Mon, 16 Oct 2023 12:40:58 +0900 Subject: [PATCH 1/8] docs(spindle-ui): update for v1.0.0 --- packages/spindle-ui/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/packages/spindle-ui/README.md b/packages/spindle-ui/README.md index 98068f54d..acc6dbc44 100644 --- a/packages/spindle-ui/README.md +++ b/packages/spindle-ui/README.md @@ -1,4 +1,4 @@ -# Spindle UI (In development) +# Spindle UI Spindle (Ameba Design System) UI Components @@ -6,8 +6,6 @@ Spindle (Ameba Design System) UI Components Spindle

-> Spindle UIは試験開発中のため、大幅に変更される可能性があります。安定版リリースまでの間はバージョン番号は0となり、バージョンに関わらずbreaking changeが行われることがありますので、利用時には注意してください。変更内容は、[CHANGELOG](CHANGELOG.md)に記載されています。 - ![MIT license](https://img.shields.io/npm/l/@openameba/spindle-ui) ![npm](https://img.shields.io/npm/v/@openameba/spindle-ui) From 0031cba1b839aef34f3eb6c857829997e536f3d2 Mon Sep 17 00:00:00 2001 From: Kazunari Hara Date: Mon, 16 Oct 2023 12:46:14 +0900 Subject: [PATCH 2/8] docs(spindle-hooks): update for v1.0.0 --- packages/spindle-hooks/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/packages/spindle-hooks/README.md b/packages/spindle-hooks/README.md index 9d436f479..51047e272 100644 --- a/packages/spindle-hooks/README.md +++ b/packages/spindle-hooks/README.md @@ -1,4 +1,4 @@ -# Spindle Hooks (In development) +# Spindle Hooks Spindle (Ameba Design System) Hooks @@ -6,8 +6,6 @@ Spindle (Ameba Design System) Hooks Spindle

-> Spindle Hooks は試験開発中のため、大幅に変更される可能性があります。安定版リリースまでの間はバージョン番号は 0 となり、バージョンに関わらず breaking change が行われることがありますので、利用時には注意してください。変更内容は、[CHANGELOG](CHANGELOG.md)に記載されています。 - ![MIT licence](https://img.shields.io/npm/l/@openameba/spindle-hooks) ![npm](https://img.shields.io/npm/v/@openameba/spindle-hooks) Spindle Hooksは、Amebaのデザインシステム「Spindle」で定義されたコンポーネントの機能部分にフォーカスし、再利用可能なReact Hooksを提供するライブラリです。様々なタイプのプロジェクトに導入できるように設計されています。 From 23f83711aada1dffd6cc96f4fb60e6f1f86e3fee Mon Sep 17 00:00:00 2001 From: Kazunari Hara Date: Mon, 16 Oct 2023 12:46:38 +0900 Subject: [PATCH 3/8] docs(spindle-icons): update for v1.0.0 --- packages/spindle-icons/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/packages/spindle-icons/README.md b/packages/spindle-icons/README.md index 486837c8b..777ec7ab7 100644 --- a/packages/spindle-icons/README.md +++ b/packages/spindle-icons/README.md @@ -1,9 +1,7 @@ -# Spindle Icons (In development) +# Spindle Icons SVG and PDF Icons with Spindle (Ameba Design System) -> Spindle Iconsは試験開発中のため、大幅に変更される可能性があります。安定版リリースまでの間はバージョン番号は0となり、バージョンに関わらずbreaking changeが行われることがありますので、利用時には注意してください。変更内容は、[CHANGELOG](CHANGELOG.md)に記載されています。 - ![See license in readme.md](https://img.shields.io/npm/l/@openameba/spindle-icons) ![npm](https://img.shields.io/npm/v/@openameba/spindle-icons) ## インストール From b9d6686c3ef04991e95c1e7aefea185435a805ce Mon Sep 17 00:00:00 2001 From: Kazunari Hara Date: Mon, 16 Oct 2023 14:41:50 +0900 Subject: [PATCH 4/8] docs(spindle-syntax-themes): update for v1.0.0 --- packages/spindle-syntax-themes/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/spindle-syntax-themes/README.md b/packages/spindle-syntax-themes/README.md index 984e7b17d..acb914c9c 100644 --- a/packages/spindle-syntax-themes/README.md +++ b/packages/spindle-syntax-themes/README.md @@ -46,5 +46,5 @@ yarn add @openameba/spindle-syntax-themes HTMLからCDNを経由して直接読み込みます。CDNの配信のため、サイトの表示速度に影響を及ぼす可能性があります。 ## バージョニング -### 0.x +### 0.x, 1.x Highlight.jsのバージョン10と互換性があります。それ以外のバージョンでも利用できる可能性はありますが、動作確認していません。 From dafb3e47c134d5904ccfe138e49d167a37103cda Mon Sep 17 00:00:00 2001 From: Kazunari Hara Date: Mon, 16 Oct 2023 14:52:03 +0900 Subject: [PATCH 5/8] docs(spindle-theme-switch): update for v1.0.0 --- packages/spindle-theme-switch/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/spindle-theme-switch/README.md b/packages/spindle-theme-switch/README.md index 178183013..b5ee1c12d 100644 --- a/packages/spindle-theme-switch/README.md +++ b/packages/spindle-theme-switch/README.md @@ -1,6 +1,6 @@ # Spindle Theme Switch -``はライトテーマとダークテーマを切り替えるためのコンポーネントです。Spindleで定義しているスタイルや動作、アクセシビリティ要件を考慮して作成されています。 +``はライトテーマとダークテーマを切り替えるためのコンポーネント([Custom Element](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_custom_elements))です。Spindleで定義しているスタイルや動作、アクセシビリティ要件を考慮して作成されています。 実装は[GoogleChromeLabs/dark-mode-toggle](https://github.com/GoogleChromeLabs/dark-mode-toggle)を継承して作成されています。 From 32c8f6b45261a49d55e0faa863856a544a7aa540 Mon Sep 17 00:00:00 2001 From: Kazunari Hara Date: Tue, 17 Oct 2023 14:40:15 +0900 Subject: [PATCH 6/8] docs: update for v1.0.0 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b293b27fb..f0bc325c0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Spindle

-# Spindle (In development) +# Spindle Ameba Design System From 3cbaa3e5227913d4a32269bfeb4da5bea8f7286c Mon Sep 17 00:00:00 2001 From: Kazunari Hara Date: Tue, 17 Oct 2023 14:47:18 +0900 Subject: [PATCH 7/8] docs(spindle-hooks): remove unused stability budge --- packages/spindle-hooks/CONTRIBUTING.md | 3 +-- packages/spindle-hooks/README.md | 8 +------- .../spindle-hooks/src/useCarousel/useCarousel.stories.mdx | 2 -- .../src/useTimeDistance/useTimeDistance.stories.mdx | 2 -- 4 files changed, 2 insertions(+), 13 deletions(-) diff --git a/packages/spindle-hooks/CONTRIBUTING.md b/packages/spindle-hooks/CONTRIBUTING.md index 405683ac0..959979906 100644 --- a/packages/spindle-hooks/CONTRIBUTING.md +++ b/packages/spindle-hooks/CONTRIBUTING.md @@ -14,5 +14,4 @@ Amebaとして提供される成果物は、それらに則って開発される 2. Design Docの作成。SpindleではHooksごとにDesign Docを作成し、該当Hooksに関わる事柄を整理します。Hooks名・概要・使用するデザイントークン・アクセシビリティ対応項目などを記載します。Design Docの雛形はNotionにありますので確認してみてください。 3. Design Docのレビュー。ある程度Design DocができあがったらSpindleチームやWebチームでレビューをします。この段階でのDesign Docはレビュー用途で使用するので完璧に仕上げる必要はありません！ 4. Hooks作成。実際にHooksを実装します。Storybookやテストの作成も忘れずお願いします！また、コンポーネント設計に困った場合には、すでに作成されているコンポーネントを見たり、[Spindle Hooks の Design Doc](/packages/spindle-hooks/docs/design-doc.md)を見たりしてみてください。 -5. コンポーネントStabilityの決定。Spindle HooksではコンポーネントごとにStabilityを決め、どうゆう利用が想定されているか明記しています。[定められた Stability](/packages/spindle-hooks#Hooks%20%E4%B8%80%E8%A6%A7)の中から選択肢、Storybookの冒頭に記載します。 -6. Pull Requestの作成。ここまでできたら後はGitHub上でやりとりし、リリースまで進めます。Pull Requestやリリースに関しては[Contributing to Spindle](/CONTRIBUTING.md)を参照してください。 +5. Pull Requestの作成。ここまでできたら後はGitHub上でやりとりし、リリースまで進めます。Pull Requestやリリースに関しては[Contributing to Spindle](/CONTRIBUTING.md)を参照してください。 diff --git a/packages/spindle-hooks/README.md b/packages/spindle-hooks/README.md index 51047e272..29d346131 100644 --- a/packages/spindle-hooks/README.md +++ b/packages/spindle-hooks/README.md @@ -42,13 +42,7 @@ Spindle HooksはSpindle UIと同様にmodule版の配信もしています。利 ## Hooks 一覧 -利用可能なReact Hooksは、[Storybook](https://ameba-spindle-hooks.web.app/)で公開されています。各コンポーネントの開発状況は[Stoybook Doc](https://ameba-spindle-hooks.web.app/?path=/docs/usecarousel--normal)のStability Budgeで以下のように表されています。 - -- ![stability-stable](https://img.shields.io/badge/stability-stable-green.svg) 想定された機能が実装、テストされており本番環境で利用できます -- ![stability-unstable](https://img.shields.io/badge/stability-unstable-yellow.svg) 足りていない機能や不安定な動作があり、まだ完全ではないですが、本番環境で利用できます -- ![stability-wip](https://img.shields.io/badge/stability-work_in_progress-lightgrey.svg) 開発中のため、本番環境での利用はしない方がよいでしょう -- ![stability-experimental](https://img.shields.io/badge/stability-experimental-orange.svg) 実験的な機能で大きな変更や削除される可能性があります -- ![stability-deprecated](https://img.shields.io/badge/stability-deprecated-red.svg) 廃止される予定のため、できるだけはやく利用を停止してください +利用可能なReact Hooksは、[Storybook](https://ameba-spindle-hooks.web.app/)で公開されています。 ## ブラウザサポート diff --git a/packages/spindle-hooks/src/useCarousel/useCarousel.stories.mdx b/packages/spindle-hooks/src/useCarousel/useCarousel.stories.mdx index 6312283a5..f87e1f06c 100644 --- a/packages/spindle-hooks/src/useCarousel/useCarousel.stories.mdx +++ b/packages/spindle-hooks/src/useCarousel/useCarousel.stories.mdx @@ -8,8 +8,6 @@ import { HeroCarousel } from './useCarousel.stories'; -![stability-experiment](https://img.shields.io/badge/stability-experiment-red.svg) - Carouselの機能をまとめたHooksです。 diff --git a/packages/spindle-hooks/src/useTimeDistance/useTimeDistance.stories.mdx b/packages/spindle-hooks/src/useTimeDistance/useTimeDistance.stories.mdx index 26848ab44..1bfc39813 100644 --- a/packages/spindle-hooks/src/useTimeDistance/useTimeDistance.stories.mdx +++ b/packages/spindle-hooks/src/useTimeDistance/useTimeDistance.stories.mdx @@ -12,8 +12,6 @@ export const Time = ({ date, options }) => { -![stability-experiment](https://img.shields.io/badge/stability-experiment-red.svg) - 時間を表示するHooksです。 ## Default Format From e9eff47ec26ae58cd2161bd5e668beffe73dd7c1 Mon Sep 17 00:00:00 2001 From: Kazunari Hara Date: Tue, 17 Oct 2023 14:49:36 +0900 Subject: [PATCH 8/8] docs(spindle-ui): change version to load in example --- packages/spindle-ui/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/spindle-ui/README.md b/packages/spindle-ui/README.md index acc6dbc44..ce6dfe522 100644 --- a/packages/spindle-ui/README.md +++ b/packages/spindle-ui/README.md @@ -76,13 +76,13 @@ Spindle UIのスタイルは、名前空間(`spui`)をもったCSSとして定 - + - + ``` ただし、CSSファイルサイズやファイル数が不必要に大きくなり、CDNサーバが遅延の原因になる可能性があるため**本番Webアプリケーションでの利用は推奨していません**。