From d47331342dc6521ae52e56496be537c9e716a25a Mon Sep 17 00:00:00 2001 From: AIC BV <89913092+AIC-BV@users.noreply.github.com> Date: Fri, 30 Aug 2024 09:55:03 +0200 Subject: [PATCH 1/4] Add documentation for allowDismiss and cssClass --- backend/relations.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/backend/relations.md b/backend/relations.md index 9f7cd018..b4df576c 100644 --- a/backend/relations.md +++ b/backend/relations.md @@ -103,6 +103,8 @@ Option | Type | Description `noRecordsMessage` | List | a message to display when no records are found, can refer to a [localization string](../plugin/localization). `conditions` | List | specifies a raw where query statement to apply to the list model query. `scope` | List | specifies a [query scope method](../database/model#query-scopes) defined in the **related form model** to apply to the list query always. The model that this relationship will be attached to (i.e. the **parent model**) is passed to this scope method as the second parameter (`$query` is the first). +`allowDismiss` | List | closes the modal when clicking next to it. Default: `false` +`cssClass` | List | Adds extra CSS classes to the modal. Default: `null` **filter** | List | a reference to a filter scopes definition file, see [backend list filters](lists#using-list-filters). These configuration values can be specified only for the **view** options. From 81449dd7311206de7ec94caa37f04651a06f073d Mon Sep 17 00:00:00 2001 From: AIC BV <89913092+AIC-BV@users.noreply.github.com> Date: Fri, 18 Jul 2025 15:57:09 +0200 Subject: [PATCH 2/4] Move new properties to manage section --- backend/relations.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/backend/relations.md b/backend/relations.md index b4df576c..bfc2695c 100644 --- a/backend/relations.md +++ b/backend/relations.md @@ -103,8 +103,6 @@ Option | Type | Description `noRecordsMessage` | List | a message to display when no records are found, can refer to a [localization string](../plugin/localization). `conditions` | List | specifies a raw where query statement to apply to the list model query. `scope` | List | specifies a [query scope method](../database/model#query-scopes) defined in the **related form model** to apply to the list query always. The model that this relationship will be attached to (i.e. the **parent model**) is passed to this scope method as the second parameter (`$query` is the first). -`allowDismiss` | List | closes the modal when clicking next to it. Default: `false` -`cssClass` | List | Adds extra CSS classes to the modal. Default: `null` **filter** | List | a reference to a filter scopes definition file, see [backend list filters](lists#using-list-filters). These configuration values can be specified only for the **view** options. @@ -124,6 +122,8 @@ Option | Type | Description ------------- | ------------- | ------------- `title` | Both | a popup title, can refer to a [localization string](../plugin/localization).
Additionally, you can customize the title for each mode individually by setting this to an associative array, with the key being the mode and the value being the title used when displaying that mode. Eg: `form: acme.blog::lang.subcategory.FormTitle`. `context` | Form | context of the form being displayed. Can be a string or an array with keys: create, update. +`allowDismiss` | Both | closes the modal when clicking next to it. Default: `false` +`cssClass` | Both | Adds extra CSS classes to the modal. Default: `null` ## Relationship types From 37fbc445aa29325b7761204f9766ed72dd22b851 Mon Sep 17 00:00:00 2001 From: Meindert Date: Tue, 28 Jul 2026 08:56:43 +0200 Subject: [PATCH 3/4] Rename cssClass to popupClass, document size and dismiss behaviour - Rename cssClass to popupClass as requested in review - Document the now-configurable size option and its default - Clarify that allowDismiss keeps the popup open while it contains unsaved changes tracked by the change monitor Co-Authored-By: Claude Fable 5 --- backend/relations.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/backend/relations.md b/backend/relations.md index 2c278c97..f83298b5 100644 --- a/backend/relations.md +++ b/backend/relations.md @@ -123,8 +123,9 @@ Option | Type | Description ------------- | ------------- | ------------- `title` | Both | a popup title, can refer to a [localization string](../plugin/localization).
Additionally, you can customize the title for each mode individually by setting this to an associative array, with the key being the mode and the value being the title used when displaying that mode. Eg: `form: acme.blog::lang.subcategory.FormTitle`. `context` | Form | context of the form being displayed. Can be a string or an array with keys: create, update. -`allowDismiss` | Both | closes the modal when clicking next to it. Default: `false` -`cssClass` | Both | Adds extra CSS classes to the modal. Default: `null` +`size` | Both | the size of the popup used to manage records. Available sizes: `giant`, `huge`, `large`, `small`, `tiny`, `adaptive`. Default: `huge` +`popupClass` | Both | custom CSS class(es) to apply to the popup used to manage records. Default: `null` +`allowDismiss` | Both | allows the popup to be dismissed by clicking the backdrop area next to it. The popup stays open if it contains unsaved changes tracked by the change monitor (`data-change-monitor`). Default: `false` ## Relationship types From 0de9539e7a5539be6fbaae3df681499de709ea78 Mon Sep 17 00:00:00 2001 From: Meindert Date: Tue, 28 Jul 2026 09:29:55 +0200 Subject: [PATCH 4/4] Describe the unsaved-changes behaviour of allowDismiss Co-Authored-By: Claude Fable 5 --- backend/relations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/backend/relations.md b/backend/relations.md index f83298b5..fb8618f5 100644 --- a/backend/relations.md +++ b/backend/relations.md @@ -125,7 +125,7 @@ Option | Type | Description `context` | Form | context of the form being displayed. Can be a string or an array with keys: create, update. `size` | Both | the size of the popup used to manage records. Available sizes: `giant`, `huge`, `large`, `small`, `tiny`, `adaptive`. Default: `huge` `popupClass` | Both | custom CSS class(es) to apply to the popup used to manage records. Default: `null` -`allowDismiss` | Both | allows the popup to be dismissed by clicking the backdrop area next to it. The popup stays open if it contains unsaved changes tracked by the change monitor (`data-change-monitor`). Default: `false` +`allowDismiss` | Both | allows the popup to be dismissed by clicking the backdrop area next to it. If the popup contains unsaved changes, it stays open, shakes and shows a warning flash message instead. Default: `false` ## Relationship types