mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-11-29 18:50:00 +08:00
docs(list): add semantic dom (#50413)
This commit is contained in:
thinkasany
GitHub
parent
3b9a1b1123
commit
7005212e15
91
components/list/demo/_semantic.tsx
Normal file
91
components/list/demo/_semantic.tsx
Normal file
@ -0,0 +1,91 @@
|
||||
import React from 'react';
|
||||
|
||||
import SemanticPreview from '../../../.dumi/components/SemanticPreview';
|
||||
import useLocale from '../../../.dumi/hooks/useLocale';
|
||||
|
||||
import { Avatar, List, Space } from 'antd';
|
||||
import { LikeOutlined, MessageOutlined, StarOutlined } from '@ant-design/icons';
|
||||
|
||||
const locales = {
|
||||
cn: {
|
||||
extra: '设置额外内容',
|
||||
actions: '设置列表操作组',
|
||||
},
|
||||
en: {
|
||||
extra: 'set `extra` of List.Item',
|
||||
actions: 'set `actions` of List.Item',
|
||||
},
|
||||
};
|
||||
|
||||
const IconText = ({ icon, text }: { icon: React.FC; text: string }) => (
|
||||
<Space>
|
||||
{React.createElement(icon)}
|
||||
{text}
|
||||
</Space>
|
||||
);
|
||||
|
||||
const data = Array.from({ length: 1 }).map((_, i) => ({
|
||||
href: 'https://ant.design',
|
||||
title: `ant design part ${i}`,
|
||||
avatar: `https://api.dicebear.com/7.x/miniavs/svg?seed=${i}`,
|
||||
description:
|
||||
'Ant Design, a design language for background applications, is refined by Ant UED Team.',
|
||||
content:
|
||||
'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.',
|
||||
}));
|
||||
|
||||
const BlockList: React.FC<React.PropsWithChildren> = (props) => {
|
||||
const divRef = React.useRef<HTMLDivElement>(null);
|
||||
|
||||
return (
|
||||
<div ref={divRef} style={{ position: 'absolute', inset: 0, height: 300 }}>
|
||||
<List
|
||||
itemLayout="vertical"
|
||||
size="large"
|
||||
dataSource={data}
|
||||
renderItem={(item) => (
|
||||
<List.Item
|
||||
{...props}
|
||||
key={item.title}
|
||||
actions={[
|
||||
<IconText icon={StarOutlined} text="156" key="list-vertical-star-o" />,
|
||||
<IconText icon={LikeOutlined} text="156" key="list-vertical-like-o" />,
|
||||
<IconText icon={MessageOutlined} text="2" key="list-vertical-message" />,
|
||||
]}
|
||||
extra={
|
||||
<img
|
||||
width={272}
|
||||
alt="logo"
|
||||
src="https://gw.alipayobjects.com/zos/rmsportal/mqaQswcyDLcXyDKnZfES.png"
|
||||
/>
|
||||
}
|
||||
>
|
||||
<List.Item.Meta
|
||||
avatar={<Avatar src={item.avatar} />}
|
||||
title={<a href={item.href}>{item.title}</a>}
|
||||
description={item.description}
|
||||
/>
|
||||
{item.content}
|
||||
</List.Item>
|
||||
)}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
const App: React.FC = () => {
|
||||
const [locale] = useLocale(locales);
|
||||
return (
|
||||
<SemanticPreview
|
||||
height={300}
|
||||
semantics={[
|
||||
{ name: 'extra', desc: locale.extra, version: '5.18.0' },
|
||||
{ name: 'actions', desc: locale.actions, version: '5.18.0' },
|
||||
]}
|
||||
>
|
||||
<BlockList />
|
||||
</SemanticPreview>
|
||||
);
|
||||
};
|
||||
|
||||
export default App;
|
||||
@ -78,9 +78,9 @@ More about pagination, please check [`Pagination`](/components/pagination/).
|
||||
| Property | Description | Type | Default | Version |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| actions | The actions content of list item. If `itemLayout` is `vertical`, shows the content on bottom, otherwise shows content on the far right | Array<ReactNode> | - | |
|
||||
| classNames | Semantic structure className | `Record<actions \| extra , string>` | - | 5.18.0 |
|
||||
| classNames | Semantic structure className | [`Record<actions \| extra, string>`](#semantic-dom) | - | 5.18.0 |
|
||||
| extra | The extra content of list item. If `itemLayout` is `vertical`, shows the content on right, otherwise shows content on the far right | ReactNode | - | |
|
||||
| styles | Semantic DOM style | `Record<actions \| extra , CSSProperties>` | - | 5.18.0 |
|
||||
| styles | Semantic DOM style | [`Record<actions \| extra, CSSProperties>`](#semantic-dom) | - | 5.18.0 |
|
||||
|
||||
### List.Item.Meta
|
||||
|
||||
@ -90,6 +90,10 @@ More about pagination, please check [`Pagination`](/components/pagination/).
|
||||
| description | The description of list item | ReactNode | - | |
|
||||
| title | The title of list item | ReactNode | - | |
|
||||
|
||||
## Semantic DOM
|
||||
|
||||
<code src="./demo/_semantic.tsx" simplify="true"></code>
|
||||
|
||||
## Design Token
|
||||
|
||||
<ComponentTokenTable component="List"></ComponentTokenTable>
|
||||
|
||||
@ -81,9 +81,9 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*tBzwQ7raKX8AAA
|
||||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| actions | 列表操作组，根据 `itemLayout` 的不同，位置在卡片底部或者最右侧 | Array<ReactNode> | - | |
|
||||
| classNames | 语义化结构 className | `Record<actions \| extra , string>` | - | 5.18.0 |
|
||||
| classNames | 语义化结构 className | [`Record<actions \| extra, string>`](#semantic-dom) | - | 5.18.0 |
|
||||
| extra | 额外内容，通常用在 `itemLayout` 为 `vertical` 的情况下，展示右侧内容; `horizontal` 展示在列表元素最右侧 | ReactNode | - | |
|
||||
| styles | 语义化结构 style | `Record<actions \| extra , CSSProperties>` | - | 5.18.0 |
|
||||
| styles | 语义化结构 style | [`Record<actions \| extra, CSSProperties>`](#semantic-dom) | - | 5.18.0 |
|
||||
|
||||
### List.Item.Meta
|
||||
|
||||
@ -93,6 +93,10 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*tBzwQ7raKX8AAA
|
||||
| description | 列表元素的描述内容 | ReactNode | - | |
|
||||
| title | 列表元素的标题 | ReactNode | - | |
|
||||
|
||||
## Semantic DOM
|
||||
|
||||
<code src="./demo/_semantic.tsx" simplify="true"></code>
|
||||
|
||||
## 主题变量（Design Token）
|
||||
|
||||
<ComponentTokenTable component="List"></ComponentTokenTable>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user