add note highlighting isFullScreen taking precedence

WordPress · Sep 29, 2023 · 14669de · 14669de
1 parent d630574
commit 14669de
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/packages/components/src/modal/README.md b/packages/components/src/modal/README.md
@@ -223,7 +223,7 @@ This property when set to `true` will render a full screen modal.
 
 #### `size`: `'small' | 'medium' | 'large' | 'fill'`
 
-If this property is added it will cause the modal to render at a preset width, or expand to fill the screen.
+If this property is added it will cause the modal to render at a preset width, or expand to fill the screen. This prop will be ignored if `isFullScreen` is set to `true`.
 
 -   Required: No
 

diff --git a/packages/components/src/modal/types.ts b/packages/components/src/modal/types.ts
@@ -98,7 +98,8 @@ export type ModalProps = {
 	isFullScreen?: boolean;
 	/**
 	 * If this property is added it will cause the modal to render at a preset
-	 * width, or expand to fill the screen.
+	 * width, or expand to fill the screen. This prop will be ignored if
+	 * `isFullScreen` is set to `true`.
 	 *
 	 * Note: `Modal`'s width can also be controlled by adjusting the width of the
 	 * modal's contents, or via CSS using the `style` prop.