@wordpress/preferences 1.0.0

package/README.md

@@ -0,0 +1,174 @@
+# Preferences
+
+Utilities for storing WordPress preferences.
+
+## Installation
+
+Install the module
+
+```bash
+npm install @wordpress/preferences --save
+```
+
+_This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for such language features and APIs, you should include [the polyfill shipped in `@wordpress/babel-preset-default`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/babel-preset-default#polyfill) in your code._
+
+## Examples
+
+### Data store
+
+Preferences are persisted values of any kind.
+
+Set the default preferences for any features on initialization by dispatching an action:
+
+```js
+import { dispatch } from '@wordpress/data';
+import { store as preferencesStore } from '@wordpress/preferences';
+
+function initialize() {
+	// ...
+
+	dispatch( preferencesStore ).setDefaults(
+		'namespace/editor-or-plugin-name',
+		{
+			myBooleanFeature: true,
+		}
+	);
+
+	// ...
+}
+```
+
+Or the `get` selector to get a preference value, and the `set` action to update a preference to any value:
+
+```js
+wp.data
+	.select( 'core/preferences' )
+	.get( 'namespace/editor-or-plugin-name', 'myPreferenceName' ); // 1
+wp.data
+	.dispatch( 'core/preferences' )
+	.set( 'namespace/editor-or-plugin-name', 'myPreferenceName', 2 );
+wp.data
+	.select( 'core/preferences' )
+	.get( 'namespace/editor-or-plugin-name', 'myPreferenceName' ); // 2
+```
+
+Use the `toggle` action to flip a boolean preference between `true` and `false`:
+
+```js
+wp.data
+	.select( 'core/preferences' )
+	.get( 'namespace/editor-or-plugin-name', 'myPreferenceName' ); // true
+wp.data
+	.dispatch( 'core/preferences' )
+	.toggle( 'namespace/editor-or-plugin-name', 'myPreferenceName' );
+wp.data
+	.select( 'core/preferences' )
+	.get( 'namespace/editor-or-plugin-name', 'myPreferenceName' ); // false
+```
+
+### Components
+
+The `PreferenceToggleMenuItem` components can be used with a `DropdownMenu` to implement a menu for changing preferences.
+
+Also see the `MoreMenuDropdown` component from the `@wordpress/interface` package for implementing a more menu.
+
+```jsx
+function MyEditorMenu() {
+	return (
+		<MoreMenuDropdown>
+			{ () => (
+				<MenuGroup label={ __( 'Features' ) }>
+					<PreferenceToggleMenuItem
+						scope="namespace/editor-or-plugin-name"
+						name="myPreferenceName"
+						label={ __( 'My feature' ) }
+						info={ __( 'A really awesome feature' ) }
+						messageActivated={ __( 'My feature activated' ) }
+						messageDeactivated={ __( 'My feature deactivated' ) }
+					/>
+				</MenuGroup>
+			) }
+		</MoreMenuDropdown>
+	);
+}
+```
+
+## API Reference
+
+### Actions
+
+The following set of dispatching action creators are available on the object returned by `wp.data.dispatch( 'core/preferences' )`:
+
+<!-- START TOKEN(Autogenerated actions|src/store/actions.js) -->
+
+#### set
+
+Returns an action object used in signalling that a preference should be set
+to a value
+
+_Parameters_
+
+-   _scope_ `string`: The preference scope (e.g. core/edit-post).
+-   _name_ `string`: The preference name.
+-   _value_ `*`: The value to set.
+
+_Returns_
+
+-   `Object`: Action object.
+
+#### setDefaults
+
+Returns an action object used in signalling that preference defaults should
+be set.
+
+_Parameters_
+
+-   _scope_ `string`: The preference scope (e.g. core/edit-post).
+-   _defaults_ `Object<string, *>`: A key/value map of preference names to values.
+
+_Returns_
+
+-   `Object`: Action object.
+
+#### toggle
+
+Returns an action object used in signalling that a preference should be
+toggled.
+
+_Parameters_
+
+-   _scope_ `string`: The preference scope (e.g. core/edit-post).
+-   _name_ `string`: The preference name.
+
+<!-- END TOKEN(Autogenerated actions|src/store/actions.js) -->
+
+### Selectors
+
+The following selectors are available on the object returned by `wp.data.select( 'core/preferences' )`:
+
+<!-- START TOKEN(Autogenerated selectors|src/store/selectors.js) -->
+
+#### get
+
+Returns a boolean indicating whether a prefer is active for a particular
+scope.
+
+_Parameters_
+
+-   _state_ `Object`: The store state.
+-   _scope_ `string`: The scope of the feature (e.g. core/edit-post).
+-   _name_ `string`: The name of the feature.
+
+_Returns_
+
+-   `*`: Is the feature enabled?
+
+<!-- END TOKEN(Autogenerated selectors|src/store/selectors.js) -->
+
+## Contributing to this package
+
+This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects.
+
+To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md).
+
+<br /><br /><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>

package/build/components/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "PreferenceToggleMenuItem", {
+  enumerable: true,
+  get: function () {
+    return _preferenceToggleMenuItem.default;
+  }
+});
+
+var _preferenceToggleMenuItem = _interopRequireDefault(require("./preference-toggle-menu-item"));
+//# sourceMappingURL=index.js.map

package/build/components/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences/src/components/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA","sourcesContent":["export { default as PreferenceToggleMenuItem } from './preference-toggle-menu-item';\n"]}

package/build/components/preference-toggle-menu-item/index.js

@@ -0,0 +1,70 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = PreferenceToggleMenuItem;
+
+var _element = require("@wordpress/element");
+
+var _data = require("@wordpress/data");
+
+var _components = require("@wordpress/components");
+
+var _i18n = require("@wordpress/i18n");
+
+var _icons = require("@wordpress/icons");
+
+var _a11y = require("@wordpress/a11y");
+
+var _store = require("../../store");
+
+/**
+ * WordPress dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+function PreferenceToggleMenuItem(_ref) {
+  let {
+    scope,
+    name,
+    label,
+    info,
+    messageActivated,
+    messageDeactivated,
+    shortcut
+  } = _ref;
+  const isActive = (0, _data.useSelect)(select => !!select(_store.store).get(scope, name), [name]);
+  const {
+    toggle
+  } = (0, _data.useDispatch)(_store.store);
+
+  const speakMessage = () => {
+    if (isActive) {
+      const message = messageDeactivated || (0, _i18n.sprintf)(
+      /* translators: %s: preference name, e.g. 'Fullscreen mode' */
+      (0, _i18n.__)('Preference deactivated - %s'), label);
+      (0, _a11y.speak)(message);
+    } else {
+      const message = messageActivated || (0, _i18n.sprintf)(
+      /* translators: %s: preference name, e.g. 'Fullscreen mode' */
+      (0, _i18n.__)('Preference activated - %s'), label);
+      (0, _a11y.speak)(message);
+    }
+  };
+
+  return (0, _element.createElement)(_components.MenuItem, {
+    icon: isActive && _icons.check,
+    isSelected: isActive,
+    onClick: () => {
+      toggle(scope, name);
+      speakMessage();
+    },
+    role: "menuitemcheckbox",
+    info: info,
+    shortcut: shortcut
+  }, label);
+}
+//# sourceMappingURL=index.js.map

package/build/components/preference-toggle-menu-item/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences/src/components/preference-toggle-menu-item/index.js"],"names":["PreferenceToggleMenuItem","scope","name","label","info","messageActivated","messageDeactivated","shortcut","isActive","select","preferencesStore","get","toggle","speakMessage","message","check"],"mappings":";;;;;;;;;AAGA;;AACA;;AACA;;AACA;;AACA;;AAKA;;AAZA;AACA;AACA;;AAOA;AACA;AACA;AAGe,SAASA,wBAAT,OAQX;AAAA,MAR8C;AACjDC,IAAAA,KADiD;AAEjDC,IAAAA,IAFiD;AAGjDC,IAAAA,KAHiD;AAIjDC,IAAAA,IAJiD;AAKjDC,IAAAA,gBALiD;AAMjDC,IAAAA,kBANiD;AAOjDC,IAAAA;AAPiD,GAQ9C;AACH,QAAMC,QAAQ,GAAG,qBACdC,MAAF,IAAc,CAAC,CAAEA,MAAM,CAAEC,YAAF,CAAN,CAA2BC,GAA3B,CAAgCV,KAAhC,EAAuCC,IAAvC,CADD,EAEhB,CAAEA,IAAF,CAFgB,CAAjB;AAIA,QAAM;AAAEU,IAAAA;AAAF,MAAa,uBAAaF,YAAb,CAAnB;;AACA,QAAMG,YAAY,GAAG,MAAM;AAC1B,QAAKL,QAAL,EAAgB;AACf,YAAMM,OAAO,GACZR,kBAAkB,IAClB;AACC;AACA,oBAAI,6BAAJ,CAFD,EAGCH,KAHD,CAFD;AAOA,uBAAOW,OAAP;AACA,KATD,MASO;AACN,YAAMA,OAAO,GACZT,gBAAgB,IAChB;AACC;AACA,oBAAI,2BAAJ,CAFD,EAGCF,KAHD,CAFD;AAOA,uBAAOW,OAAP;AACA;AACD,GApBD;;AAsBA,SACC,4BAAC,oBAAD;AACC,IAAA,IAAI,EAAGN,QAAQ,IAAIO,YADpB;AAEC,IAAA,UAAU,EAAGP,QAFd;AAGC,IAAA,OAAO,EAAG,MAAM;AACfI,MAAAA,MAAM,CAAEX,KAAF,EAASC,IAAT,CAAN;AACAW,MAAAA,YAAY;AACZ,KANF;AAOC,IAAA,IAAI,EAAC,kBAPN;AAQC,IAAA,IAAI,EAAGT,IARR;AASC,IAAA,QAAQ,EAAGG;AATZ,KAWGJ,KAXH,CADD;AAeA","sourcesContent":["/**\n * WordPress dependencies\n */\nimport { useSelect, useDispatch } from '@wordpress/data';\nimport { MenuItem } from '@wordpress/components';\nimport { __, sprintf } from '@wordpress/i18n';\nimport { check } from '@wordpress/icons';\nimport { speak } from '@wordpress/a11y';\n\n/**\n * Internal dependencies\n */\nimport { store as preferencesStore } from '../../store';\n\nexport default function PreferenceToggleMenuItem( {\n\tscope,\n\tname,\n\tlabel,\n\tinfo,\n\tmessageActivated,\n\tmessageDeactivated,\n\tshortcut,\n} ) {\n\tconst isActive = useSelect(\n\t\t( select ) => !! select( preferencesStore ).get( scope, name ),\n\t\t[ name ]\n\t);\n\tconst { toggle } = useDispatch( preferencesStore );\n\tconst speakMessage = () => {\n\t\tif ( isActive ) {\n\t\t\tconst message =\n\t\t\t\tmessageDeactivated ||\n\t\t\t\tsprintf(\n\t\t\t\t\t/* translators: %s: preference name, e.g. 'Fullscreen mode' */\n\t\t\t\t\t__( 'Preference deactivated - %s' ),\n\t\t\t\t\tlabel\n\t\t\t\t);\n\t\t\tspeak( message );\n\t\t} else {\n\t\t\tconst message =\n\t\t\t\tmessageActivated ||\n\t\t\t\tsprintf(\n\t\t\t\t\t/* translators: %s: preference name, e.g. 'Fullscreen mode' */\n\t\t\t\t\t__( 'Preference activated - %s' ),\n\t\t\t\t\tlabel\n\t\t\t\t);\n\t\t\tspeak( message );\n\t\t}\n\t};\n\n\treturn (\n\t\t<MenuItem\n\t\t\ticon={ isActive && check }\n\t\t\tisSelected={ isActive }\n\t\t\tonClick={ () => {\n\t\t\t\ttoggle( scope, name );\n\t\t\t\tspeakMessage();\n\t\t\t} }\n\t\t\trole=\"menuitemcheckbox\"\n\t\t\tinfo={ info }\n\t\t\tshortcut={ shortcut }\n\t\t>\n\t\t\t{ label }\n\t\t</MenuItem>\n\t);\n}\n"]}

package/build/index.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  store: true
+};
+Object.defineProperty(exports, "store", {
+  enumerable: true,
+  get: function () {
+    return _store.store;
+  }
+});
+
+var _components = require("./components");
+
+Object.keys(_components).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _components[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _components[key];
+    }
+  });
+});
+
+var _store = require("./store");
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences/src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AACA","sourcesContent":["export * from './components';\nexport { store } from './store';\n"]}

package/build/store/actions.js

@@ -0,0 +1,65 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.set = set;
+exports.setDefaults = setDefaults;
+exports.toggle = toggle;
+
+/**
+ * Returns an action object used in signalling that a preference should be
+ * toggled.
+ *
+ * @param {string} scope The preference scope (e.g. core/edit-post).
+ * @param {string} name  The preference name.
+ */
+function toggle(scope, name) {
+  return function (_ref) {
+    let {
+      select,
+      dispatch
+    } = _ref;
+    const currentValue = select.get(scope, name);
+    dispatch.set(scope, name, !currentValue);
+  };
+}
+/**
+ * Returns an action object used in signalling that a preference should be set
+ * to a value
+ *
+ * @param {string} scope The preference scope (e.g. core/edit-post).
+ * @param {string} name  The preference name.
+ * @param {*}      value The value to set.
+ *
+ * @return {Object} Action object.
+ */
+
+
+function set(scope, name, value) {
+  return {
+    type: 'SET_PREFERENCE_VALUE',
+    scope,
+    name,
+    value
+  };
+}
+/**
+ * Returns an action object used in signalling that preference defaults should
+ * be set.
+ *
+ * @param {string}            scope    The preference scope (e.g. core/edit-post).
+ * @param {Object<string, *>} defaults A key/value map of preference names to values.
+ *
+ * @return {Object} Action object.
+ */
+
+
+function setDefaults(scope, defaults) {
+  return {
+    type: 'SET_PREFERENCE_DEFAULTS',
+    scope,
+    defaults
+  };
+}
+//# sourceMappingURL=actions.js.map

package/build/store/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences/src/store/actions.js"],"names":["toggle","scope","name","select","dispatch","currentValue","get","set","value","type","setDefaults","defaults"],"mappings":";;;;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,MAAT,CAAiBC,KAAjB,EAAwBC,IAAxB,EAA+B;AACrC,SAAO,gBAAkC;AAAA,QAAvB;AAAEC,MAAAA,MAAF;AAAUC,MAAAA;AAAV,KAAuB;AACxC,UAAMC,YAAY,GAAGF,MAAM,CAACG,GAAP,CAAYL,KAAZ,EAAmBC,IAAnB,CAArB;AACAE,IAAAA,QAAQ,CAACG,GAAT,CAAcN,KAAd,EAAqBC,IAArB,EAA2B,CAAEG,YAA7B;AACA,GAHD;AAIA;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASE,GAAT,CAAcN,KAAd,EAAqBC,IAArB,EAA2BM,KAA3B,EAAmC;AACzC,SAAO;AACNC,IAAAA,IAAI,EAAE,sBADA;AAENR,IAAAA,KAFM;AAGNC,IAAAA,IAHM;AAINM,IAAAA;AAJM,GAAP;AAMA;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASE,WAAT,CAAsBT,KAAtB,EAA6BU,QAA7B,EAAwC;AAC9C,SAAO;AACNF,IAAAA,IAAI,EAAE,yBADA;AAENR,IAAAA,KAFM;AAGNU,IAAAA;AAHM,GAAP;AAKA","sourcesContent":["/**\n * Returns an action object used in signalling that a preference should be\n * toggled.\n *\n * @param {string} scope The preference scope (e.g. core/edit-post).\n * @param {string} name  The preference name.\n */\nexport function toggle( scope, name ) {\n\treturn function ( { select, dispatch } ) {\n\t\tconst currentValue = select.get( scope, name );\n\t\tdispatch.set( scope, name, ! currentValue );\n\t};\n}\n\n/**\n * Returns an action object used in signalling that a preference should be set\n * to a value\n *\n * @param {string} scope The preference scope (e.g. core/edit-post).\n * @param {string} name  The preference name.\n * @param {*}      value The value to set.\n *\n * @return {Object} Action object.\n */\nexport function set( scope, name, value ) {\n\treturn {\n\t\ttype: 'SET_PREFERENCE_VALUE',\n\t\tscope,\n\t\tname,\n\t\tvalue,\n\t};\n}\n\n/**\n * Returns an action object used in signalling that preference defaults should\n * be set.\n *\n * @param {string}            scope    The preference scope (e.g. core/edit-post).\n * @param {Object<string, *>} defaults A key/value map of preference names to values.\n *\n * @return {Object} Action object.\n */\nexport function setDefaults( scope, defaults ) {\n\treturn {\n\t\ttype: 'SET_PREFERENCE_DEFAULTS',\n\t\tscope,\n\t\tdefaults,\n\t};\n}\n"]}

package/build/store/constants.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.STORE_NAME = void 0;
+
+/**
+ * The identifier for the data store.
+ *
+ * @type {string}
+ */
+const STORE_NAME = 'core/preferences';
+exports.STORE_NAME = STORE_NAME;
+//# sourceMappingURL=constants.js.map

package/build/store/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences/src/store/constants.js"],"names":["STORE_NAME"],"mappings":";;;;;;;AAAA;AACA;AACA;AACA;AACA;AACO,MAAMA,UAAU,GAAG,kBAAnB","sourcesContent":["/**\n * The identifier for the data store.\n *\n * @type {string}\n */\nexport const STORE_NAME = 'core/preferences';\n"]}

package/build/store/index.js

@@ -0,0 +1,58 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.store = void 0;
+
+var _data = require("@wordpress/data");
+
+var _reducer = _interopRequireDefault(require("./reducer"));
+
+var actions = _interopRequireWildcard(require("./actions"));
+
+var selectors = _interopRequireWildcard(require("./selectors"));
+
+var _constants = require("./constants");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+/**
+ * WordPress dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+
+/**
+ * Store definition for the interface namespace.
+ *
+ * @see https://github.com/WordPress/gutenberg/blob/HEAD/packages/data/README.md#createReduxStore
+ *
+ * @type {Object}
+ */
+const store = (0, _data.createReduxStore)(_constants.STORE_NAME, {
+  reducer: _reducer.default,
+  actions,
+  selectors,
+  persist: ['preferences']
+}); // Once we build a more generic persistence plugin that works across types of stores
+// we'd be able to replace this with a register call.
+
+exports.store = store;
+(0, _data.registerStore)(_constants.STORE_NAME, {
+  reducer: _reducer.default,
+  actions,
+  selectors,
+  persist: ['preferences']
+});
+//# sourceMappingURL=index.js.map

package/build/store/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences/src/store/index.js"],"names":["store","STORE_NAME","reducer","actions","selectors","persist"],"mappings":";;;;;;;;;AAGA;;AAQA;;AACA;;AACA;;AACA;;;;;;AAdA;AACA;AACA;;AAGA;AACA;AACA;;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,KAAK,GAAG,4BAAkBC,qBAAlB,EAA8B;AAClDC,EAAAA,OAAO,EAAPA,gBADkD;AAElDC,EAAAA,OAFkD;AAGlDC,EAAAA,SAHkD;AAIlDC,EAAAA,OAAO,EAAE,CAAE,aAAF;AAJyC,CAA9B,CAAd,C,CAOP;AACA;;;AACA,yBAAeJ,qBAAf,EAA2B;AAC1BC,EAAAA,OAAO,EAAPA,gBAD0B;AAE1BC,EAAAA,OAF0B;AAG1BC,EAAAA,SAH0B;AAI1BC,EAAAA,OAAO,EAAE,CAAE,aAAF;AAJiB,CAA3B","sourcesContent":["/**\n * WordPress dependencies\n */\nimport { createReduxStore, registerStore } from '@wordpress/data';\n\n/**\n * Internal dependencies\n */\n/**\n * Internal dependencies\n */\nimport reducer from './reducer';\nimport * as actions from './actions';\nimport * as selectors from './selectors';\nimport { STORE_NAME } from './constants';\n\n/**\n * Store definition for the interface namespace.\n *\n * @see https://github.com/WordPress/gutenberg/blob/HEAD/packages/data/README.md#createReduxStore\n *\n * @type {Object}\n */\nexport const store = createReduxStore( STORE_NAME, {\n\treducer,\n\tactions,\n\tselectors,\n\tpersist: [ 'preferences' ],\n} );\n\n// Once we build a more generic persistence plugin that works across types of stores\n// we'd be able to replace this with a register call.\nregisterStore( STORE_NAME, {\n\treducer,\n\tactions,\n\tselectors,\n\tpersist: [ 'preferences' ],\n} );\n"]}

package/build/store/reducer.js

@@ -0,0 +1,81 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.defaults = defaults;
+exports.preferences = preferences;
+
+var _data = require("@wordpress/data");
+
+/**
+ * WordPress dependencies
+ */
+
+/**
+ * Reducer returning the defaults for user preferences.
+ *
+ * This is kept intentionally separate from the preferences
+ * themselves so that defaults are not persisted.
+ *
+ * @param {Object} state  Current state.
+ * @param {Object} action Dispatched action.
+ *
+ * @return {Object} Updated state.
+ */
+function defaults() {
+  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let action = arguments.length > 1 ? arguments[1] : undefined;
+
+  if (action.type === 'SET_PREFERENCE_DEFAULTS') {
+    const {
+      scope,
+      defaults: values
+    } = action;
+    return { ...state,
+      [scope]: { ...state[scope],
+        ...values
+      }
+    };
+  }
+
+  return state;
+}
+/**
+ * Reducer returning the user preferences.
+ *
+ * @param {Object} state  Current state.
+ * @param {Object} action Dispatched action.
+ *
+ * @return {Object} Updated state.
+ */
+
+
+function preferences() {
+  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let action = arguments.length > 1 ? arguments[1] : undefined;
+
+  if (action.type === 'SET_PREFERENCE_VALUE') {
+    const {
+      scope,
+      name,
+      value
+    } = action;
+    return { ...state,
+      [scope]: { ...state[scope],
+        [name]: value
+      }
+    };
+  }
+
+  return state;
+}
+
+var _default = (0, _data.combineReducers)({
+  defaults,
+  preferences
+});
+
+exports.default = _default;
+//# sourceMappingURL=reducer.js.map

package/build/store/reducer.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences/src/store/reducer.js"],"names":["defaults","state","action","type","scope","values","preferences","name","value"],"mappings":";;;;;;;;;AAGA;;AAHA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,QAAT,GAAwC;AAAA,MAArBC,KAAqB,uEAAb,EAAa;AAAA,MAATC,MAAS;;AAC9C,MAAKA,MAAM,CAACC,IAAP,KAAgB,yBAArB,EAAiD;AAChD,UAAM;AAAEC,MAAAA,KAAF;AAASJ,MAAAA,QAAQ,EAAEK;AAAnB,QAA8BH,MAApC;AACA,WAAO,EACN,GAAGD,KADG;AAEN,OAAEG,KAAF,GAAW,EACV,GAAGH,KAAK,CAAEG,KAAF,CADE;AAEV,WAAGC;AAFO;AAFL,KAAP;AAOA;;AAED,SAAOJ,KAAP;AACA;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASK,WAAT,GAA2C;AAAA,MAArBL,KAAqB,uEAAb,EAAa;AAAA,MAATC,MAAS;;AACjD,MAAKA,MAAM,CAACC,IAAP,KAAgB,sBAArB,EAA8C;AAC7C,UAAM;AAAEC,MAAAA,KAAF;AAASG,MAAAA,IAAT;AAAeC,MAAAA;AAAf,QAAyBN,MAA/B;AACA,WAAO,EACN,GAAGD,KADG;AAEN,OAAEG,KAAF,GAAW,EACV,GAAGH,KAAK,CAAEG,KAAF,CADE;AAEV,SAAEG,IAAF,GAAUC;AAFA;AAFL,KAAP;AAOA;;AAED,SAAOP,KAAP;AACA;;eAEc,2BAAiB;AAC/BD,EAAAA,QAD+B;AAE/BM,EAAAA;AAF+B,CAAjB,C","sourcesContent":["/**\n * WordPress dependencies\n */\nimport { combineReducers } from '@wordpress/data';\n\n/**\n * Reducer returning the defaults for user preferences.\n *\n * This is kept intentionally separate from the preferences\n * themselves so that defaults are not persisted.\n *\n * @param {Object} state  Current state.\n * @param {Object} action Dispatched action.\n *\n * @return {Object} Updated state.\n */\nexport function defaults( state = {}, action ) {\n\tif ( action.type === 'SET_PREFERENCE_DEFAULTS' ) {\n\t\tconst { scope, defaults: values } = action;\n\t\treturn {\n\t\t\t...state,\n\t\t\t[ scope ]: {\n\t\t\t\t...state[ scope ],\n\t\t\t\t...values,\n\t\t\t},\n\t\t};\n\t}\n\n\treturn state;\n}\n\n/**\n * Reducer returning the user preferences.\n *\n * @param {Object} state  Current state.\n * @param {Object} action Dispatched action.\n *\n * @return {Object} Updated state.\n */\nexport function preferences( state = {}, action ) {\n\tif ( action.type === 'SET_PREFERENCE_VALUE' ) {\n\t\tconst { scope, name, value } = action;\n\t\treturn {\n\t\t\t...state,\n\t\t\t[ scope ]: {\n\t\t\t\t...state[ scope ],\n\t\t\t\t[ name ]: value,\n\t\t\t},\n\t\t};\n\t}\n\n\treturn state;\n}\n\nexport default combineReducers( {\n\tdefaults,\n\tpreferences,\n} );\n"]}

package/build/store/selectors.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.get = get;
+
+/**
+ * Returns a boolean indicating whether a prefer is active for a particular
+ * scope.
+ *
+ * @param {Object} state The store state.
+ * @param {string} scope The scope of the feature (e.g. core/edit-post).
+ * @param {string} name  The name of the feature.
+ *
+ * @return {*} Is the feature enabled?
+ */
+function get(state, scope, name) {
+  var _state$preferences$sc, _state$defaults$scope;
+
+  const value = (_state$preferences$sc = state.preferences[scope]) === null || _state$preferences$sc === void 0 ? void 0 : _state$preferences$sc[name];
+  return value !== null && value !== void 0 ? value : (_state$defaults$scope = state.defaults[scope]) === null || _state$defaults$scope === void 0 ? void 0 : _state$defaults$scope[name];
+}
+//# sourceMappingURL=selectors.js.map

package/build/store/selectors.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences/src/store/selectors.js"],"names":["get","state","scope","name","value","preferences","defaults"],"mappings":";;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,GAAT,CAAcC,KAAd,EAAqBC,KAArB,EAA4BC,IAA5B,EAAmC;AAAA;;AACzC,QAAMC,KAAK,4BAAGH,KAAK,CAACI,WAAN,CAAmBH,KAAnB,CAAH,0DAAG,sBAA8BC,IAA9B,CAAd;AACA,SAAOC,KAAP,aAAOA,KAAP,cAAOA,KAAP,4BAAgBH,KAAK,CAACK,QAAN,CAAgBJ,KAAhB,CAAhB,0DAAgB,sBAA2BC,IAA3B,CAAhB;AACA","sourcesContent":["/**\n * Returns a boolean indicating whether a prefer is active for a particular\n * scope.\n *\n * @param {Object} state The store state.\n * @param {string} scope The scope of the feature (e.g. core/edit-post).\n * @param {string} name  The name of the feature.\n *\n * @return {*} Is the feature enabled?\n */\nexport function get( state, scope, name ) {\n\tconst value = state.preferences[ scope ]?.[ name ];\n\treturn value ?? state.defaults[ scope ]?.[ name ];\n}\n"]}

package/build-module/components/index.js

@@ -0,0 +1,2 @@
+export { default as PreferenceToggleMenuItem } from './preference-toggle-menu-item';
+//# sourceMappingURL=index.js.map

package/build-module/components/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences/src/components/index.js"],"names":["default","PreferenceToggleMenuItem"],"mappings":"AAAA,SAASA,OAAO,IAAIC,wBAApB,QAAoD,+BAApD","sourcesContent":["export { default as PreferenceToggleMenuItem } from './preference-toggle-menu-item';\n"]}

package/build-module/components/preference-toggle-menu-item/index.js

@@ -0,0 +1,57 @@
+import { createElement } from "@wordpress/element";
+
+/**
+ * WordPress dependencies
+ */
+import { useSelect, useDispatch } from '@wordpress/data';
+import { MenuItem } from '@wordpress/components';
+import { __, sprintf } from '@wordpress/i18n';
+import { check } from '@wordpress/icons';
+import { speak } from '@wordpress/a11y';
+/**
+ * Internal dependencies
+ */
+
+import { store as preferencesStore } from '../../store';
+export default function PreferenceToggleMenuItem(_ref) {
+  let {
+    scope,
+    name,
+    label,
+    info,
+    messageActivated,
+    messageDeactivated,
+    shortcut
+  } = _ref;
+  const isActive = useSelect(select => !!select(preferencesStore).get(scope, name), [name]);
+  const {
+    toggle
+  } = useDispatch(preferencesStore);
+
+  const speakMessage = () => {
+    if (isActive) {
+      const message = messageDeactivated || sprintf(
+      /* translators: %s: preference name, e.g. 'Fullscreen mode' */
+      __('Preference deactivated - %s'), label);
+      speak(message);
+    } else {
+      const message = messageActivated || sprintf(
+      /* translators: %s: preference name, e.g. 'Fullscreen mode' */
+      __('Preference activated - %s'), label);
+      speak(message);
+    }
+  };
+
+  return createElement(MenuItem, {
+    icon: isActive && check,
+    isSelected: isActive,
+    onClick: () => {
+      toggle(scope, name);
+      speakMessage();
+    },
+    role: "menuitemcheckbox",
+    info: info,
+    shortcut: shortcut
+  }, label);
+}
+//# sourceMappingURL=index.js.map

package/build-module/components/preference-toggle-menu-item/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences/src/components/preference-toggle-menu-item/index.js"],"names":["useSelect","useDispatch","MenuItem","__","sprintf","check","speak","store","preferencesStore","PreferenceToggleMenuItem","scope","name","label","info","messageActivated","messageDeactivated","shortcut","isActive","select","get","toggle","speakMessage","message"],"mappings":";;AAAA;AACA;AACA;AACA,SAASA,SAAT,EAAoBC,WAApB,QAAuC,iBAAvC;AACA,SAASC,QAAT,QAAyB,uBAAzB;AACA,SAASC,EAAT,EAAaC,OAAb,QAA4B,iBAA5B;AACA,SAASC,KAAT,QAAsB,kBAAtB;AACA,SAASC,KAAT,QAAsB,iBAAtB;AAEA;AACA;AACA;;AACA,SAASC,KAAK,IAAIC,gBAAlB,QAA0C,aAA1C;AAEA,eAAe,SAASC,wBAAT,OAQX;AAAA,MAR8C;AACjDC,IAAAA,KADiD;AAEjDC,IAAAA,IAFiD;AAGjDC,IAAAA,KAHiD;AAIjDC,IAAAA,IAJiD;AAKjDC,IAAAA,gBALiD;AAMjDC,IAAAA,kBANiD;AAOjDC,IAAAA;AAPiD,GAQ9C;AACH,QAAMC,QAAQ,GAAGjB,SAAS,CACvBkB,MAAF,IAAc,CAAC,CAAEA,MAAM,CAAEV,gBAAF,CAAN,CAA2BW,GAA3B,CAAgCT,KAAhC,EAAuCC,IAAvC,CADQ,EAEzB,CAAEA,IAAF,CAFyB,CAA1B;AAIA,QAAM;AAAES,IAAAA;AAAF,MAAanB,WAAW,CAAEO,gBAAF,CAA9B;;AACA,QAAMa,YAAY,GAAG,MAAM;AAC1B,QAAKJ,QAAL,EAAgB;AACf,YAAMK,OAAO,GACZP,kBAAkB,IAClBX,OAAO;AACN;AACAD,MAAAA,EAAE,CAAE,6BAAF,CAFI,EAGNS,KAHM,CAFR;AAOAN,MAAAA,KAAK,CAAEgB,OAAF,CAAL;AACA,KATD,MASO;AACN,YAAMA,OAAO,GACZR,gBAAgB,IAChBV,OAAO;AACN;AACAD,MAAAA,EAAE,CAAE,2BAAF,CAFI,EAGNS,KAHM,CAFR;AAOAN,MAAAA,KAAK,CAAEgB,OAAF,CAAL;AACA;AACD,GApBD;;AAsBA,SACC,cAAC,QAAD;AACC,IAAA,IAAI,EAAGL,QAAQ,IAAIZ,KADpB;AAEC,IAAA,UAAU,EAAGY,QAFd;AAGC,IAAA,OAAO,EAAG,MAAM;AACfG,MAAAA,MAAM,CAAEV,KAAF,EAASC,IAAT,CAAN;AACAU,MAAAA,YAAY;AACZ,KANF;AAOC,IAAA,IAAI,EAAC,kBAPN;AAQC,IAAA,IAAI,EAAGR,IARR;AASC,IAAA,QAAQ,EAAGG;AATZ,KAWGJ,KAXH,CADD;AAeA","sourcesContent":["/**\n * WordPress dependencies\n */\nimport { useSelect, useDispatch } from '@wordpress/data';\nimport { MenuItem } from '@wordpress/components';\nimport { __, sprintf } from '@wordpress/i18n';\nimport { check } from '@wordpress/icons';\nimport { speak } from '@wordpress/a11y';\n\n/**\n * Internal dependencies\n */\nimport { store as preferencesStore } from '../../store';\n\nexport default function PreferenceToggleMenuItem( {\n\tscope,\n\tname,\n\tlabel,\n\tinfo,\n\tmessageActivated,\n\tmessageDeactivated,\n\tshortcut,\n} ) {\n\tconst isActive = useSelect(\n\t\t( select ) => !! select( preferencesStore ).get( scope, name ),\n\t\t[ name ]\n\t);\n\tconst { toggle } = useDispatch( preferencesStore );\n\tconst speakMessage = () => {\n\t\tif ( isActive ) {\n\t\t\tconst message =\n\t\t\t\tmessageDeactivated ||\n\t\t\t\tsprintf(\n\t\t\t\t\t/* translators: %s: preference name, e.g. 'Fullscreen mode' */\n\t\t\t\t\t__( 'Preference deactivated - %s' ),\n\t\t\t\t\tlabel\n\t\t\t\t);\n\t\t\tspeak( message );\n\t\t} else {\n\t\t\tconst message =\n\t\t\t\tmessageActivated ||\n\t\t\t\tsprintf(\n\t\t\t\t\t/* translators: %s: preference name, e.g. 'Fullscreen mode' */\n\t\t\t\t\t__( 'Preference activated - %s' ),\n\t\t\t\t\tlabel\n\t\t\t\t);\n\t\t\tspeak( message );\n\t\t}\n\t};\n\n\treturn (\n\t\t<MenuItem\n\t\t\ticon={ isActive && check }\n\t\t\tisSelected={ isActive }\n\t\t\tonClick={ () => {\n\t\t\t\ttoggle( scope, name );\n\t\t\t\tspeakMessage();\n\t\t\t} }\n\t\t\trole=\"menuitemcheckbox\"\n\t\t\tinfo={ info }\n\t\t\tshortcut={ shortcut }\n\t\t>\n\t\t\t{ label }\n\t\t</MenuItem>\n\t);\n}\n"]}

package/build-module/index.js

@@ -0,0 +1,3 @@
+export * from './components';
+export { store } from './store';
+//# sourceMappingURL=index.js.map

package/build-module/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences/src/index.js"],"names":["store"],"mappings":"AAAA,cAAc,cAAd;AACA,SAASA,KAAT,QAAsB,SAAtB","sourcesContent":["export * from './components';\nexport { store } from './store';\n"]}