Skip to content

Revise partial field documentation #130

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

Merged
LukeTowers merged 2 commits into from
May 17, 2023
Merged

Revise partial field documentation #130

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5d71ae
document the new $previewMode variable passed to partial fields
mjauvin May 16, 2023
9565b41
Update backend-forms.md
LukeTowers May 17, 2023
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
7 changes: 6 additions & 1 deletion backend-forms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -649,7 +649,12 @@ For more information on model validation, please visit [the documentation page](
<a name="field-partial"></a>
### Partial

`partial` - renders a partial, the `path` value can refer to a partial view file otherwise the field name is used as the partial name. Inside the partial these variables are available: `$value` is the default field value, `$model` is the model used for the field and `$field` is the configured class object `Backend\Classes\FormField`.
`partial` - renders a backend partial. If `path` option is not set the field name is used as the partial name when attempting to locate the partial. The following variables are available to the partial being rendered:

- `$formWidget`: The instance of the `Backend\Widgets\Form` class that this field belongs to
- `$formModel` or `$model`: The instance of the `Model` attached to this form.
- `$formField` or `$field`: The instance of `Backend\Classes\FormField` for this field.
- `$formValue` or `$value`: The value of this field instance.

```yaml
content:
Expand Down