gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(docs-widget-file) Update Docs: Widgets “file” (#5421)

Browse Source 
* Update Docs: Widgets “file”

* Update file.md

Co-authored-by: Erez Rokah <erezrokah@users.noreply.github.com>
This commit is contained in:
Joshua Goossen 2021-05-23 03:37:31 -03:00 committed by GitHub
parent 03362ef5ab
commit 697624bc97
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
website/content/docs/widgets/file.md
View File

@ -1,27 +1,30 @@
---
label: "File"
title: file
label: File
---
The file widget allows editors to upload a file or select an existing one from the media library. The path to the file will be saved to the field as a string.
- **Name:** `file`
- **UI:** file picker button opens media gallery
- **Data type:** file path string
- **Options:**
- `default`: accepts a file path string; defaults to null
- `media_library`: media library settings to apply when a media library is opened by the
* **Name:** `file`
* **UI:** file picker button opens media gallery
* **Data type:** file path string
* **Options:**
* `default`: accepts a file path string; defaults to null
* `media_library`: media library settings to apply when a media library is opened by the
current widget
- `allow_multiple`: _(default: `true`)_ when set to `false`, prevents multiple selection for any media library extension, but must be supported by the extension in use
- `config`: a configuration object that will be passed directly to the media library being
* `allow_multiple`: *(default: `true`)* when set to `false`, prevents multiple selection for any media library extension, but must be supported by the extension in use
* `config`: a configuration object that will be passed directly to the media library being
used - available options are determined by the library
- **Example:**
```yaml
- label: "Manual PDF"
name: "manual_pdf"
widget: "file"
default: "/uploads/general-manual.pdf"
media_library:
config:
multiple: true
```
* `media_folder` (Beta): file path where uploaded files will be saved specific to this control. Paths can be relative to a collection folder (e.g. `files` will add the file to a sub-folder in the collection folder) or absolute with reference to the base of the repo which needs to begin with `/` (e.g `/static/files` will save uploaded files to the `static` folder in a sub folder named `files`)
* **Example:**
```yaml
- label: "Manual PDF"
name: "manual_pdf"
widget: "file"
default: "/uploads/general-manual.pdf"
media_library:
config:
multiple: true
```