|
|
|
|
---
|
|
|
|
|
category: Components
|
|
|
|
|
type: Data Display
|
|
|
|
|
title: Comment
|
|
|
|
|
cols: 1
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
Single comment component.
|
|
|
|
|
|
|
|
|
|
## When To Use
|
|
|
|
|
|
|
|
|
|
Comments can be used to enable discussions on an entity for example page, blog post, issue or other.
|
|
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
|
|
|
|
| Property | Description | Type | Default |
|
|
|
|
|
| -------- | ----------- | ---- | ------- |
|
|
|
|
|
| actions | List of action items rendered below the comment content | Array<ReactNode> | - |
|
|
|
|
|
| author | The element to display as the comment author | ReactNode | - |
|
|
|
|
|
| avatar | The element to display as the comment avatar - generally an antd `Avatar` | ReactNode | - |
|
|
|
|
|
| className | className of comment | string | - |
|
|
|
|
|
| children | The main content of the comment | ReactNode | - |
|
|
|
|
|
| contentStyle | Inline style to apply to the comment content | object | - |
|
|
|
|
|
| headStyle | Inline style to apply to the comment head | object | - |
|
|
|
|
|
| id | Optional ID for the comment | string | - |
|
|
|
|
|
| innerStyle | Additional style for the inner content | object | - |
|
|
|
|
|
| prefixCls | Comment prefix className defaults to `.ant-comment` | string | .ant-comment |
|
|
|
|
|
| style | Additional style for the comment | object | - |
|
|
|
|
|
| time | A time element containing the time to be displayed | ReactNode | - |
|
|
|
|
|
| tooltipTime | A time element to be displayed as the time tooltip | ReactNode | - |
|
|
|
|
|
|
|
|
|
|
# Comment.Nested
|
|
|
|
|
|
|
|
|
|
| Property | Description | Type | Default |
|
|
|
|
|
| -------- | ----------- | ---- | ------- |
|
|
|
|
|
| className | className of nested comment | string | - |
|
|
|
|
|
| prefixCls | prefix className defaults to `.ant-comment` | string | .ant-comment |
|
|
|
|
|
| style | Additional style for the comment | object | - |
|
|
|
|
|
|
|
|
|
|
# Comment.Editor
|
|
|
|
|
|
|
|
|
|
| Property | Description | Type | Default |
|
|
|
|
|
| -------- | ----------- | ---- | ------- |
|
|
|
|
|
| prefixCls | prefix className defaults to `.ant-comment` | string | .ant-comment |
|
|
|
|
|
| style | Additional style for the editor | object | - |
|
|
|
|
|
| className | className of editor | string | - |
|
|
|
|
|
| headStyle | Inline style to apply to the comment head | object | - |
|
|
|
|
|
| editorStyle | Inline style to apply to the comment editor | object | - |
|
|
|
|
|
| innerStyle | Inline style to apply to the comment inner comment editor | object | - |
|
|
|
|
|
| avatar | The element to display as the comment avatar - generally an antd `Avatar` | ReactNode | - |
|
|
|
|
|
| children | The element to display as the editor | ReactNode | - |
|
