FormFileUpload Edit

Usage Usage

import { FormFileUpload } from '@wordpress/components';

const MyFormFileUpload = () => (
    <FormFileUpload
        accept="image/*"
        onChange={ () => console.log('new image') }
    >
        Upload
    </FormFileUpload>
);

Top ↑

Props Props

The component accepts the following props. Props not included in this set will be passed to the IconButton component.

accept accept

A string passed to input element that tells the browser which file types can be upload to the upload by the user use. e.g: image/*,video/*.
More information about this string is available in https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#Unique_file_type_specifiers.

  • Type: String
  • Required: No

Top ↑

children children

Children are passed as children of IconButton.

  • Type: Boolean
  • Required: No

Top ↑

icon icon

The icon to render. Supported values are: Dashicons (specified as strings), functions, WPComponent instances and null.

  • Type: String|Function|WPComponent|null
  • Required: No
  • Default: null

Top ↑

multiple multiple

Whether to allow multiple selection of files or not.

  • Type: Boolean
  • Required: No
  • Default: false

Top ↑

onChange onChange

Callback function passed directly to the input file element.

  • Type: Function
  • Required: Yes

Top ↑

render render

Optional callback function used to render the UI. If passed the component does not render any UI and calls this function to render it.
This function receives an object with the property openFileDialog. The property is a function that when called opens the browser window to upload files.

  • Type: Function
  • Required: No