Skip to content
This repository has been archived by the owner on Dec 16, 2023. It is now read-only.

Commit

Permalink
Document the props of the RenderBlocks
Browse files Browse the repository at this point in the history
  • Loading branch information
sneridagh committed Nov 15, 2023
1 parent 1faa5f2 commit d728ef2
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions src/Views/RenderBlocks/RenderBlocks.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,29 @@ import type { BlocksConfig } from '@plone/types/config/Blocks';
import type { Location } from 'history';

type RenderBlocksProps = {
/**
* Plone content object
*/
content: GetContentResponse;
/**
* Current blocks configuration object
* From the registry or local to this instance (eg. in a blocks in block container)
*/
blocksConfig: BlocksConfig;
/**
* Wrap the blocks in an enclosing tag
* From the registry or local to this instance (eg. in a blocks in block container)
*/
as: React.ElementType;
/**
* Router location object
*/
location: Location;
/**
* Metadata object
* In case of the blocks in block container use case, it's the metadata (content data)
* from the parent container, passed down to the contained blocks
*/
metadata?: GetContentResponse;
};

Expand Down

0 comments on commit d728ef2

Please sign in to comment.