In the case of boolean, do not write the default value (because it is…

… false by default).
ubie-oss · Nov 15, 2024 · 79902a6 · 79902a6
1 parent ec933f2
commit 79902a6
Show file tree

Hide file tree

Showing 14 changed files with 12 additions and 33 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -26,12 +26,10 @@ type Props = {
   as?: HTMLTagname | ReactElement<ComponentType<typeof Box>>;
   /**
    * 内包するテキストを中央に配置。設定は継承され、子孫要素にも影響します
-   * @default false
    */
   textCenter?: boolean;
   /**
    * 子要素を中央に配置。孫要素には影響しません
-   * @default false
    */
   childrenCenter?: boolean;
   /**

diff --git a/src/components/CheckboxCard/CheckboxCard.tsx b/src/components/CheckboxCard/CheckboxCard.tsx
@@ -7,8 +7,7 @@ import { Icon } from '../Icon/Icon';
 
 type Props = InputHTMLAttributes<HTMLInputElement> & {
   /**
-   * 横幅を100%占有するかどうか
-   * @default false
+   * 横幅を100%占有する
    */
   block?: boolean;
 };

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -20,8 +20,7 @@ type Props = Omit<React.InputHTMLAttributes<HTMLInputElement>, 'name' | 'value'
      */
     children: React.InputHTMLAttributes<HTMLInputElement>['children'];
     /**
-     * 横幅を100%占有するかどうか
-     * @default false
+     * 横幅を100%占有する
      */
     block?: boolean;
   };

diff --git 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
@@ -8,13 +8,11 @@ import type { TextareaHTMLAttributes } from 'react';
 
 type Props = {
   /**
-   * 有効でない入力を保持しているかどうか
-   * @default false
+   * 値が不正であることを示す
    */
   isInvalid?: boolean;
   /**
-   * フィールドを無効化するかどうか
-   * @default false
+   * フィールドを無効化する
    */
   disabled?: boolean;
 } & TextareaHTMLAttributes<HTMLTextAreaElement> &

diff --git a/src/components/Toggle/Toggle.tsx b/src/components/Toggle/Toggle.tsx
@@ -11,8 +11,7 @@ type Props = {
    */
   checked?: boolean;
   /**
-   * 初期状態が選択状態かどうか
-   * @default false
+   * 初期状態で選択状態とする
    */
   defaultChecked?: boolean;
   /**