Interface: IPreformattedBlock
@headstartwp/core.react.IPreformattedBlock
The common interface for a block transform component
Hierarchy
IBlock
<PreformattedBlockProps
>↳
IPreformattedBlock
Properties
children
• Optional
children: ReactNode
The children of the domNode that was replaced with the react component
Note: the children of the domNode are recursively parsed.
Inherited from
Defined in
packages/core/src/react/components/BlocksRenderer.tsx:56
classList
• Optional
classList: string
| string
[]
The class name of the domNode that should be replaced with the react component
If tagName is specified, then classList is mandatory
Inherited from
Defined in
packages/core/src/react/components/BlocksRenderer.tsx:44
className
• Optional
className: string
Inherited from
Defined in
packages/core/src/react/components/BlocksRenderer.tsx:69
component
• component: (props
: PreformattedBlockProps
) => null
| ReactElement
<any
, string
| JSXElementConstructor
<any
>>
Type declaration
▸ (props
): null
| ReactElement
<any
, string
| JSXElementConstructor
<any
>>
Parameters
Name | Type |
---|---|
props | PreformattedBlockProps |
Returns
null
| ReactElement
<any
, string
| JSXElementConstructor
<any
>>
Inherited from
Defined in
packages/core/src/react/components/BlocksRenderer.tsx:70
domNode
• Optional
domNode: Element
Inherited from
Defined in
packages/core/src/react/components/BlocksRenderer.tsx:68
exclude
• Optional
exclude: (childNode
: Element
, site?
: HeadlessConfig
) => boolean
Type declaration
▸ (childNode
, site?
): boolean
An optional exclude function that also receives a domNode and is executed against every child of the node being replaced with a react component.
This is useful to selectively disregard certain children of a node when replacing with a react component.
Parameters
Name | Type |
---|---|
childNode | Element |
site? | HeadlessConfig |
Returns
boolean
Inherited from
Defined in
packages/core/src/react/components/BlocksRenderer.tsx:30
style
• Optional
style: Record
<string
, string
>
The style tag of the domNode as an object.
Inherited from
Defined in
packages/core/src/react/components/BlocksRenderer.tsx:61
tagName
• Optional
tagName: string
The tag name of the domNode that should be replaced with the react component
If a test function is not supplied, then passing tagName is mandatory