UNPKG

@wordpress/interface

Version:

Interface module for WordPress. The package contains shared functionality across the modern JavaScript-based WordPress screens.

github.com/WordPress/gutenberg/tree/HEAD/packages/interface/README.md

WordPress/gutenberg

35 lines (20 loc) • 973 B
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
# PinnedItems There are situations where a screen has an area for favorites or pinned items. This Component allows adding items to that area. Most of the time, the Component should not be used directly as, for example, `ComplementaryArea` Component already renders PinnedItems that allow opening complementary areas marked as favorite. When used directly, items should not unconditionally add items should only be added if they are marked as "favorite" or verify other conditions. ## Props ### children The content to be displayed for the pinned items. Most of the time, a button with an icon should be used. - Type: `Element` - Required: Yes ### scope The scope of the pinned items area e.g: "core", "myplugin/custom-screen-a", - Type: `String` - Required: Yes # PinnedItems.Slot A slot that renders the pinned items. ## Props ### scope The scope of the pinned items area e.g: "core", "myplugin/custom-screen-a", - Type: `String` - Required: Yes