Skip to content

Update relation formwidget with availables options #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update relation formwidget with availables options #243

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion backend/forms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1153,7 +1153,7 @@ Option | Description

### Relation

`relation` - renders either a dropdown or checkbox list according to the field relation type. Singular relationships display a dropdown, multiple relationships display a checkbox list. The label used for displaying each relation is sourced by the `nameFrom` or `select` definition.
`relation` - renders either a dropdown or checkbox list according to the field relation type. Singular relationships display a dropdown, multiple relationships display checkbox as an indented list or as a collapsable tree. The label used for displaying each relation is sourced by the `nameFrom` or `select` definition.

```yaml
categories:
Expand All @@ -1180,6 +1180,9 @@ Option | Description
`order` | an order clause to sort options by. Example: `name desc`.
`emptyOption` | text to display when there is no available selections.
`scope` | specifies a [query scope method](../database/model#query-scopes) defined in the **related form model** to apply to the list query always.
`quickselect` | if true, controls allowing all/none checkboxes to be selected will be displayed.
`displayTree` | if true and the related model implements [NestedTree](./database/traits#nested-tree) trait, display the list as a collapsable tree.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Under what conditions would you want a tree relationship to not display like a tree (i.e. set this to false)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To keep the default behavior.

`quickTreeActions` | if true and `displayTree` is true, display controls to open all, open selected or close all tree nodes.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Under what conditions would you want to disable those buttons?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With "short" list which doesn't have a lot of nodes maybe!?


### Relation Manager

Expand Down