index int64 0 0 | repo_id stringlengths 16 181 | file_path stringlengths 28 270 | content stringlengths 1 11.6M | __index_level_0__ int64 0 10k |
|---|---|---|---|---|
0 | petrpan-code/arco-design/arco-design/components/Trigger | petrpan-code/arco-design/arco-design/components/Trigger/__demo__/updateAtScroll.md | ---
order: 8
title:
zh-CN: 滚动容器
en-US: updateOnScroll
---
## zh-CN
通过设置 `updateOnScroll` 监听容器的滚动。
## en-US
Listen for container scrolling by setting `updateOnScroll`.
```js
import { Trigger, Button, Input, Skeleton } from '@arco-design/web-react';
function Popup() {
return <Skeleton className="demo-trigger-... | 5,500 |
0 | petrpan-code/arco-design/arco-design/components/Trigger | petrpan-code/arco-design/arco-design/components/Trigger/__template__/index.en-US.md | ---
file: interface
---
`````
Component / Other
# Trigger
Used to pop up a drop-down box by hovering, focusing, or clicking on a element.
`````
%%Content%%
## API
%%Props%%
### When to fired `onVisibleChange`
- When `trigger` contains `click`
1. Click on the area outside the child node and the popup will hide... | 5,501 |
0 | petrpan-code/arco-design/arco-design/components/Trigger | petrpan-code/arco-design/arco-design/components/Trigger/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 其他
# 触发器 Trigger
用于对元素添加 hover, click, focus 等事件，并且弹出下拉框。
`````
%%Content%%
## API
%%Props%%
### `onVisibleChange`的触发时机说明
- `trigger`包含`click`时
1. 鼠标点击空白处，会触发`onVisibleChange`，隐藏弹出层。设置 `clickOutsideToClose=false` 可以阻止触发。
2. 鼠标点击触发节点，例如示例中的 `Button`，会触发`onVisibleChange`，隐藏/... | 5,502 |
0 | petrpan-code/arco-design/arco-design/components/Trigger | petrpan-code/arco-design/arco-design/components/Trigger/__test__/case.test.tsx | import React from 'react';
import { act } from 'react-test-renderer';
import Trigger from '..';
import mountTest from '../../../tests/mountTest';
import { fireEvent, render } from '../../../tests/util';
mountTest(Trigger);
describe('Trigger case', () => {
beforeEach(() => {
jest.useFakeTimers();
});
it('unm... | 5,503 |
0 | petrpan-code/arco-design/arco-design/components/Trigger | petrpan-code/arco-design/arco-design/components/Trigger/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('Trigger');
| 5,504 |
0 | petrpan-code/arco-design/arco-design/components/Trigger | petrpan-code/arco-design/arco-design/components/Trigger/__test__/index.test.tsx | import React from 'react';
import { act } from 'react-test-renderer';
import Trigger from '..';
import mountTest from '../../../tests/mountTest';
import { render, cleanup, fireEvent, sleep } from '../../../tests/util';
mountTest(Trigger);
describe('Trigger', () => {
beforeEach(() => {
jest.useFakeTimers();
})... | 5,505 |
0 | petrpan-code/arco-design/arco-design/components/Trigger/__test__ | petrpan-code/arco-design/arco-design/components/Trigger/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders Trigger/demo/alignPoint.md correctly 1`] = `
<div>
<div
class="arco-row arco-row-align-center arco-row-justify-start"
style="margin-bottom:20px"
>
<span
class="arco-typography"
>
Trigger
</span>
<div
aria-autocomp... | 5,506 |
0 | petrpan-code/arco-design/arco-design/components/Trigger | petrpan-code/arco-design/arco-design/components/Trigger/style/index.less | @import './token.less';
@trigger-prefix-cls: ~'@{prefix}-trigger';
.@{trigger-prefix-cls} {
position: absolute;
z-index: @z-index-popup;
backface-visibility: hidden; // Prevent shaking
&-arrow {
background-color: @trigger-color-arrow-bg;
content: '';
height: @trigger-size-arrow-width;
width: ... | 5,507 |
0 | petrpan-code/arco-design/arco-design/components/Trigger | petrpan-code/arco-design/arco-design/components/Trigger/style/index.ts | import '../../style/index.less';
import './index.less';
| 5,508 |
0 | petrpan-code/arco-design/arco-design/components/Trigger | petrpan-code/arco-design/arco-design/components/Trigger/style/token.less | @import '../../style/theme/default.less';
@trigger-color-arrow-bg: var(~'@{arco-cssvars-prefix}-color-bg-5');
@trigger-size-arrow-width: @size-2;
@trigger-border-arrow-radius: 2px;
| 5,509 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Typography/README.en-US.md | `````
Component / General
# Typography
Used to display titles, paragraphs, and text content.
`````
%%Content%%
## API
### Typography
|Property|Description|Type|DefaultValue|
|---|---|---|---|
|className|Additional css class|string \| string[] |`-`|
|style|Additional style|CSSProperties |`-`|
### Typography.Title... | 5,510 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Typography/README.zh-CN.md | `````
组件 / 通用
# 排版 Typography
用于展示标题、段落、文本内容。
`````
%%Content%%
## API
### Typography
|参数名|描述|类型|默认值|
|---|---|---|---|
|className|节点类名|string \| string[] |`-`|
|style|节点样式|CSSProperties |`-`|
### Typography.Title
|参数名|描述|类型|默认值|版本|
|---|---|---|---|---|
|bold|粗体|boolean |`-`|-|
|code|代码块样式|boolean |`-`|-|
|del... | 5,511 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Typography/base.tsx | import React, { useState, useContext, PropsWithChildren, useRef } from 'react';
import { ConfigContext } from '../ConfigProvider';
import ResizeObserverComponent from '../_util/resizeObserver';
import {
TypographyParagraphProps,
TypographyTitleProps,
TypographyTextProps,
EllipsisConfig,
} from './interface';
im... | 5,512 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Typography/edit-content.tsx | import React, { useEffect, useRef } from 'react';
import cs from '../_util/classNames';
import { EditContentProps } from './interface';
import Input from '../Input';
import mergedToString from '../_util/mergedToString';
export default function EditContent(props: EditContentProps) {
const { prefixCls, children, setEd... | 5,513 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Typography/index.tsx | import OriginTypography from './typography';
import Title from './title';
import Text from './text';
import Paragraph from './paragraph';
const Typography = OriginTypography as typeof OriginTypography & {
Title: typeof Title;
Text: typeof Text;
Paragraph: typeof Paragraph;
};
Typography.Title = Title;
Typograph... | 5,514 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Typography/interface.tsx | import { CSSProperties, ReactNode } from 'react';
/**
* @title Typography
*/
export interface TypographyProps {
style?: CSSProperties;
className?: string | string[];
children?: ReactNode;
}
export interface OperationsProps extends Omit<React.HTMLAttributes<HTMLElement>, 'className'> {
/**
* @zh 开启复制功能
... | 5,515 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Typography/operations.tsx | import React, { useState, useRef, useEffect, PropsWithChildren } from 'react';
import useKeyboardEvent from '../_util/hooks/useKeyboardEvent';
import Tooltip from '../Tooltip';
import { isObject, isArray } from '../_util/is';
import copy from '../_util/clipboard';
import IconCopy from '../../icon/react-icon/IconCopy';
... | 5,516 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Typography/paragraph.tsx | import React, { useContext } from 'react';
import { TypographyParagraphProps } from './interface';
import Base from './base';
import cs from '../_util/classNames';
import { ConfigContext } from '../ConfigProvider';
function Paragraph(props: TypographyParagraphProps) {
const { spacing = 'default', className } = props... | 5,517 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Typography/text.tsx | import React from 'react';
import { TypographyTextProps } from './interface';
import Base from './base';
function Text(props: TypographyTextProps) {
return <Base {...props} componentType="Text" />;
}
Text.displayName = 'Text';
export default Text;
| 5,518 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Typography/title.tsx | import React from 'react';
import { TypographyTitleProps } from './interface';
import Base from './base';
function Title(props: TypographyTitleProps) {
const { heading = 1, ...rest } = props;
return <Base heading={heading} {...rest} componentType="Title" />;
}
Title.displayName = 'Title';
export default Title;
| 5,519 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Typography/typography.tsx | import React, { useContext, forwardRef } from 'react';
import cs from '../_util/classNames';
import { ConfigContext } from '../ConfigProvider';
import { TypographyProps } from './interface';
function Typography(props: TypographyProps, ref) {
const { getPrefixCls } = useContext(ConfigContext);
const prefixCls = get... | 5,520 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Typography/useCssEllipsis.tsx | import { useMemo } from 'react';
import { isUndefined } from '../_util/is';
import { EllipsisConfig } from './interface';
const supportCss = (key, value) => {
if (typeof window !== 'undefined' && window.CSS && window.CSS.supports) {
if (!isUndefined(value)) {
return window.CSS.supports(key, value);
}
... | 5,521 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Typography/useEllipsis.tsx | import React, { useMemo, useRef, useState, CSSProperties } from 'react';
import useUpdate from '../_util/hooks/useUpdate';
import throttleByRaf from '../_util/throttleByRaf';
import { isNumber, isString } from '../_util/is';
import { EllipsisConfig } from './interface';
import useIsomorphicLayoutEffect from '../_util/h... | 5,522 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__changelog__/index.en-US.md | ## 2.51.0
2023-07-28
### 🐛 BugFix
- Fix the bug that the font style does not inherit the Title style when `Typography.Title` is switched to the edit state.([#2109](https://github.com/arco-design/arco-design/pull/2109) '')
- Fix the bug that the `className` and `style` attributes passed in by the user are lost when ... | 5,523 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__changelog__/index.zh-CN.md | ## 2.51.0
2023-07-28
### 🐛 问题修复
- 修复 `Typography.Title` 切换为编辑状态时字体样式未继承 Title 样式的 bug。([#2109](https://github.com/arco-design/arco-design/pull/2109) '')
- 修复 `Typography` 切换为编辑状态时用户传入的 `className` 和 `style` 属性丢失的 bug。([#2109](https://github.com/arco-design/arco-design/pull/2109) '')
## 2.44.2
2023-02-10
### 🐛 问... | 5,524 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__demo__/basic.md | ---
order: 0
title:
zh-CN: 组合使用
en-US: Basic
---
## zh-CN
排版组件用于展示标题、段落、文本内容，这里展示了排版的组合使用。
## en-US
Display headings, paragraphs, and text content.
```js
import { Typography } from '@arco-design/web-react';
const { Title, Paragraph, Text } = Typography;
const App = () => {
return (
<Typography style={{ ... | 5,525 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__demo__/ellipsis-controlled.md | ---
order: 6
title:
zh-CN: 省略受控
en-US: Ellipsis Controlled
---
## zh-CN
省略操作及相关配置受控案例
## en-US
Ellipsis and related configuration controlled cases
```js
import { useState } from 'react';
import {
Typography,
Button,
Switch,
Input,
Form,
Descriptions,
Space,
} from '@arco-design/web-react';
const d... | 5,526 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__demo__/ellipsis.md | ---
order: 5
title:
zh-CN: 省略
en-US: Ellipsis
---
## zh-CN
在空间不足时省略多行文本内容。
**注意**：父元素 `flex` 模式下， 省略的 `Typography` 的 `ellipsis` 场景会收到影响，可以添加 `width: 100%` 使 `Typography` 充满整个父元素。
## en-US
Omit multiple lines of text when there is insufficient space.
**Note**: In the parent element `flex` mode, the omitted `Ty... | 5,527 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__demo__/operations.md | ---
order: 4
title:
zh-CN: 可交互
en-US: Interactive
---
## zh-CN
提供复制、编辑文本等功能。
## en-US
Provide functions such as copying and editing text.
```js
import { useState } from 'react';
import { Typography, Divider } from '@arco-design/web-react';
function App() {
const [str, setStr] = useState('Click the icon to e... | 5,528 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__demo__/paragraph.md | ---
order: 3
title:
zh-CN: 段落
en-US: Paragraph
---
## zh-CN
文本段落样式。
## en-US
Paragraph style.
```js
import { Typography, Divider } from '@arco-design/web-react';
const { Title, Paragraph } = Typography;
const App = () => {
return (
<Typography>
<Title heading={5}>Default</Title>
<Paragraph>
... | 5,529 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__demo__/text.md | ---
order: 2
title:
zh-CN: 文本
en-US: Text
---
## zh-CN
不同样式的文本以及超链接组件。
## en-US
Different styles of text.
```js
import React from 'react';
import { Typography, Divider } from '@arco-design/web-react';
function Layout(props) {
return React.Children.map(props.children, (child) => {
return (
<div sty... | 5,530 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__demo__/title.md | ---
order: 1
title:
zh-CN: 标题
en-US: Title
---
## zh-CN
展示不同级别的标题。
## en-US
Show titles of different levels.
```js
import { Typography } from '@arco-design/web-react';
const App = () => {
return (
<Typography>
<Typography.Title>H1. The Pragmatic Romanticism</Typography.Title>
<Typography.Tit... | 5,531 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__template__/index.en-US.md | ---
file: interface
---
`````
Component / General
# Typography
Used to display titles, paragraphs, and text content.
`````
%%Content%%
## API
%%Props%%
## About exceeding omission
Exceeding and omitting are currently implemented in two ways: **js dichotomy calculation truncation value** and **CSS exceeding and ... | 5,532 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 通用
# 排版 Typography
用于展示标题、段落、文本内容。
`````
%%Content%%
## API
%%Props%%
## 关于超出省略
超出省略目前通过两种方式实现分别是 **js二分法计算截断值** 和 **CSS超出省略** 两种优缺点如下：
|指标|js二分法|CSS省略|
|---|---|---|
|性能|差(二分法多次操作dom计算)|好|
|功能|好|差（只支持字符串)|
- 默认使用 **js二分法** 不断进行截断计算从而得到省略临界值，同时 `resize` 时还会多次触发重新计算。所以在大量使用对性... | 5,533 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__test__/css-ellipsis.test.tsx | import React from 'react';
import { act } from 'react-test-renderer';
import Typography from '..';
import { sleep, render, fireEvent } from '../../../tests/util';
const { Paragraph } = Typography;
jest.mock('resize-observer-polyfill', () => ({
__esModule: true,
default: jest.fn().mockImplementation((cb) => {
... | 5,534 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('Typography');
| 5,535 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__test__/index.test.tsx | import React from 'react';
import { act } from 'react-test-renderer';
import Typography from '..';
import IconCopy from '../../../icon/react-icon/IconCopy';
import { sleep, render, fireEvent } from '../../../tests/util';
import copy from '../../_util/clipboard';
const { Title, Text, Paragraph } = Typography;
jest.moc... | 5,536 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/__test__/js-ellipsis.test.tsx | import React from 'react';
import { act } from 'react-test-renderer';
import Typography from '..';
import { sleep, render, fireEvent } from '../../../tests/util';
const { Paragraph } = Typography;
jest.mock('resize-observer-polyfill', () => ({
__esModule: true,
default: jest.fn().mockImplementation((cb) => {
... | 5,537 |
0 | petrpan-code/arco-design/arco-design/components/Typography/__test__ | petrpan-code/arco-design/arco-design/components/Typography/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders Typography/demo/basic.md correctly 1`] = `
<article
class="arco-typography"
style="margin-top:-40px"
>
<h1
class="arco-typography"
>
Design system
</h1>
<div
class="arco-typography"
>
A design is a plan or specification for the c... | 5,538 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/style/index.less | @import './token.less';
@import '../../Input/style/token.less';
@typography-prefix-cls: ~'@{prefix}-typography';
// Title
.@{typography-prefix-cls} {
color: @typography-color-text;
line-height: @typography-paragraph-line-height;
word-break: break-all;
white-space: normal;
h1&,
&-h1,
h2&,
&-h2,
h3&,... | 5,539 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/style/index.ts | import '../../style/index.less';
import '../../Tooltip/style';
import '../../Popover/style';
import '../../Input/style';
import './index.less';
| 5,540 |
0 | petrpan-code/arco-design/arco-design/components/Typography | petrpan-code/arco-design/arco-design/components/Typography/style/token.less | @import '../../style/theme/default.less';
@typography-font-size-h1: 36px;
@typography-font-size-h2: 32px;
@typography-font-size-h3: 28px;
@typography-font-size-h4: 24px;
@typography-font-size-h5: 20px;
@typography-font-size-h6: 16px;
@typography-heading-margin-top: 1em;
@typography-heading-margin-bottom: 0.5em;
@typo... | 5,541 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Upload/README.en-US.md | `````
Component / Data Entry
# Upload
Upload file by selecting or dragging.
`````
%%Content%%
## API
### Upload
|Property|Description|Type|DefaultValue|Version|
|---|---|---|---|---|
|autoUpload|Whether to automatically upload files after selecting them|boolean |`true`|-|
|directory|Support upload whole directory... | 5,542 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Upload/README.zh-CN.md | `````
组件 / 数据输入
# 上传 Upload
用户可传输文件或提交相应的内容。
`````
%%Content%%
## API
### Upload
|参数名|描述|类型|默认值|版本|
|---|---|---|---|---|
|autoUpload|是否选中文件后自动上传|boolean |`true`|-|
|directory|文件夹上传|boolean |`-`|2.11.0|
|disabled|禁用|boolean |`-`|-|
|drag|是否拖拽上传|boolean |`-`|-|
|imagePreview|启用内置的图片预览，仅在 listType='picture-card' 时生... | 5,543 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Upload/index.tsx | import Upload from './upload';
export default Upload;
export {
UploadProps,
UploadListProps,
UploadItem,
UploadInstance,
UploadStatus,
RequestOptions,
UploadRequestReturn,
} from './interface';
| 5,544 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Upload/interface.tsx | import React, { CSSProperties, ReactNode } from 'react';
import { ProgressProps } from '../Progress';
export const STATUS: {
[key: string]: UploadStatus;
} = {
init: 'init',
uploading: 'uploading',
success: 'done',
fail: 'error',
};
export type UploadStatus = 'init' | 'uploading' | 'done' | 'error';
export... | 5,545 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Upload/request.ts | import { RequestOptions, UploadRequest } from './interface';
import { NOOP } from '../_util/constant';
function getBody(xhr: XMLHttpRequest) {
const text = xhr.responseText || xhr.response;
if (!text) {
return text;
}
try {
return JSON.parse(text);
} catch (e) {
return text;
}
}
const uploadR... | 5,546 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Upload/trigger-node.tsx | import React, { useState, useContext, PropsWithChildren, useEffect } from 'react';
import cs from '../_util/classNames';
import Button from '../Button';
import IconUpload from '../../icon/react-icon/IconUpload';
import IconPlus from '../../icon/react-icon/IconPlus';
import { TriggerProps } from './interface';
import { ... | 5,547 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Upload/upload.tsx | import React, {
forwardRef,
useContext,
useRef,
useState,
useImperativeHandle,
PropsWithChildren,
} from 'react';
import cs from '../_util/classNames';
import UploadList from './list/index';
import Uploader from './uploader';
import { isFunction, isNumber } from '../_util/is';
import { UploadProps, STATUS, ... | 5,548 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Upload/uploader.tsx | import React from 'react';
import { CSSTransition } from 'react-transition-group';
import uploadRequest from './request';
import { UploaderProps, STATUS, UploadItem, UploadRequestReturn } from './interface';
import { isNumber, isFunction, isFile, isObject } from '../_util/is';
import TriggerNode from './trigger-node';
... | 5,549 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Upload/util.tsx | import { isArray, isObject } from '../_util/is';
import { UploadProps } from './interface';
export const isAcceptFile = (file: File, propsAccept?: UploadProps['accept']): boolean => {
const accept = isObject(propsAccept) ? propsAccept?.type : propsAccept;
// 显示设置 strict=false，才是非严格模式，不走过滤逻辑
const strict = !(isOb... | 5,550 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__changelog__/index.en-US.md | ## 2.56.0
2023-11-17
### 🐛 BugFix
- Fixed the issue that the uploaded file status was overwritten to init during batch upload([#2362](https://github.com/arco-design/arco-design/pull/2362))
## 2.55.0
2023-10-27
### 🆕 Feature
- `Upload` supports custom upload method([#2297](https://github.com/arco-design/arco-de... | 5,551 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__changelog__/index.zh-CN.md | ## 2.56.0
2023-11-17
### 🐛 问题修复
- 修复 `Upload` 批量上传时已上传文件状态被覆盖成 init([#2362](https://github.com/arco-design/arco-design/pull/2362))
## 2.55.0
2023-10-27
### 🆕 功能升级
- `Upload` 支持自定义上传 method([#2297](https://github.com/arco-design/arco-design/pull/2297))
## 2.53.0
2023-09-08
### 🆕 功能升级
- `Upload` 支持通过 `accep... | 5,552 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/avatar.md | ---
order: 1
title:
zh-CN: 用户头像上传
en-US: Avatar
---
## zh-CN
点击上传用户头像，可使用 beforeUpload 限制用户上传的图片格式和大小。
## en-US
Click to upload user's avatar, and validate size and format of picture with beforeUpload.
```js
import React from 'react';
import { Upload, Progress } from '@arco-design/web-react';
import { IconPlus... | 5,553 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/basic.md | ---
order: 0
title:
zh-CN: 基础用法
en-US: Basic
---
## zh-CN
最基础的上传组件用法。
## en-US
The Basic usage.
```js
import { Upload } from '@arco-design/web-react';
const App = () => {
return (
<div>
<div>
<Upload action="/" />
</div>
<div>
<Upload
action="/"
disab... | 5,554 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/beforeUpload.md | ---
order: 6
title:
zh-CN: 上传前校验
en-US: beforeUpload
---
## zh-CN
`beforeUpload` 会在每一个文件上传之前执行。如果返回 false 或者 Promise.reject， 那么将会取消当前文件的上传。
## en-US
The function will be executed before each file upload. Uploading will be aborted when the return value is false or a Promise which resolve(false) or reject.
```js
... | 5,555 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/crop.md | ---
order: 7
title:
zh-CN: 上传前裁剪
en-US: beforeUpload
---
## zh-CN
`beforeUpload` 会在每一个文件上传之前执行。如果返回 false 或者 Promise.reject， 那么将会取消当前文件的上传。
## en-US
The function will be executed before each file upload. Uploading will be aborted when the return value is false or a Promise which resolve(false) or reject.
```js... | 5,556 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/customRequest.md | ---
order: 12
title:
zh-CN: 自定义上传实现
en-US: Custom request
---
## zh-CN
默认通过 Ajax 请求上传，可以设置 customRequest 覆盖默认的上传请求，实现自定义上传。
返回值是一个对象，包含 `abort` 用来终止上传。
## en-US
Override for the default xhr behavior allowing for additional customization and ability to implement your own XMLHttpRequest
```js
import { useState... | 5,557 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/directory.md | ---
order: 14
title:
zh-CN: 文件夹上传
en-US: Upload directory
---
## zh-CN
文件夹上传
## en-US
Upload directory.
```js
import { Upload } from '@arco-design/web-react';
const App = () => {
return (
<div>
<div>
<Upload directory action="/" />
</div>
</div>
);
};
export default App;
```
| 5,558 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/drag.md | ---
order: 3
title:
zh-CN: 拖拽上传
en-US: drag and drop
---
## zh-CN
拖拽上传。当使用拖拽上传，且设置 `accept` 时候，选择后的文件将会被根据后缀名及文件类型被过滤。不符合格式的文件将不会出现在上传列表。
## en-US
Drag files to a specific area, to upload.
```js
import { Upload, Message } from '@arco-design/web-react';
const isAcceptFile = (file, accept) => {
if (accept && ... | 5,559 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/icon.md | ---
order: 10
title:
zh-CN: 自定义图标
en-US: custom icon
---
## zh-CN
`showUploadList` 字段可以设置图标。
## en-US
`showUploadList` can be an object to customize `previewIcon`, `removeIcon`, `fileIcon`, `reuploadIcon`, `cancelIcon`, `startIcon`, `errorIcon` and `fileName`.
```js
import React from 'react';
import { Upload, ... | 5,560 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/limit.md | ---
order: 8
title:
zh-CN: 限制上传数量
en-US: Limit
---
## zh-CN
通过`limit`限制上传的最大数量。超出后上传按钮会隐藏.
## en-US
Limit the maximum number of uploaded files.
```js
import { Upload, Message } from '@arco-design/web-react';
function App() {
return (
<Upload
action="/"
limit={3}
multiple
onExceed... | 5,561 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/manully.md | ---
order: 5
title:
zh-CN: 手动上传
en-US: upload manually
---
## zh-CN
设置 `autoUpload` 为 `false`时候，可以通过调用 `submit`方法进行手动上传。`submit` 只会上传处于 `fileList` 中的文件。
## en-US
If `autoUpload` equals `false`, files will not be uploaded automatically after being selected. You can submit them by `uploadRef.submit` method.`submi... | 5,562 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/onRemove.md | ---
order: 7
title:
zh-CN: 移除前校验
en-US: onRemove
---
## zh-CN
`onRemove` 会在每个文件从上传列表中删除之前执行。如果返回 false 或者 Promise.reject，那么将会终止移除操作。
## en-US
The function will be executed when user click remove icon. Remove actions will be aborted when the return value is false or a Promise which resolve(false) or reject
```j... | 5,563 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/pictureList.md | ---
order: 4
title:
zh-CN: 图片列表样式
en-US: pictures with list
---
## zh-CN
图片列表样式
## en-US
Pictures with list style.
```js
import { Upload, Radio } from '@arco-design/web-react';
const defaultFileList = [
{
uid: '-3',
name: 'light.png',
url: '//p1-arco.byteimg.com/tos-cn-i-uwbnlip3yd/a8c8cdb109cb05... | 5,564 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/preview.md | ---
order: 2
title:
zh-CN: 照片墙
en-US: pictures wall
---
## zh-CN
点击图片预览按钮时，可以`onPreview`中进行预览逻辑。
可以通过 `imagePreview` 属性启用内置的图片预览。（`imagePreview` 属性在 `2.41.0` 支持）
## en-US
`onPreview` will be executed when user click preview icon.
The built-in image preview can be enabled via the `imagePreview` property. (The ... | 5,565 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/progress.md | ---
order: 13
title:
zh-CN: 自定义进度条
en-US: customize progress bar
---
## zh-CN
`progressProps` 字段可以自定义进度条属性。
## en-US
Use `progressProps` for customize progress bar.
```js
import React from 'react';
import { Upload, Radio, Button } from '@arco-design/web-react';
function App() {
const [fileList, setFileList] ... | 5,566 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/renderUploadList.md | ---
order: 11
title:
zh-CN: 自定义文件上传列表展示
en-US: Customize upload list
---
## zh-CN
传入 `renderUploadList` 可以自定义展示文件上传列表。第一个参数是当前上传列表，第二个参数是上传列表相关的属性。详细可参考 `<UploadListProps>`
## en-US
Customize the display of uploaded files
```js
import { Upload, Card, Modal } from '@arco-design/web-react';
import { IconEye, Icon... | 5,567 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/trigger.md | ---
order: 9
title:
zh-CN: 自定义上传节点
en-US: Customize children
---
## zh-CN
可以传入自定义内容作为文件上传的触发节点。
## en-US
Customize the node that triggers the upload operation.
```js
import { Upload } from '@arco-design/web-react';
import { IconLink } from '@arco-design/web-react/icon';
const App = () => {
return (
<div... | 5,568 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__demo__/uploadList.md | ---
order: 1
title:
zh-CN: 已上传的文件列表
en-US: upload list
---
## zh-CN
默认的文件上传列表
## en-US
Default upload list.
```js
import { Upload, Radio, Modal } from '@arco-design/web-react';
const defaultFileList = [
{
uid: '-1',
name: 'ice.png',
url: '//p1-arco.byteimg.com/tos-cn-i-uwbnlip3yd/3ee5f13fb09879ec... | 5,569 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__template__/index.en-US.md | ---
file: interface
---
`````
Component / Data Entry
# Upload
Upload file by selecting or dragging.
`````
%%Content%%
## API
%%Props%%
### Methods
| Property | Description | Type |
| ---------- ... | 5,570 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 数据输入
# 上传 Upload
用户可传输文件或提交相应的内容。
`````
%%Content%%
## API
%%Props%%
### 方法/Methods
| 参数名 | 描述 | 类型 |
| ---------- | :-----------------------------------------... | 5,571 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__test__/apis.test.tsx | import React from 'react';
import { useFakeXMLHttpRequest } from 'sinon';
import { act } from 'react-test-renderer';
import { UploadItem, UploadProps } from '../interface';
import mountTest from '../../../tests/mountTest';
import { sleep, render, fireEvent } from '../../../tests/util';
import Upload from '..';
functio... | 5,572 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('Upload');
| 5,573 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__test__/drop.test.tsx | import React from 'react';
import { useFakeXMLHttpRequest } from 'sinon';
import { act } from 'react-test-renderer';
import { UploadItem } from '../interface';
import mountTest from '../../../tests/mountTest';
import { sleep, render, fireEvent } from '../../../tests/util';
import Upload from '..';
function getFile(nam... | 5,574 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__test__/index.test.tsx | import React from 'react';
import { useFakeXMLHttpRequest } from 'sinon';
import { act } from 'react-test-renderer';
import { UploadItem, STATUS } from '../interface';
import mountTest from '../../../tests/mountTest';
import componentConfigTest from '../../../tests/componentConfigTest';
import Upload from '..';
import ... | 5,575 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__test__/list.test.tsx | import React from 'react';
import { act } from 'react-test-renderer';
import { IconFileAudio, IconClose, IconFaceFrownFill, IconUpload } from '../../../icon';
import { STATUS } from '../interface';
import mountTest from '../../../tests/mountTest';
import Upload from '..';
import { render, fireEvent } from '../../../tes... | 5,576 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/__test__/methods.test.tsx | import React from 'react';
import { useFakeXMLHttpRequest } from 'sinon';
import { act } from 'react-test-renderer';
import { UploadItem, STATUS, UploadInstance } from '../interface';
import mountTest from '../../../tests/mountTest';
import Upload from '..';
import { sleep, render, fireEvent } from '../../../tests/util... | 5,577 |
0 | petrpan-code/arco-design/arco-design/components/Upload/__test__ | petrpan-code/arco-design/arco-design/components/Upload/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders Upload/demo/avatar.md correctly 1`] = `
<div>
<div
class="arco-upload arco-upload-type-text"
>
<input
style="display:none"
type="file"
/>
<div
class="arco-upload-trigger"
>
<div
class=""
>
... | 5,578 |
0 | petrpan-code/arco-design/arco-design/components/Upload/__test__ | petrpan-code/arco-design/arco-design/components/Upload/__test__/__snapshots__/index.test.tsx.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`ConfigProvider componentConfig.Upload default 1`] = `
Array [
<div
class="arco-upload arco-upload-type-text"
>
<input
style="display:none"
type="file"
/>
<div
class="arco-upload-trigger"
>
<button
aria-label="点击... | 5,579 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/list/index.tsx | import React, { useContext, ReactNode, useState, useMemo } from 'react';
import { CSSTransition, TransitionGroup } from 'react-transition-group';
import cs from '../../_util/classNames';
import PictureItem from './pictureItem';
import TextItem from './textItem';
import { ConfigContext } from '../../ConfigProvider';
imp... | 5,580 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/list/pictureItem.tsx | import React from 'react';
import { ConfigProviderProps } from '../../ConfigProvider';
import { UploadListProps, STATUS, CustomIconType } from '../interface';
import { UploadItem } from '../upload';
import { isFunction, isObject } from '../../_util/is';
import UploadProgress from './uploadProgress';
import IconImageClo... | 5,581 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/list/textItem.tsx | import React from 'react';
import IconFile from '../../../icon/react-icon/IconFile';
import IconFilePdf from '../../../icon/react-icon/IconFilePdf';
import IconFileImage from '../../../icon/react-icon/IconFileImage';
import IconFileVideo from '../../../icon/react-icon/IconFileVideo';
import IconFileAudio from '../../..... | 5,582 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/list/uploadProgress.tsx | import React, { FC, useContext } from 'react';
import { STATUS, UploadListProps, CustomIconType } from '../interface';
import Progress, { ProgressProps } from '../../Progress';
import { UploadItem } from '../upload';
import { ConfigContext } from '../../ConfigProvider';
import IconCheck from '../../../icon/react-icon/I... | 5,583 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/style/index.less | @import './token.less';
@upload-prefix-cls: ~'@{prefix}-upload';
.@{upload-prefix-cls} {
display: inline-block;
max-width: 100%;
&-type-picture-card {
vertical-align: top;
}
&-drag {
width: 100%;
}
&-hide {
display: none;
}
&-disabled {
.@{upload-prefix-cls}-trigger-picture,
... | 5,584 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/style/index.ts | import '../../style/index.less';
import '../../Button/style';
import '../../Tooltip/style';
import '../../Progress/style';
import '../../Image/style';
import './index.less';
| 5,585 |
0 | petrpan-code/arco-design/arco-design/components/Upload | petrpan-code/arco-design/arco-design/components/Upload/style/token.less | @import '../../style/theme/default.less';
@upload-tip-color-text: var(~'@{arco-cssvars-prefix}-color-text-3');
@upload-tip-margin-top: @spacing-2;
@upload-tip-font-size: @font-size-body-1;
@upload-list-margin-top: @spacing-9;
@upload-picture-item-width: @size-20;
@upload-picture-color-bg: var(~'@{arco-cssvars-prefix}... | 5,586 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/VerificationCode/README.en-US.md | `````
Component / Data Entry
# VerificationCode
Verification code input component. `2.55.0` supported
`````
%%Content%%
## API
### VerificationCode
2.55.0
|Property|Description|Type|DefaultValue|
|---|---|---|---|
|disabled|disabled|boolean |`-`|
|masked|Password mode|boolean |`-`|
|readOnly|readOnly|boolean |`... | 5,587 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/VerificationCode/README.zh-CN.md | `````
组件 / 输入
# 验证码输入 VerificationCode
验证码输入组件，`2.55.0` 支持
`````
%%Content%%
## API
### VerificationCode
`2.55.0` 支持
|参数名|描述|类型|默认值|
|---|---|---|---|
|disabled|禁用|boolean |`-`|
|masked|是否是密码模式|boolean |`-`|
|readOnly|只读|boolean |`-`|
|length|验证码的长度，根据长度渲染对应个数的输入框|number |`6`|
|defaultValue|默认值|string |`-`|
|v... | 5,588 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/VerificationCode/index.tsx | import VerificationCode from './verification-code';
import { VerificationCodeProps } from './interface';
export { VerificationCodeProps };
export default VerificationCode;
| 5,589 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/VerificationCode/interface.ts | import { CSSProperties, ReactNode } from 'react';
import { InputProps } from '../Input';
/**
* @title VerificationCode
* @zh `2.55.0` 支持
* @en 2.55.0
*/
export interface VerificationCodeProps {
style?: CSSProperties;
className?: string | string[];
/**
* @zh 默认值
* @en The initial input content
*/
d... | 5,590 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/VerificationCode/verification-code.tsx | import React, { forwardRef, useRef, useContext, Fragment } from 'react';
import cs from '../_util/classNames';
import InputComponent from '../Input/input-element';
import { ConfigContext } from '../ConfigProvider';
import useMergeProps from '../_util/hooks/useMergeProps';
import { VerificationCodeProps } from './inter... | 5,591 |
0 | petrpan-code/arco-design/arco-design/components/VerificationCode | petrpan-code/arco-design/arco-design/components/VerificationCode/__changelog__/index.en-US.md | ## 2.55.0
2023-10-27
### 🆕 Feature
- Add `VerificationCode` component([#2308](https://github.com/arco-design/arco-design/pull/2308))
| 5,592 |
0 | petrpan-code/arco-design/arco-design/components/VerificationCode | petrpan-code/arco-design/arco-design/components/VerificationCode/__changelog__/index.zh-CN.md | ## 2.55.0
2023-10-27
### 🆕 功能升级
- 新增 `VerificationCode` 验证码输入组件([#2308](https://github.com/arco-design/arco-design/pull/2308))
| 5,593 |
0 | petrpan-code/arco-design/arco-design/components/VerificationCode | petrpan-code/arco-design/arco-design/components/VerificationCode/__demo__/basic.md | ---
order: 0
title:
zh-CN: 基本用法
en-US: Basic
---
## zh-CN
基本用法
## en-US
Basic uasge.
```js
import { VerificationCode, Message } from '@arco-design/web-react';
const App = () => {
return <VerificationCode
style={{width: 300}}
onChange={v => {
console.log(v)
}}
onFinish={v => {
Mes... | 5,594 |
0 | petrpan-code/arco-design/arco-design/components/VerificationCode | petrpan-code/arco-design/arco-design/components/VerificationCode/__demo__/mask.md | ---
order: 2
title:
zh-CN: 密码模式
en-US: Masked
---
## zh-CN
指定 `masked = true`，可开启密码模式
## en-US
Use `masked = true` to turn on password mode
```js
import { VerificationCode, Message } from '@arco-design/web-react';
const App = () => {
return (
<div>
<VerificationCode
defaultValue="123"
... | 5,595 |
0 | petrpan-code/arco-design/arco-design/components/VerificationCode | petrpan-code/arco-design/arco-design/components/VerificationCode/__demo__/seperator.md | ---
order: 3
title:
zh-CN: 自定义分隔符
en-US: Custom separator
---
## zh-CN
指定 `separator` 可以自定义渲染分隔符
## en-US
Specify `separator` to customize the rendering separator
```js
import { VerificationCode } from '@arco-design/web-react';
const App = () => {
return (
<VerificationCode style={{width: 400}} length={... | 5,596 |
0 | petrpan-code/arco-design/arco-design/components/VerificationCode | petrpan-code/arco-design/arco-design/components/VerificationCode/__demo__/status.md | ---
order: 1
title:
zh-CN: 不同状态
en-US: Status
---
## zh-CN
禁用状态、错误状态
## en-US
Disabled Status、 Error status
```js
import { VerificationCode, Space, Typography } from '@arco-design/web-react';
const App = () => {
return (
<div>
<Space>
<div style={{width: 80}}>
<Typography.Text >D... | 5,597 |
0 | petrpan-code/arco-design/arco-design/components/VerificationCode | petrpan-code/arco-design/arco-design/components/VerificationCode/__demo__/validate.md | ---
order: 5
title:
zh-CN: 校验与格式化输入
en-US: Validation and formatted input
---
## zh-CN
通过 validate 校验输入。此外，可以返回非布尔类型来将用户输入的字符串为特定的格式。
## en-US
Validate input via validate. Additionally, non-boolean types can be returned to format user-entered strings into a specific format.
```js
import { Grid, VerificationCod... | 5,598 |
0 | petrpan-code/arco-design/arco-design/components/VerificationCode | petrpan-code/arco-design/arco-design/components/VerificationCode/__demo__/with-form.md | ---
order: 4
title:
zh-CN: 配合表单使用
en-US: With Form
---
## zh-CN
配合表单使用实现校验
## en-US
Use with forms to implement verification
```js
import { Form, Button, Typography, VerificationCode } from '@arco-design/web-react';
const App = () => {
return (
<div className="demo-verify-code-wrapper">
<Typography... | 5,599 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.