Add default values to JSDoc and README

WordPress · Nov 28, 2022 · 559e5ee · 559e5ee
1 parent 24b46e3
commit 559e5ee
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/packages/components/src/base-field/README.md b/packages/components/src/base-field/README.md
@@ -49,15 +49,18 @@ Whether the field is disabled.
 Renders an error style around the component.
 
 -   Required: No
+-   Default: `false`
 
 ### `isInline`: `boolean`
 
 Renders a component that can be inlined in some text.
 
 -   Required: No
+-   Default: `false`
 
 ### `isSubtle`: `boolean`
 
 Renders a subtle variant of the component.
 
 -   Required: No
+-   Default: `false`
diff --git a/packages/components/src/base-field/types.ts b/packages/components/src/base-field/types.ts
@@ -10,14 +10,20 @@ export type BaseFieldProps = FlexProps & {
 	disabled?: boolean;
 	/**
 	 * Renders an error style around the component.
+	 *
+	 * @default false
 	 */
 	hasError?: boolean;
 	/**
 	 * Renders a component that can be inlined in some text.
+	 *
+	 * @default false
 	 */
 	isInline?: boolean;
 	/**
 	 * Renders a subtle variant of the component.
+	 *
+	 * @default false
 	 */
 	isSubtle?: boolean;
 };