Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ドキュメント・コメント内のVibesvibesに変換 #10

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Design/Layout/Layout.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import heightImg from './height.jpg';

## ブラウザ幅に合わせてコンテンツ幅をどう表示するか
コンテンツをブラウザの横幅にあわせて無尽蔵に広げられると、右端に配置したボタン等がユーザーの目に入りにくくなります。そのためコンテンツの最大幅を設定しています。
現在のVibesでは Container コンポーネントのオプションによって、以下からレイアウトを選択することができます。
現在のvibesでは Container コンポーネントのオプションによって、以下からレイアウトを選択することができます。
- narrow: 640px = 40rem固定
- ウィザードUIなど、左右幅を大きく必要としない場合に使用します
- normal: 1120px = 70rem固定
Expand Down
12 changes: 6 additions & 6 deletions docs/Design/Readme.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ import { Meta } from "@storybook/addon-docs";

# コンポーネント設計の指針

Vibesのコンポーネントを設計するときには以下のような方針で行っています
Vibesを使用して画面を設計する際にも意識することで、デザインの一貫性を保ち、アクセシビリティを高め、実装コストを最小限にすることができます。
vibesのコンポーネントを設計するときには以下のような方針で行っています
vibesを使用して画面を設計する際にも意識することで、デザインの一貫性を保ち、アクセシビリティを高め、実装コストを最小限にすることができます。

- [Vibesのカラーパレット](?path=/docs/doc-colors--page) を使用し、適切なコントラスト比を持つ組み合わせにする
- [vibesのカラーパレット](?path=/docs/doc-colors--page) を使用し、適切なコントラスト比を持つ組み合わせにする
- CSSで `rem` によるサイズ指定を行うため、コンポーネントのサイズは16の倍数ピクセルを基準として設計する
- コンポーネントにはマージンのオプションをつけるため、コンポーネント自体には固定のマージンをつけない
- ユーザーがインタラクションできるものの輪郭は角を丸くし、そうでないものは角を丸くしない

# Vibesのコンポーネントを使った画面設計
# vibesのコンポーネントを使った画面設計

Sketch CloudからlibraryとしてSketchファイルを提供しています。
これを使うことで、簡単にSketch内でVibesコンポーネントのシンボルを使用できます
これを使うことで、簡単にSketch内でvibesコンポーネントのシンボルを使用できます

## Storybookを使った確認

Expand All @@ -27,7 +27,7 @@ Knobsを使うことで、使おうとしているものに近い状態のコン

## マージン

ほとんどのVibesのコンポーネントにはマージンを付けるためのオプションが用意されています
ほとんどのvibesのコンポーネントにはマージンを付けるためのオプションが用意されています
そのため、コンポーネントにマージンをつけるときにはこのオプションが使用できるサイズでマージンをつける必要があります。

- マージンの大きさは 0.5rem(8px), 1rem(16px), 1.5rem(24px), 2rem(32px), 3rem(48px) である必要があります
Expand Down
2 changes: 1 addition & 1 deletion docs/Storybook.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Storybookではコンポーネントの見た目や挙動や仕様を確かめ

### コンポーネントの探し方

Vibesのコンポーネントは、どのコンポーネントからも独立しているLv1と、他のコンポーネントに依存するLv2があります。
vibesのコンポーネントは、どのコンポーネントからも独立しているLv1と、他のコンポーネントに依存するLv2があります。
車輪の再発明を防ぐため、コンポーネントはまずLv2から探すようにしてください。

また、サイドバーには検索機能があります。使いたいコンポーネントの名前がわかっている場合はこちらもご利用ください。
Expand Down
2 changes: 1 addition & 1 deletion docs/TypeScript.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ TypeScriptの型定義に加えて、Flowでの型定義を `lv1.js.flow` `lv2.j

部分的にstyled-componentsを採用しはじめていますが、以下をルールとします

- Vibesの外部から利用できるかたちでstyled-components由来のpropを提供しない
- vibesの外部から利用できるかたちでstyled-components由来のpropを提供しない
- 特に as をexportしない。as を提供する場合は、使用できるtagNameを限定する
- コンポーネントは `CommonStyle` (`src/internal/CommonStyle.ts`) を extendしたもの(`styled(CommonStyle)`)が最外層にあるようにする
- ここに `ma` `mt` `mb` `mr` `mr` のようなマージンを提供するpropや、共通のフォント設定などが定義されています
Expand Down
2 changes: 1 addition & 1 deletion src/lv1/a11y/FocusHighlight.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ type Props = {
/**
* フォーカスインジケーターを非表示にしている要素を `children` に入れ、フォーカスインジケーターを表示させるためのコンポーネントです。
*
* ほとんどのVibesのコンポーネントは、フォーカスインジケーターの指定をしていないため、ブラウザが提供するものが使用されます。
* ほとんどのvibesのコンポーネントは、フォーカスインジケーターの指定をしていないため、ブラウザが提供するものが使用されます。
* そのため、ほとんどの場所ではこのコンポンーネントを使用する必要はありません。
* ブラウザが提供するフォーカスインジケーターの表示では視認性が低いなどの問題がある場合にのみ、使用してください。
*/
Expand Down
2 changes: 1 addition & 1 deletion src/lv1/forms/CheckBox.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ const CheckBoxInternal: React.ForwardRefRenderFunction<
* - 基本的に、チェックボックスのラベルには句読点は使わないようにしてください。
*
* ## accessibility
* VibesのCheckBoxコンポーネントはブラウザのデフォルト表示の見た目から変更していません
* vibesのCheckBoxコンポーネントはブラウザのデフォルト表示の見た目から変更していません
* a11yチェックにある「クリックやタッチに反応するサイズが、充分な大きさになっているか」の項目OKにして問題ありません。
*
*/
Expand Down
2 changes: 1 addition & 1 deletion src/lv1/forms/RadioButton.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ type Props = {
* - 基本的にラジオボタンのラベルには句読点は使わないようにしてください。
*
* ## accessibility
* VibesのRadioButtonコンポーネントはブラウザのデフォルト表示の見た目から変更していません
* vibesのRadioButtonコンポーネントはブラウザのデフォルト表示の見た目から変更していません
* a11yチェックにある「クリックやタッチに反応するサイズが、充分な大きさになっているか」の項目OKにして問題ありません。
*
* ラジオボタンを実装する際は、グループ単位で使用してください。
Expand Down
2 changes: 1 addition & 1 deletion src/lv2/formControl/FormControl.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ type Props = {
* * 複数のラジオボタンやテキストフィールドが入る場合には、`fieldId` を設定しないでください(`<fieldset>`と`<legend>` による表現になります)。
* この場合、個別のフィールドには別の方法でラベル付けを行ってください。
* * `CheckBox` や `RadioButton` コンポーネントは、内部 (`children` propの部分)に `<label>` 要素を持つため、何もしなくてOKです
* * テキストフィールドやセレクトボックス、Vibesのコンポーネントを使わずに作るラジオボタンやチェックボックス は、`<label>` 要素と並べて配置してください。
* * テキストフィールドやセレクトボックス、vibesのコンポーネントを使わずに作るラジオボタンやチェックボックス は、`<label>` 要素と並べて配置してください。
* * どうしても`<label>`要素が使用できない場合は、 `aria-label` 属性や `aria-labelledby` 属性を使用してください。 `TextField` `SelectBox` `TextArea` の各コンポーネントは、 `label` と `labelledby` propが `aria-label` 属性と `aria-labelledby` 属性に対応します
*/
const FormControl: React.FC<Props> = (props: Props) => {
Expand Down
2 changes: 1 addition & 1 deletion src/lv2/tagBox/MiniTag.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ type Props = {
*
* - サイズを小さくするため、タグの種別が非表示になっています
* - 可能な限り、色と種別の対応をユーザーが理解できるようにしてください
* - 色と種別の対応は、Vibes内では定義していません。プロダクト内では一貫したものを使用してください
* - 色と種別の対応は、vibes内では定義していません。プロダクト内では一貫したものを使用してください
* - 種別 (`type`) はoptionalにしていますが、複数の種別を並べて表示する場合には必ず指定してください
* - VisuallyHiddenにて、スクリーンリーダーからは読み取れるようにしてあります
*/
Expand Down
2 changes: 1 addition & 1 deletion src/utilities/VibesProvider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const deviceRemSize =
: parseFloat(getComputedStyle(document.documentElement).fontSize);

/**
* Vibes共通のコンテクストを提供するProviderコンポーネントです
* vibes共通のコンテクストを提供するProviderコンポーネントです
*
* Provider component which determine media type according to screen width.
*
Expand Down
4 changes: 2 additions & 2 deletions src/utilities/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// utilities ディレクトリの中身はVibes内部でしか使わないものとVibes外でも使いたいものの
// 整理ができていないので、Vibes外でも使うことが想定されるものだけexportする方針とします
// utilities ディレクトリの中身はvibes内部でしか使わないものとvibes外でも使いたいものの
// 整理ができていないので、vibes外でも使うことが想定されるものだけexportする方針とします

export { Ascii } from './Ascii';
export { pickCommonProps } from './commonProps';
Expand Down
2 changes: 1 addition & 1 deletion src/utilities/selfWindowNavigator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export type SelfWindowNavigationProp = {

/**
* A要素でCtrl + Clickを有効にしつつ(=別タブで開く挙動を残しつつ)、react-routerでハンドリングできるようにする。
* (実際のハンドリングはコンポーネント呼び出し側が行う。Vibesはあくまでその口を用意するスタンス
* (実際のハンドリングはコンポーネント呼び出し側が行う。vibesはあくまでその口を用意するスタンス
* 通常のリンク等の onClick とは違う挙動となるため、onClickとは別名のインタフェースとして用意することを推奨します
* 実装はreact-routerのものを参考にしています https://github.com/ReactTraining/react-router/blob/c0b8ce42d3c6b85e3a53d1c56ae12c88205d00d8/packages/react-router-dom/modules/Link.js#L35-L52
* */
Expand Down