Incorrect type definition for WPNoticeAction and missing docs for type option for notices

[ocean90]

• Notices support a type property which isn't documented yet. The default value is 'default' but can also be 'snackbar'. Should be documented in

  • gutenberg/packages/notices/src/store/selectors.js

    Lines 17 to 34 in 5920ab8

    	/**
    	* @typedef {Object} WPNotice Notice object.
    	*
    	* @property {string} id Unique identifier of notice.
    	* @property {string} status Status of notice, one of `success`,
    	* `info`, `error`, or `warning`. Defaults
    	* to `info`.
    	* @property {string} content Notice message.
    	* @property {string} __unstableHTML Notice message as raw HTML. Intended to
    	* serve primarily for compatibility of
    	* server-rendered notices, and SHOULD NOT
    	* be used for notices. It is subject to
    	* removal without notice.
    	* @property {boolean} isDismissible Whether the notice can be dismissed by
    	* user. Defaults to `true`.
    	* @property {WPNoticeAction[]} actions User actions to present with notice.
    	*
    	*/

  • gutenberg/packages/notices/src/store/actions.js

    Lines 11 to 33 in 4956082

    	/**
    	* Yields action objects used in signalling that a notice is to be created.
    	*
    	* @param {?string} status Notice status.
    	* Defaults to `info`.
    	* @param {string} content Notice message.
    	* @param {?Object} options Notice options.
    	* @param {?string} options.context Context under which to
    	* group notice.
    	* @param {?string} options.id Identifier for notice.
    	* Automatically assigned
    	* if not specified.
    	* @param {?boolean} options.isDismissible Whether the notice can
    	* be dismissed by user.
    	* Defaults to `true`.
    	* @param {?boolean} options.speak Whether the notice
    	* content should be
    	* announced to screen
    	* readers. Defaults to
    	* `true`.
    	* @param {?Array<WPNoticeAction>} options.actions User actions to be
    	* presented with notice.
    	*/

• For WPNoticeAction, callback should be onClick, see https://github.com/WordPress/gutenberg/blob/master/packages/components/src/snackbar/index.js#L55-L63.

[simono]

@ocean90 I've tried to fix this in #17206. What do you think?