Ant Design Blazor
Descriptions
Display multiple read-only fields in groups.
When To Use
Commonly displayed on the details page.
Examples
Basic usage.
Descriptions with border and background color.
Custom sizes to fit in a variety of containers.
Responsive configuration enables perfect presentation on small screen devices.
Responsive configuration enables perfect presentation on small screen devices.
Vertical descriptions with border.
The LabelStyle and ContentStyle can be used to customize the style of the Item.
Descriptions API#
| Property | Description | Type | Default Value |
|---|---|---|---|
| Bordered | ParameterWhether to display the border | Boolean | false |
| Layout | ParameterLayout - Horizontal or Vertical | String | DescriptionsLayout.Horizontal |
| Column | ParameterThe number of DescriptionsItem elements in a row. Could be a number or a object like { xs: 8, sm: 16, md: 24} |
OneOf<Int32, Dictionary<String, Int32>> | -- |
| Size | ParameterSize of the list | String | -- |
| Title | ParameterTitle shown at the top of the element | String | -- |
| TitleTemplate | ParameterTitle content shown at the top of the element. Takes priority over AntDesign.Descriptions.Title |
RenderFragment | -- |
| Colon | ParameterChange default props Colon value of DescriptionsItem. |
Boolean | -- |
| ChildContent | ParameterContent for the element. Typically contains DescriptionsItem elements |
RenderFragment | -- |
| Id | ParameterID for the component's HTML | String | Uniquely Generated ID |
| Class | ParameterSpecifies one or more class names for an DOM element. | String | -- |
| Style | ParameterSpecifies an inline style for a DOM element. | String | -- |
| RefBack | ParameterA ForwardRef instance. You can get a reference to the internal DOM by using AntDesign.ForwardRef.Current. |
ForwardRef | -- |
DescriptionsItem API#
| Property | Description | Type | Default Value |
|---|---|---|---|
| Title | ParameterTitle for the item | String | -- |
| TitleTemplate | ParameterTitle content for the item. Takes priority over AntDesign.DescriptionsItem.Title |
RenderFragment | -- |
| Span | ParameterSpan of the item | Int32 | 1 |
| ChildContent | ParameterContent for the item | RenderFragment | -- |
| LabelStyle | ParameterCustomize the style of the label | String | -- |
| ContentStyle | ParameterCustomize the style of the content | String | -- |
| Id | ParameterID for the component's HTML | String | Uniquely Generated ID |
| Class | ParameterSpecifies one or more class names for an DOM element. | String | -- |
| Style | ParameterSpecifies an inline style for a DOM element. | String | -- |
| RefBack | ParameterA ForwardRef instance. You can get a reference to the internal DOM by using AntDesign.ForwardRef.Current. |
ForwardRef | -- |