Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(Typography): add Typography components #2821

Merged
merged 23 commits into from
Apr 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions site/site.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,14 @@ export const docs = [
component: () => import('tdesign-react/link/link.md'),
componentEn: () => import('tdesign-react/link/link.en-US.md'),
},
{
title: 'Typography 排版',
titleEn: 'Typography',
name: 'typography',
path: '/react/components/typography',
component: () => import('tdesign-react/typography/typography.md'),
componentEn: () => import('tdesign-react/typography/typography.en-US.md'),
},
],
},
{
Expand Down
56 changes: 31 additions & 25 deletions site/test-coverage.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
module.exports = {
"Util": {
"statements": "61.53%",
"branches": "48.77%",
"statements": "61.88%",
"branches": "48.57%",
"functions": "69.29%",
"lines": "63.26%"
"lines": "63.77%"
},
"affix": {
"statements": "84.84%",
Expand All @@ -18,10 +18,10 @@ module.exports = {
"lines": "100%"
},
"anchor": {
"statements": "92.98%",
"statements": "93.85%",
"branches": "69.56%",
"functions": "88%",
"lines": "97.08%"
"lines": "98.05%"
},
"autoComplete": {
"statements": "96.17%",
Expand Down Expand Up @@ -114,10 +114,10 @@ module.exports = {
"lines": "68.75%"
},
"datePicker": {
"statements": "62.47%",
"branches": "43.3%",
"functions": "60%",
"lines": "66.16%"
"statements": "62.55%",
"branches": "44.05%",
"functions": "60.6%",
"lines": "66.24%"
},
"descriptions": {
"statements": "98.82%",
Expand All @@ -127,7 +127,7 @@ module.exports = {
},
"dialog": {
"statements": "85%",
"branches": "71.42%",
"branches": "71.92%",
"functions": "85%",
"lines": "87.24%"
},
Expand Down Expand Up @@ -162,10 +162,10 @@ module.exports = {
"lines": "84.21%"
},
"guide": {
"statements": "100%",
"branches": "94.2%",
"statements": "99.32%",
"branches": "92.85%",
"functions": "100%",
"lines": "100%"
"lines": "99.31%"
},
"hooks": {
"statements": "55.22%",
Expand All @@ -174,10 +174,10 @@ module.exports = {
"lines": "55.19%"
},
"image": {
"statements": "88.76%",
"statements": "88.88%",
"branches": "82.53%",
"functions": "80%",
"lines": "91.76%"
"lines": "91.86%"
},
"imageViewer": {
"statements": "77.85%",
Expand All @@ -186,10 +186,10 @@ module.exports = {
"lines": "77.62%"
},
"input": {
"statements": "93.78%",
"statements": "93.82%",
"branches": "92.24%",
"functions": "89.47%",
"lines": "94.11%"
"lines": "94.15%"
},
"inputAdornment": {
"statements": "86.95%",
Expand All @@ -204,10 +204,10 @@ module.exports = {
"lines": "80.16%"
},
"layout": {
"statements": "91.3%",
"statements": "91.48%",
"branches": "41.66%",
"functions": "85.71%",
"lines": "91.3%"
"lines": "91.48%"
},
"link": {
"statements": "100%",
Expand Down Expand Up @@ -240,9 +240,9 @@ module.exports = {
"lines": "90.51%"
},
"message": {
"statements": "88.31%",
"statements": "88.96%",
"branches": "86.66%",
"functions": "68.18%",
"functions": "70.45%",
"lines": "94.28%"
},
"notification": {
Expand Down Expand Up @@ -282,10 +282,10 @@ module.exports = {
"lines": "83.58%"
},
"rangeInput": {
"statements": "75%",
"branches": "67.44%",
"statements": "74.02%",
"branches": "62.79%",
"functions": "48.14%",
"lines": "74.66%"
"lines": "73.68%"
},
"rate": {
"statements": "96.22%",
Expand Down Expand Up @@ -355,7 +355,7 @@ module.exports = {
},
"tabs": {
"statements": "90.96%",
"branches": "78.64%",
"branches": "79.04%",
"functions": "86.36%",
"lines": "91.17%"
},
Expand Down Expand Up @@ -413,6 +413,12 @@ module.exports = {
"functions": "97.61%",
"lines": "97.22%"
},
"typography": {
"statements": "95.58%",
"branches": "76.31%",
"functions": "81.81%",
"lines": "98.46%"
},
"upload": {
"statements": "96.66%",
"branches": "95.65%",
Expand Down
2 changes: 1 addition & 1 deletion src/_common
Submodule _common updated 45 files
+13 −0 .github/workflows/pr-spelling.template.yml
+10 −0 .github/workflows/typos-config.toml
+2 −0 docs/web/api/config-provider.en-US.md
+2 −0 docs/web/api/config-provider.md
+7 −3 docs/web/api/input.en-US.md
+8 −2 docs/web/api/input.md
+1 −1 docs/web/api/tag-input.en-US.md
+1 −1 docs/web/api/tag-input.md
+1 −1 docs/web/api/typography.md
+3 −3 js/global-config/locale/ar_KW.ts
+5 −5 js/global-config/locale/en_US.ts
+3 −3 js/global-config/locale/it_IT.ts
+3 −3 js/global-config/locale/ja_JP.ts
+3 −3 js/global-config/locale/ko_KR.ts
+3 −3 js/global-config/locale/ru_RU.ts
+3 −3 js/global-config/locale/zh_CN.ts
+4 −4 js/global-config/locale/zh_TW.ts
+4 −4 style/mobile/components/back-top/_index.less
+2 −2 style/mobile/components/back-top/_var.less
+1 −1 style/mobile/components/message/v2/_index.less
+1 −1 style/mobile/components/message/v2/_var.less
+8 −8 style/mobile/components/slider/_index.less
+2 −2 style/mobile/components/slider/_var.less
+1 −1 style/mobile/components/step-item/v2/_index.less
+1 −1 style/mobile/components/switch/_index.less
+1 −1 style/mobile/components/switch/_var.less
+46 −7 style/mobile/components/tag/v2/_index.less
+6 −0 style/mobile/components/tag/v2/_var.less
+1 −1 style/web/components/back-top/_index.less
+1 −1 style/web/components/badge/_index.less
+2 −2 style/web/components/breadcrumb/_index.less
+3 −3 style/web/components/calendar/_index.less
+3 −3 style/web/components/calendar/_var.less
+2 −2 style/web/components/collapse/_index.less
+1 −1 style/web/components/dialog/_index.less
+17 −0 style/web/components/input/_index.less
+1 −1 style/web/components/input/_var.less
+2 −2 style/web/components/link/_index.less
+1 −1 style/web/components/notification/_index.less
+3 −3 style/web/components/table/_index.less
+2 −2 style/web/components/transfer/_index.less
+14 −2 style/web/components/typography/_docs.less
+7 −0 style/web/components/typography/_index.less
+4 −0 style/web/components/typography/_var.less
+1 −1 style/web/components/upload/_docs.less
6 changes: 5 additions & 1 deletion src/_util/copyText.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import { canUseDocument } from './dom';

export default function copyText(text: string) {
if (!canUseDocument) return;

if ('clipboard' in navigator) {
navigator.clipboard.writeText(text);
return;
Expand All @@ -16,7 +20,7 @@ export default function copyText(text: string) {
selection.removeAllRanges();
selection.addRange(range);

document.execCommand('copy');
document.execCommand?.('copy');
selection.removeAllRanges();
document.body.removeChild(textarea);
}
8 changes: 8 additions & 0 deletions src/config-provider/config-provider.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,3 +320,11 @@ finishButtonProps | Object | - | finish button in last step. `{ content: 'Finish
nextButtonProps | Object | - | next step button. `{ content: 'Next Button', theme: 'primary' }`。Typescript:`ButtonProps` | N
prevButtonProps | Object | - | previous step button. `{ content: 'Previous Step', theme: 'default' }`。Typescript:`ButtonProps` | N
skipButtonProps | Object | - | skip button. `{ content: 'Skip', theme: 'default' }`。Typescript:`ButtonProps` | N

### TypographyConfig

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
collapseText | String | - | collapse text | N
expandText | String | - | expand text | N
copiedText | String | - | copied text | N
9 changes: 9 additions & 0 deletions src/config-provider/config-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ timePicker | Object | - | 时间选择器全局配置。TS 类型:`TimePickerC
transfer | Object | - | 穿梭框全局配置。TS 类型:`TransferConfig` | N
tree | Object | - | 树组件全局配置。TS 类型:`TreeConfig` | N
treeSelect | Object | - | 树选择器组件全局配置。TS 类型:`TreeSelectConfig` | N
typography | Object | - | 排版组件全局配置。TS 类型:`TypographyConfig` | N
upload | Object | - | 上传组件全局配置。TS 类型:`UploadConfig` | N

### InputConfig
Expand Down Expand Up @@ -350,3 +351,11 @@ finishButtonProps | Object | - | 最后一步中的完成按钮,示例:`{ co
nextButtonProps | Object | - | 下一步按钮,示例:`{ content: '下一步', theme: 'primary' }`。TS 类型:`ButtonProps` | N
prevButtonProps | Object | - | 上一步按钮,示例:`{ content: '上一步', theme: 'default' }`。TS 类型:`ButtonProps` | N
skipButtonProps | Object | - | 跳过按钮,示例:`{ content: '跳过', theme: 'default' }`。TS 类型:`ButtonProps` | N

### TypographyConfig

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
collapseText | String | - | 语言配置,“收起”描述文本 | N
expandText | String | - | 语言配置,“展开”描述文本 | N
copiedText | String | - | 语言配置,“复制成功”描述文本 | N
22 changes: 22 additions & 0 deletions src/config-provider/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,10 @@ export interface GlobalConfigProvider {
* 树选择器组件全局配置
*/
treeSelect?: TreeSelectConfig;
/**
* 排版全局配置
*/
typography?: TypographyConfig;
/**
* 上传组件全局配置
*/
Expand Down Expand Up @@ -886,6 +890,24 @@ export interface GuideConfig {
skipButtonProps?: ButtonProps;
}

export interface TypographyConfig {
/**
* 语言配置,“收起”描述文本
* @default ''
*/
collapseText?: string;
/**
* 语言配置,“展开”描述文本
* @default ''
*/
expandText?: string;
/**
* 语言配置,“复制成功”描述文本
* @default ''
*/
copiedText?: string;
}

export type AnimationType = 'ripple' | 'expand' | 'fade';

export type IconConfig = GlobalIconConfig;
Expand Down
1 change: 1 addition & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,4 @@ export * from './guide';
export * from './back-top';
export * from './statistic';
export * from './descriptions';
export * from './typography';
1 change: 0 additions & 1 deletion src/table/_example/base.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ export default function TableBasic() {
rowClassName={({ rowIndex }) => `${rowIndex}-class`}
cellEmptyContent={'-'}
resizable
bordered
// 与pagination对齐
pagination={{
defaultCurrent: 2,
Expand Down
45 changes: 45 additions & 0 deletions src/typography/Paragraph.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import React, { forwardRef } from 'react';
import classNames from 'classnames';
import Ellipsis from './ellipsis/Ellipsis';
import { paragraphDefaultProps } from './defaultProps';

import useConfig from '../hooks/useConfig';
import useEllipsis from './ellipsis/useEllipsis';
import useDefaultProps from '../hooks/useDefaultProps';

import type { StyledProps } from '../common';
import type { TdParagraphProps } from './type';

export type TypographyParagraphProps = TdParagraphProps &
StyledProps & {
children: React.ReactNode;
};

const Paragraph = forwardRef<HTMLDivElement, TypographyParagraphProps>((originalProps, ref) => {
const { classPrefix } = useConfig();
const props = useDefaultProps<TypographyParagraphProps>(originalProps, paragraphDefaultProps);

const { ellipsis, children, className, content, ...rest } = props;
const prefixCls = `${classPrefix}-typography`;

const { ellipsisProps } = useEllipsis(ellipsis);

if (!ellipsis) {
return (
<div className={classNames(className, prefixCls)} ref={ref} {...rest}>
{children || content}
</div>
);
}

return (
<Ellipsis {...ellipsisProps} className={classNames(className, prefixCls)} {...rest}>
{children || content}
</Ellipsis>
);
});

Paragraph.displayName = 'Paragraph';
Paragraph.defaultProps = paragraphDefaultProps;

export default Paragraph;
Loading
Loading