Add deprecation

Author: youknowriad

docs/reference/deprecated.md

@@ -5,6 +5,7 @@ Gutenberg's deprecation policy is intended to support backwards-compatibility fo
 - `wp.date.getSettings` has been removed. Please use `wp.date.__experimentalGetSettings` instead.
 - `wp.compose.remountOnPropChange` has been removed.
 - The following editor store actions have been removed: `createNotice`, `removeNotice`, `createSuccessNotice`, `createInfoNotice`, `createErrorNotice`, `createWarningNotice`. Use the equivalent actions by the same name from the `@wordpress/notices` module.
+- The id prop of wp.nux.DotTip has been removed. Please use the tipId prop instead.
 
 ## 4.3.0
 

lib/client-assets.php

@@ -550,6 +550,7 @@ function gutenberg_register_scripts_and_styles() {
 			'wp-components',
 			'wp-compose',
 			'wp-data',
+			'wp-deprecated',
 			'wp-i18n',
 			'wp-polyfill',
 			'lodash',

package-lock.json

@@ -1,3 +1,9 @@
+## 2.0.7 (Unreleased)
+
+### Deprecations
+
+- The id prop of DotTip has been deprecated. Please use the tipId prop instead.
+
 ## 2.0.6 (2018-10-22)
 
 ## 2.0.5 (2018-10-19)

packages/nux/CHANGELOG.md

@@ -24,6 +24,7 @@
 		"@wordpress/components": "file:../components",
 		"@wordpress/compose": "file:../compose",
 		"@wordpress/data": "file:../data",
+		"@wordpress/deprecated": "file:../deprecated",
 		"@wordpress/element": "file:../element",
 		"@wordpress/i18n": "file:../i18n",
 		"lodash": "^4.17.10",

packages/nux/package.json

@@ -5,6 +5,7 @@ import { compose } from '@wordpress/compose';
 import { Popover, Button, IconButton } from '@wordpress/components';
 import { __ } from '@wordpress/i18n';
 import { withSelect, withDispatch } from '@wordpress/data';
+import { deprecated } from '@wordpress/deprecated';
 
 function getAnchorRect( anchor ) {
 	// The default getAnchorRect() excludes an element's top and bottom padding
@@ -58,19 +59,27 @@ export function DotTip( {
 }
 
 export default compose(
-	withSelect( ( select, { tipId } ) => {
+	withSelect( ( select, { tipId, id } ) => {
+		if ( id ) {
+			tipId = id;
+			deprecated( 'The id prop of wp.nux.DotTip', {
+				plugin: 'Gutenberg',
+				version: '4.4',
+				alternative: 'the tipId prop',
+			} );
+		}
 		const { isTipVisible, getAssociatedGuide } = select( 'core/nux' );
 		const associatedGuide = getAssociatedGuide( tipId );
 		return {
 			isVisible: isTipVisible( tipId ),
 			hasNextTip: !! ( associatedGuide && associatedGuide.nextTipId ),
 		};
 	} ),
-	withDispatch( ( dispatch, { tipId } ) => {
+	withDispatch( ( dispatch, { tipId, id } ) => {
 		const { dismissTip, disableTips } = dispatch( 'core/nux' );
 		return {
 			onDismiss() {
-				dismissTip( tipId );
+				dismissTip( tipId || id );
 			},
 			onDisable() {
 				disableTips();