@wordpress/editor 13.30.0 → 13.32.0

package/README.md

@@ -114,6 +114,863 @@ Example:
 } )( window.wp.editor, window.React );
 ```
 
+## API
+
+<!-- START TOKEN(Autogenerated API docs) -->
+
+### AlignmentToolbar
+
+> **Deprecated** since 5.3, use `wp.blockEditor.AlignmentToolbar` instead.
+
+### Autocomplete
+
+> **Deprecated** since 5.3, use `wp.blockEditor.Autocomplete` instead.
+
+### AutosaveMonitor
+
+Undocumented declaration.
+
+### BlockAlignmentToolbar
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockAlignmentToolbar` instead.
+
+### BlockControls
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockControls` instead.
+
+### BlockEdit
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockEdit` instead.
+
+### BlockEditorKeyboardShortcuts
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockEditorKeyboardShortcuts` instead.
+
+### BlockFormatControls
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockFormatControls` instead.
+
+### BlockIcon
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockIcon` instead.
+
+### BlockInspector
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockInspector` instead.
+
+### BlockList
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockList` instead.
+
+### BlockMover
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockMover` instead.
+
+### BlockNavigationDropdown
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockNavigationDropdown` instead.
+
+### BlockSelectionClearer
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockSelectionClearer` instead.
+
+### BlockSettingsMenu
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockSettingsMenu` instead.
+
+### BlockTitle
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockTitle` instead.
+
+### BlockToolbar
+
+> **Deprecated** since 5.3, use `wp.blockEditor.BlockToolbar` instead.
+
+### CharacterCount
+
+Undocumented declaration.
+
+### cleanForSlug
+
+Performs some basic cleanup of a string for use as a post slug
+
+This replicates some of what sanitize_title() does in WordPress core, but is only designed to approximate what the slug will be.
+
+Converts Latin-1 Supplement and Latin Extended-A letters to basic Latin letters. Removes combining diacritical marks. Converts whitespace, periods, and forward slashes to hyphens. Removes any remaining non-word characters except hyphens and underscores. Converts remaining string to lowercase. It does not account for octets, HTML entities, or other encoded characters.
+
+_Parameters_
+
+-   _string_ `string`: Title or slug to be processed
+
+_Returns_
+
+-   `string`: Processed string
+
+### ColorPalette
+
+> **Deprecated** since 5.3, use `wp.blockEditor.ColorPalette` instead.
+
+### ContrastChecker
+
+> **Deprecated** since 5.3, use `wp.blockEditor.ContrastChecker` instead.
+
+### CopyHandler
+
+> **Deprecated** since 5.3, use `wp.blockEditor.CopyHandler` instead.
+
+### createCustomColorsHOC
+
+> **Deprecated** since 5.3, use `wp.blockEditor.createCustomColorsHOC` instead.
+
+### DefaultBlockAppender
+
+> **Deprecated** since 5.3, use `wp.blockEditor.DefaultBlockAppender` instead.
+
+### DocumentBar
+
+Undocumented declaration.
+
+### DocumentOutline
+
+Undocumented declaration.
+
+### DocumentOutlineCheck
+
+Undocumented declaration.
+
+### EditorHistoryRedo
+
+Undocumented declaration.
+
+### EditorHistoryUndo
+
+Undocumented declaration.
+
+### EditorKeyboardShortcuts
+
+Undocumented declaration.
+
+### EditorKeyboardShortcutsRegister
+
+Undocumented declaration.
+
+### EditorNotices
+
+Undocumented declaration.
+
+### EditorProvider
+
+Undocumented declaration.
+
+### EditorSnackbars
+
+Undocumented declaration.
+
+### EntitiesSavedStates
+
+Undocumented declaration.
+
+### ErrorBoundary
+
+Undocumented declaration.
+
+### FontSizePicker
+
+> **Deprecated** since 5.3, use `wp.blockEditor.FontSizePicker` instead.
+
+### getColorClassName
+
+> **Deprecated** since 5.3, use `wp.blockEditor.getColorClassName` instead.
+
+### getColorObjectByAttributeValues
+
+> **Deprecated** since 5.3, use `wp.blockEditor.getColorObjectByAttributeValues` instead.
+
+### getColorObjectByColorValue
+
+> **Deprecated** since 5.3, use `wp.blockEditor.getColorObjectByColorValue` instead.
+
+### getFontSize
+
+> **Deprecated** since 5.3, use `wp.blockEditor.getFontSize` instead.
+
+### getFontSizeClass
+
+> **Deprecated** since 5.3, use `wp.blockEditor.getFontSizeClass` instead.
+
+### getTemplatePartIcon
+
+Helper function to retrieve the corresponding icon by name.
+
+_Parameters_
+
+-   _iconName_ `string`: The name of the icon.
+
+_Returns_
+
+-   `Object`: The corresponding icon.
+
+### InnerBlocks
+
+> **Deprecated** since 5.3, use `wp.blockEditor.InnerBlocks` instead.
+
+### Inserter
+
+> **Deprecated** since 5.3, use `wp.blockEditor.Inserter` instead.
+
+### InspectorAdvancedControls
+
+> **Deprecated** since 5.3, use `wp.blockEditor.InspectorAdvancedControls` instead.
+
+### InspectorControls
+
+> **Deprecated** since 5.3, use `wp.blockEditor.InspectorControls` instead.
+
+### LocalAutosaveMonitor
+
+Undocumented declaration.
+
+### MediaPlaceholder
+
+> **Deprecated** since 5.3, use `wp.blockEditor.MediaPlaceholder` instead.
+
+### MediaUpload
+
+> **Deprecated** since 5.3, use `wp.blockEditor.MediaUpload` instead.
+
+### mediaUpload
+
+Upload a media file when the file upload button is activated. Wrapper around mediaUpload() that injects the current post ID.
+
+_Parameters_
+
+-   _$0_ `Object`: Parameters object passed to the function.
+-   _$0.additionalData_ `?Object`: Additional data to include in the request.
+-   _$0.allowedTypes_ `string`: Array with the types of media that can be uploaded, if unset all types are allowed.
+-   _$0.filesList_ `Array`: List of files.
+-   _$0.maxUploadFileSize_ `?number`: Maximum upload size in bytes allowed for the site.
+-   _$0.onError_ `Function`: Function called when an error happens.
+-   _$0.onFileChange_ `Function`: Function called each time a file or a temporary representation of the file is available.
+
+### MediaUploadCheck
+
+> **Deprecated** since 5.3, use `wp.blockEditor.MediaUploadCheck` instead.
+
+### MultiSelectScrollIntoView
+
+> **Deprecated** since 5.3, use `wp.blockEditor.MultiSelectScrollIntoView` instead.
+
+### NavigableToolbar
+
+> **Deprecated** since 5.3, use `wp.blockEditor.NavigableToolbar` instead.
+
+### ObserveTyping
+
+> **Deprecated** since 5.3, use `wp.blockEditor.ObserveTyping` instead.
+
+### PageAttributesCheck
+
+Undocumented declaration.
+
+### PageAttributesOrder
+
+Undocumented declaration.
+
+### PageAttributesPanel
+
+Undocumented declaration.
+
+### PageAttributesParent
+
+Undocumented declaration.
+
+### PageTemplate
+
+Undocumented declaration.
+
+### PanelColorSettings
+
+> **Deprecated** since 5.3, use `wp.blockEditor.PanelColorSettings` instead.
+
+### PlainText
+
+> **Deprecated** since 5.3, use `wp.blockEditor.PlainText` instead.
+
+### PluginBlockSettingsMenuItem
+
+Renders a new item in the block settings menu.
+
+_Usage_
+
+```js
+// Using ES5 syntax
+var __ = wp.i18n.__;
+var PluginBlockSettingsMenuItem = wp.editor.PluginBlockSettingsMenuItem;
+
+function doOnClick() {
+	// To be called when the user clicks the menu item.
+}
+
+function MyPluginBlockSettingsMenuItem() {
+	return React.createElement( PluginBlockSettingsMenuItem, {
+		allowedBlocks: [ 'core/paragraph' ],
+		icon: 'dashicon-name',
+		label: __( 'Menu item text' ),
+		onClick: doOnClick,
+	} );
+}
+```
+
+```jsx
+// Using ESNext syntax
+import { __ } from '@wordpress/i18n';
+import { PluginBlockSettingsMenuItem } from '@wordpress/editor';
+
+const doOnClick = () => {
+	// To be called when the user clicks the menu item.
+};
+
+const MyPluginBlockSettingsMenuItem = () => (
+	<PluginBlockSettingsMenuItem
+		allowedBlocks={ [ 'core/paragraph' ] }
+		icon="dashicon-name"
+		label={ __( 'Menu item text' ) }
+		onClick={ doOnClick }
+	/>
+);
+```
+
+_Parameters_
+
+-   _props_ `Object`: Component props.
+-   _props.allowedBlocks_ `[Array]`: An array containing a list of block names for which the item should be shown. If not present, it'll be rendered for any block. If multiple blocks are selected, it'll be shown if and only if all of them are in the allowed list.
+-   _props.icon_ `[WPBlockTypeIconRender]`: The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element.
+-   _props.label_ `string`: The menu item text.
+-   _props.onClick_ `Function`: Callback function to be executed when the user click the menu item.
+-   _props.small_ `[boolean]`: Whether to render the label or not.
+-   _props.role_ `[string]`: The ARIA role for the menu item.
+
+_Returns_
+
+-   `Component`: The component to be rendered.
+
+### PluginDocumentSettingPanel
+
+Renders items below the Status & Availability panel in the Document Sidebar.
+
+_Usage_
+
+```js
+// Using ES5 syntax
+var el = React.createElement;
+var __ = wp.i18n.__;
+var registerPlugin = wp.plugins.registerPlugin;
+var PluginDocumentSettingPanel = wp.editor.PluginDocumentSettingPanel;
+
+function MyDocumentSettingPlugin() {
+	return el(
+		PluginDocumentSettingPanel,
+		{
+			className: 'my-document-setting-plugin',
+			title: 'My Panel',
+			name: 'my-panel',
+		},
+		__( 'My Document Setting Panel' )
+	);
+}
+
+registerPlugin( 'my-document-setting-plugin', {
+	render: MyDocumentSettingPlugin,
+} );
+```
+
+```jsx
+// Using ESNext syntax
+import { registerPlugin } from '@wordpress/plugins';
+import { PluginDocumentSettingPanel } from '@wordpress/editor';
+
+const MyDocumentSettingTest = () => (
+	<PluginDocumentSettingPanel
+		className="my-document-setting-plugin"
+		title="My Panel"
+		name="my-panel"
+	>
+		<p>My Document Setting Panel</p>
+	</PluginDocumentSettingPanel>
+);
+
+registerPlugin( 'document-setting-test', { render: MyDocumentSettingTest } );
+```
+
+_Parameters_
+
+-   _props_ `Object`: Component properties.
+-   _props.name_ `string`: Required. A machine-friendly name for the panel.
+-   _props.className_ `[string]`: An optional class name added to the row.
+-   _props.title_ `[string]`: The title of the panel
+-   _props.icon_ `[WPBlockTypeIconRender]`: The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered when the sidebar is pinned to toolbar.
+-   _props.children_ `Element`: Children to be rendered
+
+_Returns_
+
+-   `Component`: The component to be rendered.
+
+### PluginPostPublishPanel
+
+Renders provided content to the post-publish panel in the publish flow (side panel that opens after a user publishes the post).
+
+_Usage_
+
+```jsx
+// Using ESNext syntax
+import { __ } from '@wordpress/i18n';
+import { PluginPostPublishPanel } from '@wordpress/edit-post';
+
+const MyPluginPostPublishPanel = () => (
+	<PluginPostPublishPanel
+		className="my-plugin-post-publish-panel"
+		title={ __( 'My panel title' ) }
+		initialOpen={ true }
+	>
+		{ __( 'My panel content' ) }
+	</PluginPostPublishPanel>
+);
+```
+
+_Parameters_
+
+-   _props_ `Object`: Component properties.
+-   _props.className_ `[string]`: An optional class name added to the panel.
+-   _props.title_ `[string]`: Title displayed at the top of the panel.
+-   _props.initialOpen_ `[boolean]`: Whether to have the panel initially opened. When no title is provided it is always opened.
+-   _props.icon_ `[WPBlockTypeIconRender]`: The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered when the sidebar is pinned to toolbar.
+-   _props.children_ `Element`: Children to be rendered
+
+_Returns_
+
+-   `Component`: The component to be rendered.
+
+### PluginPrePublishPanel
+
+Renders provided content to the pre-publish side panel in the publish flow (side panel that opens when a user first pushes "Publish" from the main editor).
+
+_Usage_
+
+```jsx
+// Using ESNext syntax
+import { __ } from '@wordpress/i18n';
+import { PluginPrePublishPanel } from '@wordpress/edit-post';
+
+const MyPluginPrePublishPanel = () => (
+	<PluginPrePublishPanel
+		className="my-plugin-pre-publish-panel"
+		title={ __( 'My panel title' ) }
+		initialOpen={ true }
+	>
+		{ __( 'My panel content' ) }
+	</PluginPrePublishPanel>
+);
+```
+
+_Parameters_
+
+-   _props_ `Object`: Component props.
+-   _props.className_ `[string]`: An optional class name added to the panel.
+-   _props.title_ `[string]`: Title displayed at the top of the panel.
+-   _props.initialOpen_ `[boolean]`: Whether to have the panel initially opened. When no title is provided it is always opened.
+-   _props.icon_ `[WPBlockTypeIconRender]`: The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered when the sidebar is pinned to toolbar.
+-   _props.children_ `Element`: Children to be rendered
+
+_Returns_
+
+-   `Component`: The component to be rendered.
+
+### PostAuthor
+
+Undocumented declaration.
+
+### PostAuthorCheck
+
+Undocumented declaration.
+
+### PostAuthorPanel
+
+Undocumented declaration.
+
+### PostComments
+
+Undocumented declaration.
+
+### PostDiscussionPanel
+
+Undocumented declaration.
+
+### PostExcerpt
+
+Undocumented declaration.
+
+### PostExcerptCheck
+
+Undocumented declaration.
+
+### PostExcerptPanel
+
+Undocumented declaration.
+
+### PostFeaturedImage
+
+Undocumented declaration.
+
+### PostFeaturedImageCheck
+
+Undocumented declaration.
+
+### PostFeaturedImagePanel
+
+Undocumented declaration.
+
+### PostFormat
+
+Undocumented declaration.
+
+### PostFormatCheck
+
+Undocumented declaration.
+
+### PostLastRevision
+
+Undocumented declaration.
+
+### PostLastRevisionCheck
+
+Undocumented declaration.
+
+### PostLastRevisionPanel
+
+Undocumented declaration.
+
+### PostLockedModal
+
+Undocumented declaration.
+
+### PostPendingStatus
+
+Undocumented declaration.
+
+### PostPendingStatusCheck
+
+Undocumented declaration.
+
+### PostPingbacks
+
+Undocumented declaration.
+
+### PostPreviewButton
+
+Undocumented declaration.
+
+### PostPublishButton
+
+Undocumented declaration.
+
+### PostPublishButtonLabel
+
+Undocumented declaration.
+
+### PostPublishPanel
+
+Undocumented declaration.
+
+### PostSavedState
+
+Component showing whether the post is saved or not and providing save buttons.
+
+_Parameters_
+
+-   _props_ `Object`: Component props.
+-   _props.forceIsDirty_ `?boolean`: Whether to force the post to be marked as dirty.
+
+_Returns_
+
+-   `import('react').ComponentType`: The component.
+
+### PostSchedule
+
+Undocumented declaration.
+
+### PostScheduleCheck
+
+Undocumented declaration.
+
+### PostScheduleLabel
+
+Undocumented declaration.
+
+### PostSchedulePanel
+
+Undocumented declaration.
+
+### PostSlug
+
+Undocumented declaration.
+
+### PostSlugCheck
+
+Undocumented declaration.
+
+### PostSticky
+
+Undocumented declaration.
+
+### PostStickyCheck
+
+Undocumented declaration.
+
+### PostSwitchToDraftButton
+
+Undocumented declaration.
+
+### PostSyncStatus
+
+Undocumented declaration.
+
+### PostTaxonomies
+
+Undocumented declaration.
+
+### PostTaxonomiesCheck
+
+Undocumented declaration.
+
+### PostTaxonomiesFlatTermSelector
+
+Undocumented declaration.
+
+### PostTaxonomiesHierarchicalTermSelector
+
+Hierarchical term selector.
+
+_Parameters_
+
+-   _props_ `Object`: Component props.
+-   _props.slug_ `string`: Taxonomy slug.
+
+_Returns_
+
+-   `Element`: Hierarchical term selector component.
+
+### PostTaxonomiesPanel
+
+Undocumented declaration.
+
+### PostTemplatePanel
+
+Undocumented declaration.
+
+### PostTextEditor
+
+Undocumented declaration.
+
+### PostTitle
+
+Undocumented declaration.
+
+### PostTitleRaw
+
+Undocumented declaration.
+
+### PostTrash
+
+Undocumented declaration.
+
+### PostTrashCheck
+
+Undocumented declaration.
+
+### PostTypeSupportCheck
+
+A component which renders its own children only if the current editor post type supports one of the given `supportKeys` prop.
+
+_Parameters_
+
+-   _props_ `Object`: Props.
+-   _props.children_ `Element`: Children to be rendered if post type supports.
+-   _props.supportKeys_ `(string|string[])`: String or string array of keys to test.
+
+_Returns_
+
+-   `Component`: The component to be rendered.
+
+### PostURL
+
+Undocumented declaration.
+
+### PostURLCheck
+
+Undocumented declaration.
+
+### PostURLLabel
+
+Undocumented declaration.
+
+### PostURLPanel
+
+Undocumented declaration.
+
+### PostVisibility
+
+Undocumented declaration.
+
+### PostVisibilityCheck
+
+Undocumented declaration.
+
+### PostVisibilityLabel
+
+Undocumented declaration.
+
+### privateApis
+
+Undocumented declaration.
+
+### RichText
+
+> **Deprecated** since 5.3, use `wp.blockEditor.RichText` instead.
+
+### RichTextShortcut
+
+> **Deprecated** since 5.3, use `wp.blockEditor.RichTextShortcut` instead.
+
+### RichTextToolbarButton
+
+> **Deprecated** since 5.3, use `wp.blockEditor.RichTextToolbarButton` instead.
+
+### ServerSideRender
+
+Undocumented declaration.
+
+### SkipToSelectedBlock
+
+> **Deprecated** since 5.3, use `wp.blockEditor.SkipToSelectedBlock` instead.
+
+### store
+
+Store definition for the editor namespace.
+
+_Related_
+
+-   <https://github.com/WordPress/gutenberg/blob/HEAD/packages/data/README.md#createReduxStore>
+
+_Type_
+
+-   `Object`
+
+### storeConfig
+
+Post editor data store configuration.
+
+_Related_
+
+-   <https://github.com/WordPress/gutenberg/blob/HEAD/packages/data/README.md#registerStore>
+
+_Type_
+
+-   `Object`
+
+### TableOfContents
+
+Undocumented declaration.
+
+### TextEditorGlobalKeyboardShortcuts
+
+Undocumented declaration.
+
+### ThemeSupportCheck
+
+Undocumented declaration.
+
+### TimeToRead
+
+Undocumented declaration.
+
+### transformStyles
+
+Undocumented declaration.
+
+### UnsavedChangesWarning
+
+Warns the user if there are unsaved changes before leaving the editor. Compatible with Post Editor and Site Editor.
+
+_Returns_
+
+-   `Component`: The component.
+
+### URLInput
+
+> **Deprecated** since 5.3, use `wp.blockEditor.URLInput` instead.
+
+### URLInputButton
+
+> **Deprecated** since 5.3, use `wp.blockEditor.URLInputButton` instead.
+
+### URLPopover
+
+> **Deprecated** since 5.3, use `wp.blockEditor.URLPopover` instead.
+
+### useEntitiesSavedStatesIsDirty
+
+Undocumented declaration.
+
+### usePostScheduleLabel
+
+Undocumented declaration.
+
+### usePostURLLabel
+
+Undocumented declaration.
+
+### usePostVisibilityLabel
+
+Undocumented declaration.
+
+### userAutocompleter
+
+A user mentions completer.
+
+_Type_
+
+-   `WPCompleter`
+
+### VisualEditorGlobalKeyboardShortcuts
+
+Undocumented declaration.
+
+### Warning
+
+> **Deprecated** since 5.3, use `wp.blockEditor.Warning` instead.
+
+### withColorContext
+
+> **Deprecated** since 5.3, use `wp.blockEditor.createCustomColorsHOC` instead.
+
+### withColors
+
+> **Deprecated** since 5.3, use `wp.blockEditor.withColors` instead.
+
+### withFontSizes
+
+> **Deprecated** since 5.3, use `wp.blockEditor.withFontSizes` instead.
+
+### WordCount
+
+Undocumented declaration.
+
+### WritingFlow
+
+> **Deprecated** since 5.3, use `wp.blockEditor.WritingFlow` instead.
+
+<!-- END TOKEN(Autogenerated API docs) -->
+
 ## 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.