Skip to content

Improve readability #233

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 1 commit into from
Apr 21, 2025
Merged

Improve readability #233

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
6 changes: 3 additions & 3 deletions backend/forms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -863,16 +863,16 @@ avatar:

Option | Description
------------- | -------------
`mode` | the expected file type, either file or image. Default: image.
`mode` | the expected file type, either `file` or `image`. Default: `image`.
`imageWidth` | if using image type, the image will be resized to this width, optional.
`imageHeight` | if using image type, the image will be resized to this height, optional.
`fileTypes` | file extensions that are accepted by the uploader, optional. Eg: `zip,txt`
`mimeTypes` | MIME types that are accepted by the uploader, either as file extension or fully qualified name, optional. Eg: `bin,txt`
`maxFilesize` | file size in Mb that are accepted by the uploader, optional. Default: from "upload_max_filesize" param value
`useCaption` | allows a title and description to be set for the file. Default: true
`useCaption` | allows a title and description to be set for the file. Default: `true`
`prompt` | text to display for the upload button, applies to files only, optional.
`thumbOptions` | options to pass to the thumbnail generating method for the file. See [Image Resizing](../services/image-resizing#available-parameters)
`attachOnUpload` | Automatically attaches the uploaded file on upload if the parent record exists instead of using deferred binding to attach on save of the parent record. Defaults to false.
`attachOnUpload` | Automatically attaches the uploaded file on upload if the parent record exists instead of using deferred binding to attach on save of the parent record. Defaults to `false`.

> **NOTE:** Unlike the [Media Finder FormWidget](#media-finder), the File Upload FormWidget uses [database file attachments](../database/attachments); so the field name must match a valid `attachOne` or `attachMany` relationship on the Model associated with the Form. **IMPORTANT:** Having a database column with the name used by this field type (i.e. a database column with the name of an existing `attachOne` or `attachMany` relationship) **will** cause this FormWidget to break. Use database columns with the Media Finder FormWidget and file attachment relationships with the File Upload FormWidget.

Expand Down