stringAn ID for the page block. Should be unique at least to the page in which it appears.
React.ReactNodeAn optional title for the page block
React.ReactNodev3.8.0Optional supporting text displayed below the page block title.
PageBlockLocationThe location of the page block. It specifies the pageId, and then the relative location compared to another existing block.
React.FunctionComponent<{ context: PageContextValue }>The component to be rendered inside the page block.
(context: PageContextValue) => booleanv3.5.0Control whether to render the page block depending on your custom logic.
This can also be used to disable any built-in blocks you do not need to display.
If you need to query aspects about the current context not immediately
provided in the PageContextValue, you can also use hooks such as
useChannel in this function.
string | string[]If provided, the logged-in user must have one or more of the specified permissions in order for the block to render.
For more advanced control over rendering, use the shouldRender function.
The relative position of a PageBlock. This is determined by finding an existing block, and then specifying whether your custom block should come before, after, or completely replace that block.
The location of a page block in the dashboard. The location can be found by turning on
"developer mode" in the dashboard user menu (bottom left corner) and then
clicking the < /> icon when hovering over a page block.
Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.
Talk to the team