Skip to content

Commit

Permalink
Merge pull request #829 from openameba/feat/update-for-v1
Browse files Browse the repository at this point in the history
Update to v1
  • Loading branch information
herablog authored Oct 18, 2023
2 parents d42de22 + e9eff47 commit b0494ed
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 27 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<img alt="Spindle" src="./docs/images/spindle-logo.png" width="400">
</p>

# Spindle (In development)
# Spindle

Ameba Design System

Expand Down
3 changes: 1 addition & 2 deletions packages/spindle-hooks/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)を参照してください。
12 changes: 2 additions & 10 deletions packages/spindle-hooks/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
# Spindle Hooks (In development)
# Spindle Hooks

Spindle (Ameba Design System) Hooks

<p align="center">
<img alt="Spindle" src="./docs/images/components.png" width="400">
</p>

> 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を提供するライブラリです。様々なタイプのプロジェクトに導入できるように設計されています。
Expand Down Expand Up @@ -44,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/)で公開されています。

## ブラウザサポート

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ import { HeroCarousel } from './useCarousel.stories';

<Meta title="useCarousel" component={HeroCarousel} />

![stability-experiment](https://img.shields.io/badge/stability-experiment-red.svg)

<Description>Carouselの機能をまとめたHooksです。</Description>

<Description>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ export const Time = ({ date, options }) => {

<Meta title="useTimeDistance" component={Time} />

![stability-experiment](https://img.shields.io/badge/stability-experiment-red.svg)

<Description>時間を表示するHooksです。</Description>

## Default Format
Expand Down
4 changes: 1 addition & 3 deletions packages/spindle-icons/README.md
Original file line number Diff line number Diff line change
@@ -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)

## インストール
Expand Down
2 changes: 1 addition & 1 deletion packages/spindle-syntax-themes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,5 @@ yarn add @openameba/spindle-syntax-themes
HTMLからCDNを経由して直接読み込みます。CDNの配信のため、サイトの表示速度に影響を及ぼす可能性があります。

## バージョニング
### 0.x
### 0.x, 1.x
Highlight.jsのバージョン10と互換性があります。それ以外のバージョンでも利用できる可能性はありますが、動作確認していません。
2 changes: 1 addition & 1 deletion packages/spindle-theme-switch/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Spindle Theme Switch

`<spindle-theme-switch>`はライトテーマとダークテーマを切り替えるためのコンポーネントです。Spindleで定義しているスタイルや動作、アクセシビリティ要件を考慮して作成されています。
`<spindle-theme-switch>`はライトテーマとダークテーマを切り替えるためのコンポーネント([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)を継承して作成されています。

Expand Down
8 changes: 3 additions & 5 deletions packages/spindle-ui/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
# Spindle UI (In development)
# Spindle UI

Spindle (Ameba Design System) UI Components

<p align="center">
<img alt="Spindle" src="./docs/images/components.png" width="400">
</p>

> 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)


Expand Down Expand Up @@ -78,13 +76,13 @@ Spindle UIのスタイルは、名前空間(`spui`)をもったCSSとして定
<!-- 常に最新のスタイルを読み込む場合。ただしリダイレクトされるため遅延します -->
<link rel="stylesheet" href="https://unpkg.com/@openameba/spindle-ui/index.css">
<!-- バージョンを指定して読み込む場合。リダイレクトされないのでレスポンスが少し早いです -->
<link rel="stylesheet" href="https://unpkg.com/@openameba/spindle-ui@0.11.2/index.css">
<link rel="stylesheet" href="https://unpkg.com/@openameba/spindle-ui@1.0.0/index.css">

<!-- コンポーネント毎にスタイルを読み込む場合 -->
<!-- 常に最新のスタイルを読み込む場合。ただしリダイレクトされるため遅延します -->
<link rel="stylesheet" href="https://unpkg.com/@openameba/spindle-ui/Button/Button.css">
<!-- バージョンを指定して読み込む場合。リダイレクトされないのでレスポンスが少し早いです -->
<link rel="stylesheet" href="https://unpkg.com/@openameba/spindle-ui@0.11.2/Button/Button.css">
<link rel="stylesheet" href="https://unpkg.com/@openameba/spindle-ui@1.0.0/Button/Button.css">
```

ただし、CSSファイルサイズやファイル数が不必要に大きくなり、CDNサーバが遅延の原因になる可能性があるため**本番Webアプリケーションでの利用は推奨していません**
Expand Down

0 comments on commit b0494ed

Please sign in to comment.