Property
Display the signature details of a property.
Use the <Property /> component to display the signature of a property, such as the name, type and description.
The description can be provided as children to the component, allowing for rich formatting using Markdown syntax.
Example
themeThemerequiredDefines the theming properties for your application.
{
"color": "#ff0000",
"font": "Arial"
}
The Theme object should contain the following properties:
colorstringrequiredThe theme colour of your brand.
fontstringoptionalThe font family to use for your application. Defaults to Comic Sans.
Usage
<Property name="theme" type="Theme" required>
Defines the theming properties for your application.
```json
{
"color": "#ff0000",
"font": "Arial"
}
```
The `Theme` object should contain the following properties:
<Accordion title="Theme" defaultOpen>
<Property name="color" type="string" required>
The theme colour of your brand.
</Property>
---
<Property name="font" type="string" optional>
The font family to use for your application. Defaults to `Comic Sans`.
</Property>
</Accordion>
</Property>
Props
namestringrequiredThe name of the property
typestringoptionalThe type of the property, such as string, boolean etc.
requiredbooleanoptionalWhether to mark this property as required.
optionalbooleanoptionalWhether to mark this property as optional.
childrenoptionalThe children to render as the properties description.