add prop comments

Signed-off-by: hiroki.yokouchi <[email protected]>
ubie-oss · Jul 12, 2024 · e9f6b92 · e9f6b92
1 parent 5e75993
commit e9f6b92
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/components/Pre/Pre.tsx b/src/components/Pre/Pre.tsx
@@ -7,7 +7,15 @@ import styles from './Pre.module.css';
 type AllowedSpanAttributes = Omit<HTMLAttributes<HTMLSpanElement>, 'className'>;
 
 type Props = {
+  /**
+   * 折り返しや空白、改行の扱い
+   * @default 'pre-line'
+   */
   whiteSpace?: 'pre' | 'pre-wrap' | 'pre-line' | 'break-spaces';
+  /**
+   * inline-blockとして扱う
+   * @default false
+   */
   inline?: boolean;
 } & AllowedSpanAttributes;