Summary specifies a configuration to produce user-facing copy for child schemas of List.
Default values may be specified to be used if values are not provided on child schemas.
A schema which provides values for the summary.
| Property | Type | Required | Description |
|---|---|---|---|
providesDescription | Boolean | No | If true, the value of this schema can be used as a summary description. |
providesIcon | Boolean | No | If true, the icon of this schema can be used as a summary icon. |
providesImage | Boolean | No | If true, the image of this schema can be used as a summary image. |
providesMedia | Boolean | No | If true, the media of this schema can be used as a summary media. |
providesTitle | Boolean | No | If true, the value of this schema can be used as a summary title. |
A schema which summarises its child schemas.
Default values can be specified for the summary if values are not provided by its child schemas.
| Property | Type | Required | Description |
|---|---|---|---|
defaultDescription | String | No | A description to be used for the summary if a description is not provided by a child schema. |
defaultIcon | Icon | No | An icon to be used for the summary if an icon is not provided by a child schema. |
defaultImage | Image | No | An image to be used for the summary if an image is not provided by a child schema. |
defaultMedia | Media | No | A Media to be used for the summary if a media is not provided by a child schema. |
defaultTitle | String | No | A title to be used for the summary if a title is not provided by a child schema. |
providesDescription | Boolean | No | If true, the value of this schema can be used as a summary description. |
providesIcon | Boolean | No | If true, the icon of this schema can be used as a summary icon. |
providesImage | Boolean | No | If true, the image of this schema can be used as a summary image. |
providesMedia | Boolean | No | If true, the media of this schema can be used as a summary media. |
providesTitle | Boolean | No | If true, the value of this schema can be used as a summary title. |