FilePond
extends Component
in package
Table of Contents
- $id : string
- $label : mixed
- $name : string
- $options : array<string|int, mixed>
- __construct() : mixed
- Constructor for the component.
- render() : View|string
- Get the view / contents that represent the component.
Properties
$id
public
string
$id
$label
public
mixed
$label
= null
$name
public
string
$name
$options
public
array<string|int, mixed>
$options
= []
Methods
__construct()
Constructor for the component.
public
__construct(string $name, string $id[, mixed $label = null ][, array<string|int, mixed> $options = [] ]) : mixed
This component is used to create a file upload field using FilePond. It allows for easy file uploads with various options and features.
- Listens for the
ResetFile:idevent to reset the file input, - Listens for the
SetTempFile:id <fileName, url>event to set the file input, - Dispatches the
CancelFile:idevent to cancel the file upload.
Parameters
- $name : string
-
The name of the file field. It should match the name of the file field in the form.
- $id : string
-
The unique id of the file field.
- $label : mixed = null
-
The label for the file field. If not provided, it will be generated from the name.
- $options : array<string|int, mixed> = []
-
The options for the file field.
Return values
mixed —render()
Get the view / contents that represent the component.
public
render() : View|string