From 79902a6d7ada159ef53ae5647e0c0dbb9243336a Mon Sep 17 00:00:00 2001 From: 8845musign <8845musign@gmail.com> Date: Fri, 15 Nov 2024 11:51:43 +0900 Subject: [PATCH] In the case of boolean, do not write the default value (because it is false by default). --- src/components/ActionHalfModal/ActionHalfModal.tsx | 2 -- src/components/ActionModal/ActionModal.tsx | 1 - src/components/Box/Box.tsx | 1 - src/components/Button/ButtonTypes.ts | 3 +-- src/components/Center/Center.tsx | 2 -- src/components/CheckboxCard/CheckboxCard.tsx | 3 +-- src/components/Flex/Flex.tsx | 4 +--- src/components/MessageHalfModal/MessageHalfModal.tsx | 7 ++----- src/components/MessageModal/MessageModal.tsx | 6 ++---- src/components/Pre/Pre.tsx | 1 - src/components/RadioCard/RadioCard.tsx | 3 +-- src/components/Select/Select.tsx | 3 +-- src/components/TextArea/TextArea.tsx | 6 ++---- src/components/Toggle/Toggle.tsx | 3 +-- 14 files changed, 12 insertions(+), 33 deletions(-) diff --git a/src/components/ActionHalfModal/ActionHalfModal.tsx b/src/components/ActionHalfModal/ActionHalfModal.tsx index e12d9896..00dbd351 100644 --- a/src/components/ActionHalfModal/ActionHalfModal.tsx +++ b/src/components/ActionHalfModal/ActionHalfModal.tsx @@ -52,12 +52,10 @@ type BaseProps = { open?: boolean; /** * openを無視してモーダルを開いたままにするかどうか。アニメーションライブラリとの連携で、ActionHalfModal自身が開閉に関与しない場合に使用 - * @default false */ isStatic?: boolean; /** * モーダルをフルスクリーンで表示するかどうか - * @default false */ fullscreen?: boolean; /** diff --git a/src/components/ActionModal/ActionModal.tsx b/src/components/ActionModal/ActionModal.tsx index 9d64198f..4bb065e9 100644 --- a/src/components/ActionModal/ActionModal.tsx +++ b/src/components/ActionModal/ActionModal.tsx @@ -65,7 +65,6 @@ type BaseProps = { open?: boolean; /** * openを無視してモーダルを開いたままにするかどうか。アニメーションライブラリとの連携で、ActionHalfModal自身が開閉に関与しない場合に使用 - * @default false */ isStatic?: boolean; /** diff --git a/src/components/Box/Box.tsx b/src/components/Box/Box.tsx index 1357a9df..d32b573d 100644 --- a/src/components/Box/Box.tsx +++ b/src/components/Box/Box.tsx @@ -69,7 +69,6 @@ type BaseProps = { textNoWrap?: boolean; /** * inline-blockとして扱う - * @default false */ inline?: boolean; } & PaddingProps & diff --git a/src/components/Button/ButtonTypes.ts b/src/components/Button/ButtonTypes.ts index f554cb91..ba5a6f4d 100644 --- a/src/components/Button/ButtonTypes.ts +++ b/src/components/Button/ButtonTypes.ts @@ -28,8 +28,7 @@ export type BaseProps = { */ size?: 'large' | 'medium' | 'small'; /** - * 横幅を100%占有するかどうか - * @default false + * 横幅を100%占有する */ block?: boolean; /** diff --git a/src/components/Center/Center.tsx b/src/components/Center/Center.tsx index fc81cf6e..ddc6c43f 100644 --- a/src/components/Center/Center.tsx +++ b/src/components/Center/Center.tsx @@ -26,12 +26,10 @@ type Props = { as?: HTMLTagname | ReactElement>; /** * 内包するテキストを中央に配置。設定は継承され、子孫要素にも影響します - * @default false */ textCenter?: boolean; /** * 子要素を中央に配置。孫要素には影響しません - * @default false */ childrenCenter?: boolean; /** diff --git a/src/components/CheckboxCard/CheckboxCard.tsx b/src/components/CheckboxCard/CheckboxCard.tsx index 8f3bd62e..46c00f9a 100644 --- a/src/components/CheckboxCard/CheckboxCard.tsx +++ b/src/components/CheckboxCard/CheckboxCard.tsx @@ -7,8 +7,7 @@ import { Icon } from '../Icon/Icon'; type Props = InputHTMLAttributes & { /** - * 横幅を100%占有するかどうか - * @default false + * 横幅を100%占有する */ block?: boolean; }; diff --git a/src/components/Flex/Flex.tsx b/src/components/Flex/Flex.tsx index 3a3af4fd..72260eb1 100644 --- a/src/components/Flex/Flex.tsx +++ b/src/components/Flex/Flex.tsx @@ -38,8 +38,7 @@ type Props = { */ justifyContent?: JustifyContent; /** - * 折り返しの有無 - * @default false + * 子要素の折り返しを許可 */ wrap?: boolean; /** @@ -53,7 +52,6 @@ type Props = { width?: 'full' | CSSWitdh; /** * inline-flexとして扱う - * @default false */ inline?: boolean; } & MarginProps & diff --git a/src/components/MessageHalfModal/MessageHalfModal.tsx b/src/components/MessageHalfModal/MessageHalfModal.tsx index 92d445f5..d6147e4a 100644 --- a/src/components/MessageHalfModal/MessageHalfModal.tsx +++ b/src/components/MessageHalfModal/MessageHalfModal.tsx @@ -21,7 +21,6 @@ type BaseProps = { * ヘッダーに表示する見出しテキスト */ header?: string; - /** * 閉じるボタンのラベル * @default 閉じる @@ -43,13 +42,11 @@ type BaseProps = { */ open?: boolean; /** - * openを無視してモーダルを開いたままにするかどうか。アニメーションライブラリとの連携で、ActionHalfModal自身が開閉に関与しない場合に使用 - * @default false + * openを無視してモーダルを開いたままにするか。アニメーションライブラリとの連携で、ActionHalfModal自身が開閉に関与しない場合に使用 */ isStatic?: boolean; /** - * モーダルをフルスクリーンで表示するかどうか - * @default false + * モーダルをフルスクリーンで表示する */ fullscreen?: boolean; /** diff --git a/src/components/MessageModal/MessageModal.tsx b/src/components/MessageModal/MessageModal.tsx index 8a56b38e..0eb30915 100644 --- a/src/components/MessageModal/MessageModal.tsx +++ b/src/components/MessageModal/MessageModal.tsx @@ -32,8 +32,7 @@ type Props = { */ overlayOpacity?: Opacity; /** - * 画面を占有する高さで固定するかどうか - * @default false + * 画面を占有する高さで固定する */ fixedHeight?: boolean; /** @@ -42,8 +41,7 @@ type Props = { */ open?: boolean; /** - * openを無視してモーダルを開いたままにするかどうか。アニメーションライブラリとの連携で、ActionHalfModal自身が開閉に関与しない場合に使用 - * @default false + * openを無視してモーダルを開いたままにする。アニメーションライブラリとの連携で、ActionHalfModal自身が開閉に関与しない場合に使用 */ isStatic?: boolean; /** diff --git a/src/components/Pre/Pre.tsx b/src/components/Pre/Pre.tsx index bfdb2ed5..36135bea 100644 --- a/src/components/Pre/Pre.tsx +++ b/src/components/Pre/Pre.tsx @@ -14,7 +14,6 @@ type Props = { whiteSpace?: 'pre' | 'pre-wrap' | 'pre-line' | 'break-spaces'; /** * inline-blockとして扱う - * @default false */ inline?: boolean; } & AllowedSpanAttributes; diff --git a/src/components/RadioCard/RadioCard.tsx b/src/components/RadioCard/RadioCard.tsx index efb5361d..94823707 100644 --- a/src/components/RadioCard/RadioCard.tsx +++ b/src/components/RadioCard/RadioCard.tsx @@ -20,8 +20,7 @@ type Props = Omit, 'name' | 'value' */ children: React.InputHTMLAttributes['children']; /** - * 横幅を100%占有するかどうか - * @default false + * 横幅を100%占有する */ block?: boolean; }; diff --git a/src/components/Select/Select.tsx b/src/components/Select/Select.tsx index f21dffb1..99634b59 100644 --- a/src/components/Select/Select.tsx +++ b/src/components/Select/Select.tsx @@ -17,8 +17,7 @@ type Props = CustomDataAttributeProps & { */ isInvalid?: boolean; /** - * フィールドを無効化するかどうか - * @default false + * フィールドを無効化する */ disabled?: boolean; /** diff --git a/src/components/TextArea/TextArea.tsx b/src/components/TextArea/TextArea.tsx index 68d305b8..1bda7be0 100644 --- a/src/components/TextArea/TextArea.tsx +++ b/src/components/TextArea/TextArea.tsx @@ -8,13 +8,11 @@ import type { TextareaHTMLAttributes } from 'react'; type Props = { /** - * 有効でない入力を保持しているかどうか - * @default false + * 値が不正であることを示す */ isInvalid?: boolean; /** - * フィールドを無効化するかどうか - * @default false + * フィールドを無効化する */ disabled?: boolean; } & TextareaHTMLAttributes & diff --git a/src/components/Toggle/Toggle.tsx b/src/components/Toggle/Toggle.tsx index 19ef853c..53151621 100644 --- a/src/components/Toggle/Toggle.tsx +++ b/src/components/Toggle/Toggle.tsx @@ -11,8 +11,7 @@ type Props = { */ checked?: boolean; /** - * 初期状態が選択状態かどうか - * @default false + * 初期状態で選択状態とする */ defaultChecked?: boolean; /**