Comment
A comment displays user feedback and discussion to website content.
When To Use#
Comments can be used to enable discussions on an entity such as a page, blog post, issue or other.
Examples
We supply a series of design principles, practical patterns and high quality design resources (Sketch and Axure), to help people create their product prototypes beautifully and efficiently.
- 0
- 0
- Reply to
import { DislikeFilled, DislikeOutlined, LikeFilled, LikeOutlined } from '@ant-design/icons';
import { Avatar, Comment, Tooltip } from 'antd';
import React, { createElement, useState } from 'react';
const App: React.FC = () => {
const [likes, setLikes] = useState(0);
const [dislikes, setDislikes] = useState(0);
const [action, setAction] = useState<string | null>(null);
const like = () => {
setLikes(1);
setDislikes(0);
setAction('liked');
};
const dislike = () => {
setLikes(0);
setDislikes(1);
setAction('disliked');
};
const actions = [
<Tooltip key="comment-basic-like" title="Like">
<span onClick={like}>
{createElement(action === 'liked' ? LikeFilled : LikeOutlined)}
<span className="comment-action">{likes}</span>
</span>
</Tooltip>,
<Tooltip key="comment-basic-dislike" title="Dislike">
<span onClick={dislike}>
{React.createElement(action === 'disliked' ? DislikeFilled : DislikeOutlined)}
<span className="comment-action">{dislikes}</span>
</span>
</Tooltip>,
<span key="comment-basic-reply-to">Reply to</span>,
];
return (
<Comment
actions={actions}
author={<a>Han Solo</a>}
avatar={<Avatar src="https://joeschmoe.io/api/v1/random" alt="Han Solo" />}
content={
<p>
We supply a series of design principles, practical patterns and high quality design
resources (Sketch and Axure), to help people create their product prototypes beautifully
and efficiently.
</p>
}
datetime={
<Tooltip title="2016-11-22 11:22:33">
<span>8 hours ago</span>
</Tooltip>
}
/>
);
};
export default App;
/* tile uploaded pictures */
.comment-action {
padding-left: 8px;
cursor: 'auto';
}
[class*='-col-rtl'] .comment-action {
padding-right: 8px;
padding-left: 0;
}
import { Comment, List, Tooltip } from 'antd';
import React from 'react';
const data = [
{
actions: [<span key="comment-list-reply-to-0">Reply to</span>],
author: 'Han Solo',
avatar: 'https://joeschmoe.io/api/v1/random',
content: (
<p>
We supply a series of design principles, practical patterns and high quality design
resources (Sketch and Axure), to help people create their product prototypes beautifully and
efficiently.
</p>
),
datetime: (
<Tooltip title="2016-11-22 11:22:33">
<span>8 hours ago</span>
</Tooltip>
),
},
{
actions: [<span key="comment-list-reply-to-0">Reply to</span>],
author: 'Han Solo',
avatar: 'https://joeschmoe.io/api/v1/random',
content: (
<p>
We supply a series of design principles, practical patterns and high quality design
resources (Sketch and Axure), to help people create their product prototypes beautifully and
efficiently.
</p>
),
datetime: (
<Tooltip title="2016-11-22 10:22:33">
<span>9 hours ago</span>
</Tooltip>
),
},
];
const App: React.FC = () => (
<List
className="comment-list"
header={`${data.length} replies`}
itemLayout="horizontal"
dataSource={data}
renderItem={item => (
<li>
<Comment
actions={item.actions}
author={item.author}
avatar={item.avatar}
content={item.content}
datetime={item.datetime}
/>
</li>
)}
/>
);
export default App;
We supply a series of design principles, practical patterns and high quality design resources (Sketch and Axure).
- Reply to
We supply a series of design principles, practical patterns and high quality design resources (Sketch and Axure).
- Reply to
We supply a series of design principles, practical patterns and high quality design resources (Sketch and Axure).
- Reply to
We supply a series of design principles, practical patterns and high quality design resources (Sketch and Axure).
- Reply to
import { Avatar, Comment } from 'antd';
import React from 'react';
const ExampleComment: React.FC<{ children?: React.ReactNode }> = ({ children }) => (
<Comment
actions={[<span key="comment-nested-reply-to">Reply to</span>]}
author={<a>Han Solo</a>}
avatar={<Avatar src="https://joeschmoe.io/api/v1/random" alt="Han Solo" />}
content={
<p>
We supply a series of design principles, practical patterns and high quality design
resources (Sketch and Axure).
</p>
}
>
{children}
</Comment>
);
const App: React.FC = () => (
<ExampleComment>
<ExampleComment>
<ExampleComment />
<ExampleComment />
</ExampleComment>
</ExampleComment>
);
export default App;
import { Avatar, Button, Comment, Form, Input, List } from 'antd';
import moment from 'moment';
import React, { useState } from 'react';
const { TextArea } = Input;
interface CommentItem {
author: string;
avatar: string;
content: React.ReactNode;
datetime: string;
}
interface EditorProps {
onChange: (e: React.ChangeEvent<HTMLTextAreaElement>) => void;
onSubmit: () => void;
submitting: boolean;
value: string;
}
const CommentList = ({ comments }: { comments: CommentItem[] }) => (
<List
dataSource={comments}
header={`${comments.length} ${comments.length > 1 ? 'replies' : 'reply'}`}
itemLayout="horizontal"
renderItem={props => <Comment {...props} />}
/>
);
const Editor = ({ onChange, onSubmit, submitting, value }: EditorProps) => (
<>
<Form.Item>
<TextArea rows={4} onChange={onChange} value={value} />
</Form.Item>
<Form.Item>
<Button htmlType="submit" loading={submitting} onClick={onSubmit} type="primary">
Add Comment
</Button>
</Form.Item>
</>
);
const App: React.FC = () => {
const [comments, setComments] = useState<CommentItem[]>([]);
const [submitting, setSubmitting] = useState(false);
const [value, setValue] = useState('');
const handleSubmit = () => {
if (!value) return;
setSubmitting(true);
setTimeout(() => {
setSubmitting(false);
setValue('');
setComments([
...comments,
{
author: 'Han Solo',
avatar: 'https://joeschmoe.io/api/v1/random',
content: <p>{value}</p>,
datetime: moment('2016-11-22').fromNow(),
},
]);
}, 1000);
};
const handleChange = (e: React.ChangeEvent<HTMLTextAreaElement>) => {
setValue(e.target.value);
};
return (
<>
{comments.length > 0 && <CommentList comments={comments} />}
<Comment
avatar={<Avatar src="https://joeschmoe.io/api/v1/random" alt="Han Solo" />}
content={
<Editor
onChange={handleChange}
onSubmit={handleSubmit}
submitting={submitting}
value={value}
/>
}
/>
</>
);
};
export default App;
API#
Property | Description | Type | Default | Version |
---|---|---|---|---|
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 or src | ReactNode | - | |
children | Nested comments should be provided as children of the Comment | ReactNode | - | |
content | The main content of the comment | ReactNode | - | |
datetime | A datetime element containing the time to be displayed | ReactNode | - |
We supply a series of design principles, practical patterns and high quality design resources (Sketch and Axure), to help people create their product prototypes beautifully and efficiently.
We supply a series of design principles, practical patterns and high quality design resources (Sketch and Axure), to help people create their product prototypes beautifully and efficiently.