astro-portabletext • Type Definitions
| Interface | Description |
|---|---|
| PortableTextProps | Properties for the PortableText component |
| PortableTextComponents | Defines how Portable Text types should be rendered. |
| Props | Component Props |
| Block | Alias to PortableTextBlock with style set to normal when undefined |
| Mark | Extends ToolkitNestedPortableTextSpan with consisting markDef and markKey properties |
| Context | Context object returned by usePortableText, providing utilities for rendering and customizing Portable Text components. |
| TypedObject | Any object with an _type property (which is required in portable text arrays), as well as a potential _key (highly encouraged) |
| Type alias | Description |
|---|---|
| SomePortableTextComponents | Defines how some Portable Text types should be rendered. |
| BlockProps | Convenience type for Block component props |
| List | Alias to ToolkitPortableTextList |
| ListProps | Convenience type for List component props |
| ListItem | Alias to ToolkitPortableTextListItem |
| ListItemProps | Convenience type for ListItem component props |
| MarkProps | Convenience type for Mark component props |
| TextNode | Alias to ToolkitTextNode |
| TextNodeProps | Convenience type for TextNode component props |
| MissingComponentHandler | The shape of the onMissingComponent function |
| RenderHandlerProps | Properties for the RenderHandler function |
| RenderHandler | The shape of the render component function |
| RenderOptions | Options for the render function accessed via usePortableText |
| Component | Generic Portable Text component |
| ComponentOrRecord | Defines a component or a mapping of components |
| NodeType | Defines the type of Portable Text node |