page-block.md 3.5 KB


title: "PageBlock" isDefaultIndex: false

generated: true

import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';

PageBlock

Status: Developer Preview

A component for displaying a block of content on a page. This should be used inside the PageLayout component. It should be provided with a column prop to determine which column it should appear in, and a blockId prop to identify the block.

function PageBlock(props: Readonly<PageBlockProps>): void

Parameters

props

PageBlockProps>`} />

PageBlockProps

Status: Developer Preview

type PageBlockProps = {
    children?: React.ReactNode;
    column: 'main' | 'side';
    blockId?: string;
    title?: React.ReactNode | string;
    description?: React.ReactNode | string;
    className?: string;
}
### children ### column ### blockId ### title ### description ### className

FullWidthPageBlock

Status: Developer Preview

A component for displaying a block of content on a page that takes up the full width of the page. This should be used inside the PageLayout component.

function FullWidthPageBlock(props: Readonly<Pick<PageBlockProps, 'children' | 'className' | 'blockId'>>): void

Parameters

props

PageBlockProps, 'children' | 'className' | 'blockId'>>`} />

CustomFieldsPageBlock

Status: Developer Preview

A component for displaying an auto-generated form for custom fields on a page.

function CustomFieldsPageBlock(props: Readonly<{
    column: 'main' | 'side';
    entityType: string;
    control: Control<any, any>;
}>): void

Parameters

props