UNPKG

@wordpress/preferences

Version:

Utilities for managing WordPress preferences.

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

WordPress/gutenberg

59 lines (33 loc) • 1.45 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
# PreferenceToggleMenuItem `PreferenceToggleMenuItem` renders a menu item that is connected to the preference package's store, and will toggle the value of a 'preference' between true and false. This component implements a `MenuItem` component from the `@wordpress/components` package. ## Props ### scope The 'scope' of the feature. This is usually a namespaced string that represents the name of the editor (e.g. 'core/edit-post'), and often matches the name of the store for the editor. - Type: `String` - Required: Yes ### name The name of the preference to toggle (e.g. 'fixedToolbar'). - Type: `String` - Required: Yes ### label A human readable label for the feature. - Type: `String` - Required: Yes ### info A human readable description of what this toggle does. - Type: `Object` - Required: No ### messageActivated A message read by a screen reader when the feature is activated. (e.g. 'Fixed toolbar activated') - Type: `String` - Required: No ### messageDeactivated A message read by a screen reader when the feature is deactivated. (e.g. 'Fixed toolbar deactivated') - Type: `String` - Required: No ### shortcut A keyboard shortcut for the feature. This is just used for display purposes and the implementation of the shortcut should be handled separately. Consider using the `displayShortcut` helper from the `@wordpress/keycodes` package for this prop. - Type: `Array` - Required: No