Skip to content

Commit

Permalink
docs: collect token API from tsdoc (#38964)
Browse files Browse the repository at this point in the history
* chore: token doc

* docs: token meta

* chore: code clean

* chore: code clean

* chore: json

* chore: rename

* chore: style
  • Loading branch information
MadCcc authored and li-jia-nan committed Nov 25, 2022
1 parent 10185a3 commit 7445a0f
Show file tree
Hide file tree
Showing 9 changed files with 594 additions and 454 deletions.
114 changes: 114 additions & 0 deletions .dumi/theme/builtins/TokenTable/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
import React, { FC, useMemo } from 'react';
import tokenMeta from 'antd/es/version/token-meta.json';
import { getDesignToken } from 'antd-token-previewer';
import { Table, TableProps, Tag } from 'antd';
import useLocale from '../../../hooks/useLocale';
import useSiteToken from '../../../hooks/useSiteToken';
import { css } from '@emotion/react';

type TokenTableProps = {
type: 'seed' | 'map' | 'alias';
lang: 'zh' | 'en';
};

type TokenData = {
name: string;
desc: string;
type: string;
value: any;
};

const defaultToken = getDesignToken();

const locales = {
cn: {
token: 'Token 名称',
description: '描述',
type: '类型',
value: '默认值',
},
en: {
token: 'Token Name',
description: 'Description',
type: 'Type',
value: 'Default Value',
},
};

const useStyle = () => {
const { token } = useSiteToken();

return {
codeSpan: css`
margin: 0 1px;
padding: 0.2em 0.4em;
font-size: 0.9em;
background: ${token.siteMarkdownCodeBg};
border: 1px solid ${token.colorSplit};
border-radius: 3px;
font-family: monospace;
`,
};
};

const TokenTable: FC<TokenTableProps> = ({ type }) => {
const styles = useStyle();
const [locale, lang] = useLocale(locales);
const columns: Exclude<TableProps<TokenData>['columns'], undefined> = [
{
title: locale.token,
key: 'name',
dataIndex: 'name',
},
{
title: locale.description,
key: 'desc',
dataIndex: 'desc',
width: 300,
},
{
title: locale.type,
key: 'type',
dataIndex: 'type',
render: (_, record) => <span css={styles.codeSpan}>{record.type}</span>,
},
{
title: locale.value,
key: 'value',
render: (_, record) => (
<span style={{ display: 'inline-flex', alignItems: 'center' }}>
{typeof record.value === 'string' &&
(record.value.startsWith('#') || record.value.startsWith('rgb')) && (
<span
style={{
background: record.value,
display: 'inline-block',
width: 6,
height: 6,
borderRadius: '50%',
boxShadow: 'inset 0 0 0 1px rgba(0, 0, 0, 0.06)',
marginRight: 4,
}}
></span>
)}
{typeof record.value !== 'string' ? JSON.stringify(record.value) : record.value}
</span>
),
},
];

const data = useMemo<TokenData[]>(() => {
return tokenMeta[type].map((token) => {
return {
name: token.name,
desc: lang === 'cn' ? token.desc : token.descEn,
type: token.type,
value: (defaultToken as any)[token.name],
};
});
}, [type, lang]);

return <Table dataSource={data} columns={columns} pagination={false} bordered />;
};

export default TokenTable;
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ server/
# Docs templates
scripts/previewEditor/index.html
components/version/version.tsx
components/version/token.tsx
components/version/token.json
components/version/token-meta.json
.dumi/tmp
.dumi/tmp-test
.dumi/tmp-production
Expand Down
1 change: 1 addition & 0 deletions components/menu/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ The legacy demo code for version `<4.20.0` could be found at [https://github.com
#### SubMenuType

<!-- prettier-ignore -->
| Property | Description | Type | Default value | Version |
| --- | --- | --- | --- | --- |
| children | Sub-menus or sub-menu items | [ItemType\[\]](#ItemType) | - | |
Expand Down

0 comments on commit 7445a0f

Please sign in to comment.