Property
Document object properties
Document API properties with types, defaults, and descriptions.
Usage
title
stringrequiredthe page title displayed in the header
description
stringoptional description shown below title
order
numberdefault: 0sort order in navigation
Deprecated properties
Mark properties as deprecated:
oldProp
stringdeprecateduse newProp instead
Property props
| prop | type | default | description |
|---|---|---|---|
| name | string | - | Property name |
| type | string | - | Property type |
| required | boolean | false | Mark as required |
| default | string | - | Default value |
| deprecated | boolean | false | Mark as deprecated |
| children | ReactNode | - | Property description |
Properties props
| prop | type | default | description |
|---|---|---|---|
| children | ReactNode | - | Property items |