Skip to main content

How to use 8.5k

Start free trial

UsePageBlock | Vendure Docs

Home
Vendure Framework
PageLayout
UsePageBlock

UsePageBlock

@vendure/dashboard Sourcev3.3.0

Returns the current PageBlock context, which means there must be a PageBlock ancestor component higher in the tree.

If optional is set to true, the hook will not throw if no PageBlock exists higher in the tree, but will just return undefined.

Was this chapter helpful?

PreviousPageTitle NextVite Plugin

Edited Jan 28, 2026·View source

Past the docs?

Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.

Talk to the team

On this page

Example

Tsx

const { blockId, title, description, column } = usePageBlock();

Signature

function usePageBlock(props: { optional?: boolean } = {}): void

Parameters

props

parameter{ optional?: boolean }