diff --git a/.eslintrc.js b/.eslintrc.js index b2564dfc09afad..f4170bb996e7a3 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -88,6 +88,10 @@ module.exports = { selector: 'ImportDeclaration[source.value=/^keycodes(\\u002F|$)/]', message: 'Use @wordpress/keycodes as import path instead.', }, + { + selector: 'ImportDeclaration[source.value=/^nux(\\u002F|$)/]', + message: 'Use @wordpress/nux as import path instead.', + }, { selector: 'ImportDeclaration[source.value=/^utils(\\u002F|$)/]', message: 'Use @wordpress/utils as import path instead.', @@ -112,10 +116,6 @@ module.exports = { "selector": "ImportDeclaration[source.value=/^core-blocks$/]", "message": "Use @wordpress/core-blocks as import path instead." }, - { - "selector": "ImportDeclaration[source.value=/^nux$/]", - "message": "Use @wordpress/nux as import path instead." - }, { selector: 'CallExpression[callee.name="deprecated"] Property[key.name="version"][value.value=/' + majorMinorRegExp + '/]', message: 'Deprecated functions must be removed before releasing this version.', diff --git a/docs/manifest.json b/docs/manifest.json index 3efafeb88c9667..9463cc22ac36b1 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -222,9 +222,9 @@ "parent": "packages" }, { - "title": "@wordpress/api-request", - "slug": "packages-api-request", - "markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/packages/api-request/README.md", + "title": "@wordpress/api-fetch", + "slug": "packages-api-fetch", + "markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/packages/api-fetch/README.md", "parent": "packages" }, { @@ -377,6 +377,12 @@ "markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/packages/npm-package-json-lint-config/README.md", "parent": "packages" }, + { + "title": "@wordpress/nux", + "slug": "packages-nux", + "markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/packages/nux/README.md", + "parent": "packages" + }, { "title": "@wordpress/plugins", "slug": "packages-plugins", @@ -443,12 +449,6 @@ "markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/editor/README.md", "parent": "packages" }, - { - "title": "@wordpress/nux", - "slug": "packages-nux", - "markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/nux/README.md", - "parent": "packages" - }, { "title": "Data Package Reference", "slug": "data", diff --git a/docs/tool/config.js b/docs/tool/config.js index 70c7f2b9529b29..bbd90d03b623c3 100644 --- a/docs/tool/config.js +++ b/docs/tool/config.js @@ -17,7 +17,6 @@ const gutenbergPackages = [ 'core-blocks', 'edit-post', 'editor', - 'nux', ]; module.exports = { @@ -45,8 +44,8 @@ module.exports = { }, 'core/nux': { title: 'The NUX (New User Experience) Data', - selectors: [ path.resolve( root, 'nux/store/selectors.js' ) ], - actions: [ path.resolve( root, 'nux/store/actions.js' ) ], + selectors: [ path.resolve( root, 'packages/nux/src/store/selectors.js' ) ], + actions: [ path.resolve( root, 'packages/nux/src/store/actions.js' ) ], }, 'core/viewport': { title: 'The Viewport Data', diff --git a/nux/index.js b/nux/index.js index a11d17bc96961a..88824798b6b62a 100644 --- a/nux/index.js +++ b/nux/index.js @@ -1,6 +1,3 @@ -/** - * Internal dependencies - */ -import './store'; +export * from '../packages/nux/src'; -export { default as DotTip } from './components/dot-tip'; +import '../packages/nux/src/style.scss'; diff --git a/package-lock.json b/package-lock.json index d604bb389330b1..3e8b4047ea546b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3460,6 +3460,18 @@ "version": "file:packages/npm-package-json-lint-config", "dev": true }, + "@wordpress/nux": { + "version": "file:packages/nux", + "requires": { + "@wordpress/components": "file:packages/components", + "@wordpress/compose": "file:packages/compose", + "@wordpress/data": "file:packages/data", + "@wordpress/element": "file:packages/element", + "@wordpress/i18n": "file:packages/i18n", + "lodash": "^4.17.10", + "rememo": "^3.0.0" + } + }, "@wordpress/plugins": { "version": "file:packages/plugins", "requires": { diff --git a/package.json b/package.json index 391fd95d665f93..53796b60dc022c 100644 --- a/package.json +++ b/package.json @@ -34,6 +34,7 @@ "@wordpress/i18n": "file:packages/i18n", "@wordpress/is-shallow-equal": "file:packages/is-shallow-equal", "@wordpress/keycodes": "file:packages/keycodes", + "@wordpress/nux": "file:packages/nux", "@wordpress/plugins": "file:packages/plugins", "@wordpress/shortcode": "file:packages/shortcode", "@wordpress/url": "file:packages/url", diff --git a/packages/nux/.npmrc b/packages/nux/.npmrc new file mode 100644 index 00000000000000..43c97e719a5a82 --- /dev/null +++ b/packages/nux/.npmrc @@ -0,0 +1 @@ +package-lock=false diff --git a/nux/README.md b/packages/nux/README.md similarity index 90% rename from nux/README.md rename to packages/nux/README.md index ecb389f7095cf4..2b490aa7918733 100644 --- a/nux/README.md +++ b/packages/nux/README.md @@ -1,12 +1,19 @@ -NUX (New User eXperience) -========================= +# @wordpress/nux -The NUX module exposes components, and `wp.data` methods useful for onboarding a new user to the WordPress admin interface. Specifically, it exposes _tips_ and _guides_. +The NUX (New User eXperience) module exposes components, and `wp.data` methods useful for onboarding a new user to the WordPress admin interface. Specifically, it exposes _tips_ and _guides_. A _tip_ is a component that points to an element in the UI and contains text that explains the element's functionality. The user can dismiss a tip, in which case it never shows again. The user can also disable tips entirely. Information about tips is persisted between sessions using `localStorage`. A _guide_ allows a series of of tips to be presented to the user one by one. When a user dismisses a tip that is in a guide, the next tip in the guide is shown. +## Installation + +Install the module + +```bash +npm install @wordpress/nux --save +``` + ## DotTip `DotTip` is a React component that renders a single _tip_ on the screen. The tip will point to the React element that `DotTip` is nested within. Each tip is uniquely identified by a string passed to `id`. diff --git a/packages/nux/package.json b/packages/nux/package.json new file mode 100644 index 00000000000000..165882df93bc1f --- /dev/null +++ b/packages/nux/package.json @@ -0,0 +1,36 @@ +{ + "name": "@wordpress/nux", + "version": "1.0.0-alpha.0", + "description": "NUX (New User eXperience) module for WordPress", + "author": "The WordPress Contributors", + "license": "GPL-2.0-or-later", + "keywords": [ + "wordpress", + "nux" + ], + "homepage": "https://github.com/WordPress/gutenberg/tree/master/packages/nux/README.md", + "repository": { + "type": "git", + "url": "https://github.com/WordPress/gutenberg.git" + }, + "bugs": { + "url": "https://github.com/WordPress/gutenberg/issues" + }, + "main": "build/index.js", + "module": "build-module/index.js", + "dependencies": { + "@wordpress/components": "file:../components", + "@wordpress/compose": "file:../compose", + "@wordpress/data": "file:../data", + "@wordpress/element": "file:../element", + "@wordpress/i18n": "file:../i18n", + "lodash": "^4.17.10", + "rememo": "^3.0.0" + }, + "devDependencies": { + "enzyme": "^3.3.0" + }, + "publishConfig": { + "access": "public" + } +} diff --git a/nux/components/dot-tip/README.md b/packages/nux/src/components/dot-tip/README.md similarity index 100% rename from nux/components/dot-tip/README.md rename to packages/nux/src/components/dot-tip/README.md diff --git a/nux/components/dot-tip/index.js b/packages/nux/src/components/dot-tip/index.js similarity index 96% rename from nux/components/dot-tip/index.js rename to packages/nux/src/components/dot-tip/index.js index a6e7038b92ad06..a2f1f0659697b2 100644 --- a/nux/components/dot-tip/index.js +++ b/packages/nux/src/components/dot-tip/index.js @@ -6,11 +6,6 @@ import { Popover, Button, IconButton } from '@wordpress/components'; import { __ } from '@wordpress/i18n'; import { withSelect, withDispatch } from '@wordpress/data'; -/** - * Internal dependencies - */ -import './style.scss'; - export function DotTip( { children, isVisible, diff --git a/nux/components/dot-tip/style.scss b/packages/nux/src/components/dot-tip/style.scss similarity index 100% rename from nux/components/dot-tip/style.scss rename to packages/nux/src/components/dot-tip/style.scss diff --git a/nux/components/dot-tip/test/__snapshots__/index.js.snap b/packages/nux/src/components/dot-tip/test/__snapshots__/index.js.snap similarity index 100% rename from nux/components/dot-tip/test/__snapshots__/index.js.snap rename to packages/nux/src/components/dot-tip/test/__snapshots__/index.js.snap diff --git a/nux/components/dot-tip/test/index.js b/packages/nux/src/components/dot-tip/test/index.js similarity index 100% rename from nux/components/dot-tip/test/index.js rename to packages/nux/src/components/dot-tip/test/index.js diff --git a/packages/nux/src/index.js b/packages/nux/src/index.js new file mode 100644 index 00000000000000..a11d17bc96961a --- /dev/null +++ b/packages/nux/src/index.js @@ -0,0 +1,6 @@ +/** + * Internal dependencies + */ +import './store'; + +export { default as DotTip } from './components/dot-tip'; diff --git a/nux/store/actions.js b/packages/nux/src/store/actions.js similarity index 100% rename from nux/store/actions.js rename to packages/nux/src/store/actions.js diff --git a/nux/store/index.js b/packages/nux/src/store/index.js similarity index 100% rename from nux/store/index.js rename to packages/nux/src/store/index.js diff --git a/nux/store/reducer.js b/packages/nux/src/store/reducer.js similarity index 100% rename from nux/store/reducer.js rename to packages/nux/src/store/reducer.js diff --git a/nux/store/selectors.js b/packages/nux/src/store/selectors.js similarity index 100% rename from nux/store/selectors.js rename to packages/nux/src/store/selectors.js diff --git a/nux/store/test/actions.js b/packages/nux/src/store/test/actions.js similarity index 100% rename from nux/store/test/actions.js rename to packages/nux/src/store/test/actions.js diff --git a/nux/store/test/reducer.js b/packages/nux/src/store/test/reducer.js similarity index 100% rename from nux/store/test/reducer.js rename to packages/nux/src/store/test/reducer.js diff --git a/nux/store/test/selectors.js b/packages/nux/src/store/test/selectors.js similarity index 100% rename from nux/store/test/selectors.js rename to packages/nux/src/store/test/selectors.js diff --git a/packages/nux/src/style.scss b/packages/nux/src/style.scss new file mode 100644 index 00000000000000..51dfda92ad72cc --- /dev/null +++ b/packages/nux/src/style.scss @@ -0,0 +1 @@ +@import './components/dot-tip/style.scss'; diff --git a/test/unit/jest.config.json b/test/unit/jest.config.json index a108d01564de50..1f139f348685f8 100644 --- a/test/unit/jest.config.json +++ b/test/unit/jest.config.json @@ -1,7 +1,7 @@ { "rootDir": "../../", "collectCoverageFrom": [ - "(blocks|components|editor|utils|edit-post|core-blocks|nux)/**/*.js", + "(blocks|components|editor|utils|edit-post|core-blocks)/**/*.js", "packages/**/*.js" ], "coveragePathIgnorePatterns": [ @@ -11,7 +11,7 @@ "/packages/.*/benchmark/" ], "moduleNameMapper": { - "@wordpress\\/(blocks|components|editor|utils|edit-post|core-blocks|nux)$": "$1", + "@wordpress\\/(blocks|components|editor|utils|edit-post|core-blocks)$": "$1", "@wordpress\\/(a-z0-9-)$": "packages/$1/src" }, "preset": "@wordpress/jest-preset-default",