Fix #2831: DialogFramework document contentWidth=auto (#7456)

primefaces · Jun 23, 2021 · 3a452a3 · 3a452a3
1 parent 3c08c5f
commit 3a452a3
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/docs/10_0_0/core/dialogframework.md b/docs/10_0_0/core/dialogframework.md
@@ -97,6 +97,8 @@ public void view() {
 }
 ```
 
+!> If you use `contentWidth` you cannot use `contentWidth="auto"` because the dialog is displayed inside an IFrame. See: https://github.com/primefaces/primefaces/issues/2831
+
 Here is the full list of configuration options:
 
 | Name | Default | Type | Description |
@@ -107,7 +109,7 @@ Here is the full list of configuration options:
 | draggable | true | Boolean | When enabled, makes dialog draggable. |
 | width | auto | String | Width of the dialog. |
 | height | auto | String | Height of the dialog. |
-| contentWidth | 640 | String | Width of the dialog content. |
+| contentWidth | 640 | String | Width of the dialog content. NOTE: 'auto' cannot be used because the dialog is displayed in an IFrame.|
 | contentHeight | auto | String | Height of the dialog content. |
 | closable | true | Boolean | Whether the dialog can be closed or not. |
 | includeViewParams | false | Boolean | When enabled, includes the view parameters. |

diff --git a/docs/11_0_0/core/dialogframework.md b/docs/11_0_0/core/dialogframework.md
@@ -97,6 +97,8 @@ public void view() {
 }
 ```
 
+!> If you use `contentWidth` you cannot use `contentWidth="auto"` because the dialog is displayed inside an IFrame. See: https://github.com/primefaces/primefaces/issues/2831
+
 Here is the full list of configuration options:
 
 | Name | Default | Type | Description |
@@ -107,7 +109,7 @@ Here is the full list of configuration options:
 | draggable | true | Boolean | When enabled, makes dialog draggable. |
 | width | auto | String | Width of the dialog. |
 | height | auto | String | Height of the dialog. |
-| contentWidth | 640 | String | Width of the dialog content. |
+| contentWidth | 640 | String | Width of the dialog content. NOTE: 'auto' cannot be used because the dialog is displayed in an IFrame. |
 | contentHeight | auto | String | Height of the dialog content. |
 | closable | true | Boolean | Whether the dialog can be closed or not. |
 | includeViewParams | false | Boolean | When enabled, includes the view parameters. |

diff --git a/docs/8_0/core/dialogframework.md b/docs/8_0/core/dialogframework.md
@@ -95,6 +95,8 @@ public void view() {
 }
 ```
 
+!> If you use `contentWidth` you cannot use `contentWidth="auto"` because the dialog is displayed inside an IFrame. See: https://github.com/primefaces/primefaces/issues/2831
+
 Here is the full list of configuration options;
 
 | Name | Default | Type | Description |
@@ -105,7 +107,7 @@ resizable | true | Boolean | When enabled, makes dialog resizable.
 draggable | true | Boolean | When enabled, makes dialog draggable.
 width | auto | String | Width of the dialog.
 height | auto | String | Height of the dialog.
-contentWidth | 640 | String | Width of the dialog content.
+contentWidth | 640 | String | Width of the dialog content. NOTE: 'auto' cannot be used because the dialog is displayed in an IFrame.
 contentHeight | auto | String | Height of the dialog content.
 closable | true | Boolean | Whether the dialog can be closed or not.
 includeViewParams | false | Boolean | When enabled, includes the view parameters.