Block Editor: LinkControl: Document only url, title, opensInNewTab va…

…lue properties
WordPress · Jan 28, 2020 · bc5e696 · bc5e696
1 parent 19b918e
commit bc5e696
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 14 deletions.
diff --git a/packages/block-editor/src/components/link-control/README.md b/packages/block-editor/src/components/link-control/README.md
@@ -17,11 +17,9 @@ A link value contains is composed as a union of the default properties and any c
 
 Default properties include:
 
-- id (`string|number`): Unique identifier of link.
-- url (`string`): Link URL.
-- title (`string`): Link title.
-- type (`string`): Type of link entity.
-- subtype (`string`): Subtype of link entity.
+- `url` (`string`): Link URL.
+- `title` (`string`, optional): Link title.
+- `opensInNewTab` (`boolean`, optional): Whether link should open in a new browser tab.This value is only assigned if not providing a custom `settings` prop.
 
 ### settings
 

diff --git a/packages/block-editor/src/components/link-control/index.js b/packages/block-editor/src/components/link-control/index.js
@@ -32,15 +32,11 @@ import LinkControlSearchInput from './search-input';
  *
  * @typedef WPLinkControlDefaultValue
  *
- * @property {string|number} id              Unique identifier of link.
- * @property {string}        url             Link URL.
- * @property {string}        title           Link title.
- * @property {string}        type            Type of link entity.
- * @property {string}        subtype         Subtype of link entity.
- * @property {boolean}       [opensInNewTab] Whether link should open in a new
- *                                           browser tab. This value is only
- *                                           assigned if not providing a custom
- *                                           settings array.
+ * @property {string}   url           Link URL.
+ * @property {string=}  title         Link title.
+ * @property {boolean=} opensInNewTab Whether link should open in a new browser
+ *                                    tab. This value is only assigned if not
+ *                                    providing a custom `settings` prop.
  */
 
 /**