Skip to content
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

Jump to bottom

Add docs for limit option in relationships #1281

Merged
merged 1 commit into from
Oct 13, 2023
Merged

Add docs for limit option in relationships #1281

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
17 changes: 9 additions & 8 deletions docs/contenttypes/relationships.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,15 @@ entries:

The `relations` are defined by the `slug` of the ContentType that it's related to. If a slug is not explicitly defined for a ContentType, the `name` is used. In the example above, it is `pages`. It takes a few parameters:

| Parameter | Description |
|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `required` | `true` or `false`, to determine if the user must pick a related record. Defaults to `true`. |
| `multiple` | `true` or `false`, to indicate whether the user can pick one related record, or more than one. Defaults to `false`. |
| `label` | The label to show on the edit screen. |
| `order` | The order in which the items are listed on the edit screen. This can be any field in the ContentType. Prefix with `-` to reverse the sorting. In the case of the example, `-id` means that the records that were created last are at the top.
| `format` | How to show the titles for each record that can be selected. For example if you have two fields for firstname and lastname you might put `'{{firstname}} {{lastname}}'` here. The default is `'{title} (№ {id}, {status})'` |
| `link_to_record` | `true` or `false`, to indicate wether or not to display the pencil icon with a link to the related edit Record page. Defaults to `false`. |
| Parameter | Description |
|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `required` | `true` or `false`, to determine if the user must pick a related record. Defaults to `true`. |
| `multiple` | `true` or `false`, to indicate whether the user can pick one related record, or more than one. Defaults to `false`. |
| `label` | The label to show on the edit screen. |
| `order` | The order in which the items are listed on the edit screen. This can be any field in the ContentType. Prefix with `-` to reverse the sorting. In the case of the example, `-id` means that the records that were created last are at the top.
| `format` | How to show the titles for each record that can be selected. For example if you have two fields for firstname and lastname you might put `'{{firstname}} {{lastname}}'` here. The default is `'{title} (№ {id}, {status})'`
| `limit` | Limits the number of related records that are returned`. Defaults to 2000. |
| `link_to_record` | `true` or `false`, to indicate wether or not to display the pencil icon with a link to the related edit Record page. Defaults to `false`. |

Editing a record that has relations defined looks like this:

Expand Down