UNPKG

@wordpress/block-editor

Version:

Generic block editor.

github.com/WordPress/gutenberg/tree/HEAD/packages/block-editor/README.md

WordPress/gutenberg

108 lines (62 loc) • 2.43 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# Media replace flow A component that implements a replacement flow for various media objects. It is used to allow various blocks that use media to have a toolbar button for replacing it. I offers several options, such as: - replace from Media Library - replace using an URL - replace by uploading new media This component should be used as a child of a `<BlockControls>` component. ## Props ### mediaURL The URL of the media. - Type: `string` - Required: Yes ### mediaId The Id of the attachment post type for the current media. - Type: `Int` - Required: No ### allowedTypes A list of media types allowed to replace the current media. - Type: `Array` - Required: Yes ### accept Comma delimited list of MIME types accepted for upload. - Type: `string` - Required: Yes ### onFilesUpload Callback called before to start to upload the files. It receives an array with the files to upload before to the final process. ### onSelect Callback used when media is replaced from the Media Library or when a new media is uploaded. It is called with one argument `media` which is an object with all the media details. - Type: `func` - Required: Yes ### onSelectURL Callback used when media is replaced with an URL. It is called with one argument `newURL` which is a `string` containing the new URL. - Type: `func` - Required: No ### onError Callback called when an upload error happens and receives an error message as an argument. - Type: `func` - Required: No ### name A `string` value will be used as the label of the replace button. It can also accept `Phrasing content` elements(ex. `span`). - Type: `string|Element` - Required: No - Default: `Replace` ### createNotice Creates a media replace notice. - Type: `func` - Required: No ### removeNotice Removes a media replace notice. - Type: `func` - Required: No ### children - Type: `Element` - Required: No If passed, children are rendered inside the dropdown. ### children - Type: `Element | func` - Required: No If passed, children are rendered inside the dropdown. If a function is provided for this prop, it will receive an object with the `onClose` prop as an argument. ### renderToggle - Type: `func` - Required: No If passed, it will be used to render the provided button instead of the default one. It should accept and pass through `button` props to a `button` element.