@types/wordpress__block-editor 14.21.3 → 14.21.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- wordpress__block-editor/README.md +1 -1
- wordpress__block-editor/components/index.d.ts +1 -0
- wordpress__block-editor/components/rich-text.d.ts +8 -0
- wordpress__block-editor/components/use-block-editing-mode.d.ts +35 -0
- wordpress__block-editor/index.d.ts +3 -0
- wordpress__block-editor/package.json +2 -2
- wordpress__block-editor/store/selectors.d.ts +9 -0
|
@@ -8,7 +8,7 @@ This package contains type definitions for @wordpress/block-editor (https://gith
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/wordpress__block-editor.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Sat, 27 Dec 2025 04:41:08 GMT
|
|
12
12
|
* Dependencies: [@types/react](https://npmjs.com/package/@types/react), [@types/wordpress__blocks](https://npmjs.com/package/@types/wordpress__blocks), [@wordpress/components](https://npmjs.com/package/@wordpress/components), [@wordpress/data](https://npmjs.com/package/@wordpress/data), [@wordpress/element](https://npmjs.com/package/@wordpress/element), [@wordpress/keycodes](https://npmjs.com/package/@wordpress/keycodes), [react-autosize-textarea](https://npmjs.com/package/react-autosize-textarea)
|
|
13
13
|
|
|
14
14
|
# Credits
|
|
@@ -64,5 +64,6 @@ export { default as BlockEditorProvider } from "./provider";
|
|
|
64
64
|
*/
|
|
65
65
|
export { useBlockBindingsUtils } from "./use-block-bindings-utils";
|
|
66
66
|
export { useBlockEditContext } from "./use-block-edit-context";
|
|
67
|
+
export { useBlockEditingMode } from "./use-block-editing-mode";
|
|
67
68
|
export { useBlockProps } from "./use-block-props";
|
|
68
69
|
export { useSettings } from "./use-settings";
|
|
@@ -17,6 +17,10 @@ declare namespace RichText {
|
|
|
17
17
|
autocompleters?: ComponentProps<typeof Autocomplete>["completers"] | undefined;
|
|
18
18
|
children?: never | undefined;
|
|
19
19
|
className?: string | undefined;
|
|
20
|
+
/**
|
|
21
|
+
* Disables inserting line breaks on Enter when it is set to true
|
|
22
|
+
*/
|
|
23
|
+
disableLineBreaks?: boolean | undefined;
|
|
20
24
|
identifier?: string | undefined;
|
|
21
25
|
inlineToolbar?: boolean | undefined;
|
|
22
26
|
/**
|
|
@@ -66,6 +70,10 @@ declare namespace RichText {
|
|
|
66
70
|
* if provided.
|
|
67
71
|
*/
|
|
68
72
|
value: string;
|
|
73
|
+
/**
|
|
74
|
+
* By default, all formatting controls are present. This setting can be used to remove formatting controls that would make content interactive. This is useful if you want to make content that is already interactive editable.
|
|
75
|
+
*/
|
|
76
|
+
withoutInteractiveFormatting?: boolean | undefined;
|
|
69
77
|
wrapperClassName?: string | undefined;
|
|
70
78
|
}
|
|
71
79
|
interface ContentProps<T extends keyof HTMLElementTagNameMap> extends HTMLProps<T> {
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
export namespace useBlockEditingMode {
|
|
2
|
+
type BlockEditingMode = "disabled" | "contentOnly" | "default";
|
|
3
|
+
}
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Allows a block to restrict the user interface that is displayed for editing
|
|
7
|
+
* that block and its inner blocks.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```js
|
|
11
|
+
* function MyBlock( { attributes, setAttributes } ) {
|
|
12
|
+
* useBlockEditingMode( 'disabled' );
|
|
13
|
+
* return <div { ...useBlockProps() }></div>;
|
|
14
|
+
* }
|
|
15
|
+
* ```
|
|
16
|
+
*
|
|
17
|
+
* `mode` can be one of three options:
|
|
18
|
+
*
|
|
19
|
+
* - `'disabled'`: Prevents editing the block entirely, i.e. it cannot be
|
|
20
|
+
* selected.
|
|
21
|
+
* - `'contentOnly'`: Hides all non-content UI, e.g. auxiliary controls in the
|
|
22
|
+
* toolbar, the block movers, block settings.
|
|
23
|
+
* - `'default'`: Allows editing the block as normal.
|
|
24
|
+
*
|
|
25
|
+
* The mode is inherited by all of the block's inner blocks, unless they have
|
|
26
|
+
* their own mode.
|
|
27
|
+
*
|
|
28
|
+
* If called outside of a block context, the mode is applied to all blocks.
|
|
29
|
+
*
|
|
30
|
+
* @param {?useBlockEditingMode.BlockEditingMode} mode The editing mode to apply. If undefined, the
|
|
31
|
+
* current editing mode is not changed.
|
|
32
|
+
*
|
|
33
|
+
* @return {useBlockEditingMode.BlockEditingMode} The current editing mode.
|
|
34
|
+
*/
|
|
35
|
+
export function useBlockEditingMode(mode?: useBlockEditingMode.BlockEditingMode): useBlockEditingMode.BlockEditingMode;
|
|
@@ -10,6 +10,9 @@ export * from "./utils";
|
|
|
10
10
|
declare module "@wordpress/data" {
|
|
11
11
|
function dispatch(key: "core/block-editor"): typeof import("./store/actions");
|
|
12
12
|
function select(key: "core/block-editor"): typeof import("./store/selectors");
|
|
13
|
+
|
|
14
|
+
function useDispatch(key: "core/block-editor"): typeof import("./store/actions");
|
|
15
|
+
function useSelect(key: "core/block-editor"): typeof import("./store/selectors");
|
|
13
16
|
}
|
|
14
17
|
|
|
15
18
|
export interface BlockEditorStoreDescriptor extends StoreDescriptor {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/wordpress__block-editor",
|
|
3
|
-
"version": "14.21.
|
|
3
|
+
"version": "14.21.5",
|
|
4
4
|
"description": "TypeScript definitions for @wordpress/block-editor",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/wordpress__block-editor",
|
|
6
6
|
"license": "MIT",
|
|
@@ -44,6 +44,6 @@
|
|
|
44
44
|
"react-autosize-textarea": "^7.1.0"
|
|
45
45
|
},
|
|
46
46
|
"peerDependencies": {},
|
|
47
|
-
"typesPublisherContentHash": "
|
|
47
|
+
"typesPublisherContentHash": "9212083afa7e8967a71375a1a426185e9187a49c09dba790d76cf9c6e4f742d9",
|
|
48
48
|
"typeScriptVersion": "5.2"
|
|
49
49
|
}
|
|
@@ -191,6 +191,15 @@ export function getBlocks(rootClientId?: string): BlockInstance[];
|
|
|
191
191
|
*/
|
|
192
192
|
export function getBlocksByClientId(clientIds: string | string[]): Array<BlockInstance | null>;
|
|
193
193
|
|
|
194
|
+
/**
|
|
195
|
+
* Returns all blocks that match a blockName. Results include nested blocks.
|
|
196
|
+
*
|
|
197
|
+
* @param blockName - Block name(s) for which clientIds are to be returned.
|
|
198
|
+
*
|
|
199
|
+
* @returns Array of clientIds of blocks with name equal to blockName.
|
|
200
|
+
*/
|
|
201
|
+
export function getBlocksByName(blockName: string | string[]): string[];
|
|
202
|
+
|
|
194
203
|
/**
|
|
195
204
|
* Returns an array containing the clientIds of all descendants of the blocks given.
|
|
196
205
|
*
|