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/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/__demo__/horizontal.md | ---
order: 1
title:
zh-CN: 横向 Anchor
en-US: Horizontal Anchor
---
## zh-CN
横向 Anchor，不支持嵌套
## en-US
Horizontal Anchor, does not support nesting
```js
import { Anchor,Typography } from '@arco-design/web-react';
const AnchorLink = Anchor.Link;
const App = () => {
return (
<div>
<Typography.Paragraph... | 3,700 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/__demo__/lineless.md | ---
order: 2
title:
zh-CN: 无轴线模式
en-US: Lineless mode
---
## zh-CN
设置 `lineless` 时，可以使用无左侧轴线的锚点样式。
## en-US
Use `lineless=true` to hide axis line on the left.
```js
import { Anchor } from '@arco-design/web-react';
const AnchorLink = Anchor.Link;
const App = () => {
return (
<Anchor affix={false} lineles... | 3,701 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/__demo__/static.md | ---
order: 1
title:
zh-CN: 静态位置
en-US: Static
---
## zh-CN
设置 `affix=false` 不随着页面滚动，锚点处于固定位置。
## en-US
Setting `affix=false`, the anchor is on a fixed position and does't scroll with the page.
```js
import { Anchor } from '@arco-design/web-react';
const AnchorLink = Anchor.Link;
const App = () => {
return (... | 3,702 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/__template__/index.en-US.md | ---
file: interface
---
`````
Component / Other
# Anchor
By the Anchor can quickly find the information content of the current page.
`````
%%Content%%
## API
%%Props%%
| 3,703 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 其他
# 锚点 Anchor
通过锚点可快速找到信息内容在当前页面的位置。
`````
%%Content%%
## API
%%Props%%
| 3,704 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('Anchor');
| 3,705 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/__test__/index.test.tsx | import React from 'react';
import { act } from 'react-test-renderer';
import mountTest from '../../../tests/mountTest';
import Anchor, { AnchorProps } from '..';
import { isString } from '../../_util/is';
import { findNode } from '../utils';
import * as utilModal from '../utils';
import componentConfigTest from '../../... | 3,706 |
0 | petrpan-code/arco-design/arco-design/components/Anchor/__test__ | petrpan-code/arco-design/arco-design/components/Anchor/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders Anchor/demo/affix.md correctly 1`] = `
<div
class=""
style="position:absolute;right:-170px;top:50%;z-index:1"
>
<div
class=""
>
<div
class="arco-anchor"
>
<div
class="arco-anchor-list"
>
<div
cla... | 3,707 |
0 | petrpan-code/arco-design/arco-design/components/Anchor/__test__ | petrpan-code/arco-design/arco-design/components/Anchor/__test__/__snapshots__/index.test.tsx.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`ConfigProvider componentConfig.Anchor default 1`] = `
<div
class=""
>
<div
class=""
>
<div
class="arco-anchor"
>
<div
class="arco-anchor-list"
/>
</div>
</div>
</div>
`;
exports[`ConfigProvider componentConfig.Anchor... | 3,708 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/style/direction.less | @import './token.less';
@anchor-prefix-cls: ~'@{prefix}-anchor';
.@{anchor-prefix-cls} {
&&-horizontal {
width: 100%;
}
&-horizontal &-list {
display: flex;
width: 100%;
margin: 0;
&::before {
left: 0;
right: 0;
width: 100%;
bottom: 0;
height: 2px;
}
}
... | 3,709 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/style/index.less | @import './token.less';
@anchor-prefix-cls: ~'@{prefix}-anchor';
.@{anchor-prefix-cls} {
position: relative;
width: @anchor-width;
overflow: auto;
&-line {
&-slider {
position: absolute;
height: @anchor-line-slider-height;
width: @anchor-line-width;
margin-top: (
(@anchor-... | 3,710 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/style/index.ts | import '../../style/index.less';
import '../../Affix/style';
import './index.less';
| 3,711 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/style/token.less | @import '../../style/theme/default.less';
// Line
@anchor-width: 150px;
@anchor-line-width: 2px;
@anchor-line-slider-height: 12px;
@anchor-line-margin-right: 12px;
@anchor-color-bg-line: var(~'@{arco-cssvars-prefix}-color-fill-3');
@anchor-color-bg-line_active: @color-primary-6;
@anchor-border-radius-title-hover: @ra... | 3,712 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/AutoComplete/README.en-US.md | `````
Component / Data Entry
# AutoComplete
An input box or custom input control, with enhanced automatic completion functionality.
`````
%%Content%%
## API
### AutoComplete
|Property|Description|Type|DefaultValue|Version|
|---|---|---|---|---|
|allowClear|Whether to allow clear the content|boolean |`-`|-|
|defau... | 3,713 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/AutoComplete/README.zh-CN.md | `````
组件 / 数据输入
# 自动补全 AutoComplete
输入框或自定义输入控件的自动补全功能。
`````
%%Content%%
## API
### AutoComplete
|参数名|描述|类型|默认值|版本|
|---|---|---|---|---|
|allowClear|是否允许一键清除|boolean |`-`|-|
|defaultActiveFirstOption|是否默认高亮第一个选项|boolean |`true`|-|
|disabled|是否禁用|boolean |`-`|-|
|error|是否是错误状态。(废弃，下个大版本移除，使用 status='error' 替代)|b... | 3,714 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/AutoComplete/index.tsx | import React, { useContext, useRef, isValidElement, useState, useImperativeHandle } from 'react';
import cs from '../_util/classNames';
import Input from '../Input';
import { ConfigContext } from '../ConfigProvider';
import useMergeValue from '../_util/hooks/useMergeValue';
import Select, { SelectHandle } from '../Sele... | 3,715 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/AutoComplete/interface.ts | import { CSSProperties, ReactNode, ReactElement } from 'react';
import { InputProps } from '../Input';
import { OptionInfo, SelectProps } from '../Select/interface';
import { AvailableVirtualListProps } from '../_class/VirtualList';
type PartialSelectProps = Pick<
SelectProps,
| 'filterOption'
| 'dropdownRender... | 3,716 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/__changelog__/index.en-US.md | ## 2.31.0
2022-03-25
### 🆕 Feature
- `AutoComplete` component's `triggerElement` property allows passing in a function to customize the component trigger node.([#686](https://github.com/arco-design/arco-design/pull/686))
## 2.25.1
2021-11-26
### 💎 Optimization
- `AutoComplete`'s property `onPressEnter` adds th... | 3,717 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/__changelog__/index.zh-CN.md | ## 2.31.0
2022-03-25
### 🆕 功能升级
- `AutoComplete` 组件 `triggerElement` 属性允许传入函数以自定义组件触发节点。([#686](https://github.com/arco-design/arco-design/pull/686))
## 2.25.1
2021-11-26
### 💎 优化
- `AutoComplete` 组件 `onPressEnter` 回调新增 `activeOption` 参数以区分回车键按下时下拉列表是否存在激活的选项。([#223](https://github.com/arco-design/arco-design/... | 3,718 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/__demo__/advance.md | ---
order: 4
title:
zh-CN: 复杂用法
en-US: Advance
---
## zh-CN
这个示例展示了：`1. 添加Tooltip`, `2. 自定义显示`, `3. 对值进行操控`。
## en-US
This example shows: `1. Add Tooltip`, `2. Custom display`, `3. Manipulate values`.
```js
import { useState } from 'react';
import { AutoComplete, Tooltip } from '@arco-design/web-react';
funct... | 3,719 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/__demo__/basic.md | ---
order: 0
title:
zh-CN: 基础用法
en-US: Basic
---
## zh-CN
根据当前输入展示输入建议（下拉选择）。
## en-US
Show input suggestions based on current input (drop-down selection).
```js
import { useState } from 'react';
import { AutoComplete } from '@arco-design/web-react';
function App() {
const [data, setData] = useState([]);
... | 3,720 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/__demo__/custom-input.md | ---
order: 2
title:
zh-CN: 自定义输入组件
en-US: Custom input
---
## zh-CN
支持自定义输入组件。
## en-US
Support custom input components.
```js
import { useState } from 'react';
import { AutoComplete, Input } from '@arco-design/web-react';
const { TextArea } = Input;
function App() {
const [data, setData] = useState([]);
... | 3,721 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/__demo__/options.md | ---
order: 1
title:
zh-CN: 自定义选项
en-US: Options
---
## zh-CN
可以传入 `AutoComplete.Option` 作为组件的 `children`，而非使用 `data`。
## en-US
Pass in `AutoComplete.Option` as the `children` of the component instead of using `data`.
```js
import { useState } from 'react';
import { AutoComplete } from '@arco-design/web-react';... | 3,722 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/__demo__/strict.md | ---
order: 3
title:
zh-CN: 区分大小写
en-US: Strict mode
---
## zh-CN
使用 `strict=true` 来指明在匹配时严格区分大小写。
## en-US
Use `strict=true` to enable case-sensitive matching for options.
```js
import { AutoComplete } from '@arco-design/web-react';
const data = ['beijing', 'beihai', 'baoding'];
const App = () => {
return (... | 3,723 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/__demo__/with-group.md | ---
order: 5
title:
zh-CN: 查询模式 确定类目
en-US: With group
---
## zh-CN
根据查询结果补全输入内容（确定类目）。
## en-US
Complete the input according to the query result (with group).
```js
import { useState } from 'react';
import { AutoComplete, Input } from '@arco-design/web-react';
const { OptGroup, Option } = AutoComplete;
funct... | 3,724 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/__demo__/without-group.md | ---
order: 6
title:
zh-CN: 查询模式 不确定类目
en-US: Without group
---
## zh-CN
根据查询结果补全输入内容（不确定类目）。
## en-US
Complete the input according to the query result (without group).
```js
import { useState } from 'react';
import { AutoComplete, Input } from '@arco-design/web-react';
const { Option } = AutoComplete;
functio... | 3,725 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/__template__/index.en-US.md | ---
file: interface
---
`````
Component / Data Entry
# AutoComplete
An input box or custom input control, with enhanced automatic completion functionality.
`````
%%Content%%
## API
%%Props%%
### AutoComplete.Option
Same as `Select.Option`, refer to [Select](/react/en-US/components/select).
### AutoComplete.Opt... | 3,726 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 数据输入
# 自动补全 AutoComplete
输入框或自定义输入控件的自动补全功能。
`````
%%Content%%
## API
%%Props%%
### AutoComplete.Option
同 `Select.Option`, 参考 [Select 文档](/react/components/select) 。
### AutoComplete.OptGroup
同 `Select.OptGroup`, 参考 [Select 文档](/react/components/select) 。
| 3,727 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('AutoComplete');
| 3,728 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/__test__/index.test.tsx | import React from 'react';
import { render, fireEvent } from '../../../tests/util';
import { ArrowDown, ArrowUp, Enter, Esc } from '../../_util/keycode';
import mountTest from '../../../tests/mountTest';
import componentConfigTest from '../../../tests/componentConfigTest';
import AutoComplete from '..';
import Input fr... | 3,729 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete/__test__ | petrpan-code/arco-design/arco-design/components/AutoComplete/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders AutoComplete/demo/advance.md correctly 1`] = `
<div
class="arco-input-group-wrapper arco-input-group-wrapper-default arco-input-has-suffix arco-autocomplete"
style="width:154px"
>
<span
class="arco-input-group"
>
<span
class="arco-input-... | 3,730 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete/__test__ | petrpan-code/arco-design/arco-design/components/AutoComplete/__test__/__snapshots__/index.test.tsx.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`ConfigProvider componentConfig.AutoComplete default 1`] = `
<div
class="arco-input-group-wrapper arco-input-group-wrapper-default arco-input-has-suffix arco-autocomplete"
>
<span
class="arco-input-group"
>
<span
class="arco-input-inner-wrapper arc... | 3,731 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/style/index.less | @import './token.less';
@auto-complete-prefix-cls: ~'@{prefix}-autocomplete';
@select-prefix-cls: ~'@{prefix}-select';
.@{auto-complete-prefix-cls} {
&-popup .@{select-prefix-cls}-popup {
border: 1px solid @auto-complete-popup-color-border;
border-radius: @auto-complete-popup-border-radius;
background-c... | 3,732 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/style/index.ts | import '../../style/index.less';
import '../../Input/style';
import '../../Select/style';
import './index.less';
| 3,733 |
0 | petrpan-code/arco-design/arco-design/components/AutoComplete | petrpan-code/arco-design/arco-design/components/AutoComplete/style/token.less | @import '../../style/theme/default.less';
/**********************************************
* Popup Box
**********************************************/
@auto-complete-popup-max-height: @size-50;
@auto-complete-popup-border-radius: @radius-medium;
@auto-complete-popup-padding-vertical: @spacing-2;
@auto-complete-popup-... | 3,734 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Avatar/README.en-US.md | `````
Component / Data Display
# Avatar
Used as an avatar, it can be displayed in the form of pictures, icons or characters.
`````
%%Content%%
## API
### Avatar
|Property|Description|Type|DefaultValue|
|---|---|---|---|
|autoFixFontSize|Whether to automatically adjust the font size according to the size of the av... | 3,735 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Avatar/README.zh-CN.md | `````
组件 / 数据展示
# 头像 Avatar
用作头像显示，可以为图片、图标或字符形式展示。
`````
%%Content%%
## API
### Avatar
|参数名|描述|类型|默认值|
|---|---|---|---|
|autoFixFontSize|是否自动根据头像尺寸调整字体大小。|boolean |`true`|
|size|头像的尺寸大小，单位是 `px`|number |`-`|
|shape|头像的形状，有圆形(circle)和正方形(square)两种|'circle' \| 'square' |`circle`|
|triggerType|可点击的头像交互类型。|'mask' \... | 3,736 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Avatar/avatar.tsx | import React, {
useImperativeHandle,
useRef,
useEffect,
useContext,
CSSProperties,
PropsWithChildren,
forwardRef,
} from 'react';
import cs from '../_util/classNames';
import { ConfigContext } from '../ConfigProvider';
import AvatarContext from './context';
import { AvatarProps } from './interface';
impor... | 3,737 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Avatar/context.ts | import { createContext } from 'react';
import { AvatarProps } from './interface';
export default createContext<AvatarProps>({});
| 3,738 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Avatar/group.tsx | import React, { useContext, forwardRef, PropsWithChildren } from 'react';
import { isNumber } from '../_util/is';
import cs from '../_util/classNames';
import { ConfigContext } from '../ConfigProvider';
import Avatar from './avatar';
import Popover from '../Popover';
import AvatarContext from './context';
import { Avat... | 3,739 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Avatar/index.tsx | import Avatar from './avatar';
import Group from './group';
export * from './interface';
type AvatarComponentType = typeof Avatar & {
Group: typeof Group;
};
const AvatarComponent = Avatar as AvatarComponentType;
AvatarComponent.Group = Group;
export default AvatarComponent;
| 3,740 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Avatar/interface.ts | import { CSSProperties, ReactNode } from 'react';
import { TriggerProps } from '../Trigger';
/**
* @title Avatar
*/
export interface AvatarProps {
style?: CSSProperties;
className?: string | string[];
/**
* @zh 头像的形状，有圆形(circle)和正方形(square)两种
* @en The shape of the avatar. Two shapes are available: `circ... | 3,741 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/__changelog__/index.en-US.md | ## 2.45.1
2023-03-01
### 💎 Enhancement
- Optimize `Avatar` child node type judgment logic([#1813](https://github.com/arco-design/arco-design/pull/1813))
## 2.25.1
2021-11-26
### 🐛 BugFix
- Fix the style problem that the spacing between avatars is not set when the `size` property is not set for the avatar group... | 3,742 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/__changelog__/index.zh-CN.md | ## 2.45.1
2023-03-01
### 💎 功能优化
- 优化 `Avatar` 子节点类型判断逻辑([#1813](https://github.com/arco-design/arco-design/pull/1813))
## 2.25.1
2021-11-26
### 🐛 问题修复
- 修复 `Avatar.Group` 未设置 `size` 属性时，头像间距未设置的样式问题。([#220](https://github.com/arco-design/arco-design/pull/220))
## 2.24.0
2021-11-05
### 🐛 问题修复
- 修复 `Avatar`... | 3,743 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/__demo__/autoFixFontSize.md | ---
order: 4
title:
zh-CN: 自动调整字体大小
en-US: Auto fix font Size
---
## zh-CN
如果头像是文字的话，会自动调节字体大小，来适应头像框。
## en-US
If the avatar content is text, the font size will be automatically adjusted to fit the content in the avatar.
```tsx
import React, { useState } from 'react';
import { Avatar, Button, Space } from '@a... | 3,744 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/__demo__/basic.md | ---
order: 0
title:
zh-CN: 基础用法
en-US: Basic
---
## zh-CN
头像的基础使用。如果头像是文字的话，会自动调节字体大小，来适应头像框。
## en-US
Basic usage. If the avatar content is text, the font size will be automatically adjusted to fit the content in the avatar.
```js
import { Avatar, Typography, Space } from '@arco-design/web-react';
import { Ic... | 3,745 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/__demo__/group.md | ---
order: 2
title:
zh-CN: 头像组
en-US: Group
---
## zh-CN
使用 `Avatar.Group` 可以使用头像组功能，可通过 `size` 指定头像的大小。
## en-US
Use `Avatar.Group` to group a list of avatars. `size` can be used to specify the size of each avatar.
```js
import { Avatar } from '@arco-design/web-react';
const AvatarGroup = Avatar.Group;
const... | 3,746 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/__demo__/size.md | ---
order: 1
title:
zh-CN: 大小和形状
en-US: Size
---
## zh-CN
通过设置 `size` 字段，可以调节头像的大小，默认大小为 `40px`。设置 `shape` 字段，可以设置头像是圆形 (circle) 还是正方形 (square)。
## en-US
Use `size` to set the size of the avatar, which defaults to `40px`. Two `shape`s are available for the avatar: `circle` and `square`.
```js
import { Avatar, ... | 3,747 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/__demo__/triggerIcon.md | ---
order: 3
title:
zh-CN: 交互按钮
en-US: Trigger icon
---
## zh-CN
可以通过 `triggerIcon` `triggerType` 来定制交互按钮，类型有 `mask (遮罩)` 和 `button (按钮)` 两种，通过 `onClick` 参数来添加回调。
## en-US
Customize the interactive button through `triggerIcon` and `triggerType`. Two types are available: `mask` and `button`. Callbacks can be add... | 3,748 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/__template__/index.en-US.md | ---
file: interface
---
`````
Component / Data Display
# Avatar
Used as an avatar, it can be displayed in the form of pictures, icons or characters.
`````
%%Content%%
## API
%%Props%%
| 3,749 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 数据展示
# 头像 Avatar
用作头像显示，可以为图片、图标或字符形式展示。
`````
%%Content%%
## API
%%Props%%
| 3,750 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('Avatar');
| 3,751 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/__test__/index.test.tsx | import React from 'react';
import ReactDOM from 'react-dom';
import { act } from 'react-dom/test-utils';
import mountTest from '../../../tests/mountTest';
import componentConfigTest from '../../../tests/componentConfigTest';
import Avatar from '..';
import IconEdit from '../../../icon/react-icon/IconEdit';
const Avata... | 3,752 |
0 | petrpan-code/arco-design/arco-design/components/Avatar/__test__ | petrpan-code/arco-design/arco-design/components/Avatar/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders Avatar/demo/autoFixFontSize.md correctly 1`] = `
<div
class="arco-space arco-space-horizontal arco-space-align-center"
>
<div
class="arco-space-item"
style="margin-right:8px"
>
<div
class="arco-avatar arco-avatar-circle"
style="f... | 3,753 |
0 | petrpan-code/arco-design/arco-design/components/Avatar/__test__ | petrpan-code/arco-design/arco-design/components/Avatar/__test__/__snapshots__/index.test.tsx.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`ConfigProvider componentConfig.Avatar default 1`] = `
<div
class="arco-avatar arco-avatar-circle"
style="font-size:"
>
<span
class="arco-avatar-text"
/>
</div>
`;
exports[`ConfigProvider componentConfig.Avatar set className globally 1`] = `
<div
class=... | 3,754 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/style/index.less | @import './token.less';
@avatar-prefix-cls: ~'@{prefix}-avatar';
.@{avatar-prefix-cls} {
display: inline-flex;
align-items: center;
position: relative;
background-color: @avatar-color-bg;
white-space: nowrap;
color: @avatar-color-text;
box-sizing: border-box;
vertical-align: middle;
width: @avatar-s... | 3,755 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/style/index.ts | import '../../style/index.less';
import '../../Popover/style';
import './index.less';
| 3,756 |
0 | petrpan-code/arco-design/arco-design/components/Avatar | petrpan-code/arco-design/arco-design/components/Avatar/style/token.less | @import '../../style/theme/default.less';
@avatar-size-default: @size-10;
@avatar-color-text: var(~'@{arco-cssvars-prefix}-color-white');
@avatar-color-bg: var(~'@{arco-cssvars-prefix}-color-fill-4');
@avatar-color-group-item-border: var(~'@{arco-cssvars-prefix}-color-bg-2');
@avatar-group-item-border-width: 2px;
@ava... | 3,757 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/BackTop/README.en-US.md | `````
Component / Other
# BackTop
`BackTop` makes it easy to go back to the top of the page.
`````
%%Content%%
## API
### BackTop
|Property|Description|Type|DefaultValue|
|---|---|---|---|
|duration|Duration to scroll to the top|number |`400`|
|visibleHeight|When scrolling to this height, display the back to top ... | 3,758 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/BackTop/README.zh-CN.md | `````
组件 / 其他
# 返回顶部 BackTop
可一键返回顶部的按钮。
`````
%%Content%%
## API
### BackTop
|参数名|描述|类型|默认值|
|---|---|---|---|
|duration|滚动到顶部的时间。|number |`400`|
|visibleHeight|当滚动到这个高度时，显示返回顶部按钮。|number |`400`|
|easing|滚动到顶部的缓动方式类型, 所有类型：[easing](https://github.com/PengJiyuan/b-tween)。|string |`quartOut`|
|className|节点类名|strin... | 3,759 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/BackTop/index.tsx | import React, { PropsWithChildren, forwardRef, useState, useEffect, useContext, memo } from 'react';
import { CSSTransition } from 'react-transition-group';
import BTween from 'b-tween';
import { pickDataAttributes } from '../_util/pick';
import cs from '../_util/classNames';
import IconToTop from '../../icon/react-ico... | 3,760 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/BackTop/interface.ts | import { CSSProperties } from 'react';
/**
* @title BackTop
*/
export interface BackTopProps {
style?: CSSProperties;
className?: string | string[];
/**
* @zh 当滚动到这个高度时，显示返回顶部按钮。
* @en When scrolling to this height, display the back to top button.
* @defaultValue 400
*/
visibleHeight?: number;
... | 3,761 |
0 | petrpan-code/arco-design/arco-design/components/BackTop | petrpan-code/arco-design/arco-design/components/BackTop/__changelog__/index.zh-CN.md | ## 2.4.0
2020-12-11
### 🆎 TypeScript
- 修复 `Backtop` 定义缺少 `children` 的问题。
| 3,762 |
0 | petrpan-code/arco-design/arco-design/components/BackTop | petrpan-code/arco-design/arco-design/components/BackTop/__demo__/basic.md | ---
order: 0
title:
zh-CN: 基础用法
en-US: Basic
browser: true
---
## zh-CN
当滚动到一定高度的时候，在右下角会出现一个返回顶部的按钮。
## en-US
When scrolling to a certain height, a button to return to the top will appear in the lower right corner.
```js
import { BackTop, Typography } from '@arco-design/web-react';
const App = () => {
ret... | 3,763 |
0 | petrpan-code/arco-design/arco-design/components/BackTop | petrpan-code/arco-design/arco-design/components/BackTop/__demo__/custom_button.md | ---
order: 1
title:
zh-CN: 自定义按钮
en-US: Custom button
browser: true
---
## zh-CN
可以自定义返回顶部的按钮。
## en-US
You can customize the button to return to the top.
```js
import { BackTop, Button, Typography } from '@arco-design/web-react';
const { Paragraph } = Typography;
const App = () => {
return (
<div styl... | 3,764 |
0 | petrpan-code/arco-design/arco-design/components/BackTop | petrpan-code/arco-design/arco-design/components/BackTop/__demo__/easing.md | ---
order: 2
title:
zh-CN: 滚动类型和滚动时间
en-US: Easing
browser: true
---
## zh-CN
当然，我们提供了更丰富的功能可供使用，你可以通过指定 `easing` 和 `duration` 来指定滚动到顶部的过度效果和滚动时间。
## en-US
Of course, we provide richer functions for use. You can specify the transition effect and scroll time of scrolling to the top by specifying `easing` and `du... | 3,765 |
0 | petrpan-code/arco-design/arco-design/components/BackTop | petrpan-code/arco-design/arco-design/components/BackTop/__template__/index.en-US.md | ---
file: interface
---
`````
Component / Other
# BackTop
`BackTop` makes it easy to go back to the top of the page.
`````
%%Content%%
## API
%%Props%%
| 3,766 |
0 | petrpan-code/arco-design/arco-design/components/BackTop | petrpan-code/arco-design/arco-design/components/BackTop/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 其他
# 返回顶部 BackTop
可一键返回顶部的按钮。
`````
%%Content%%
## API
%%Props%%
| 3,767 |
0 | petrpan-code/arco-design/arco-design/components/BackTop | petrpan-code/arco-design/arco-design/components/BackTop/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('BackTop');
| 3,768 |
0 | petrpan-code/arco-design/arco-design/components/BackTop | petrpan-code/arco-design/arco-design/components/BackTop/__test__/index.test.tsx | import React from 'react';
import { fireEvent, render, sleep } from '../../../tests/util';
import mountTest from '../../../tests/mountTest';
import componentConfigTest from '../../../tests/componentConfigTest';
import BackTop from '..';
mountTest(BackTop);
componentConfigTest(BackTop, 'BackTop');
describe('BackTop', ... | 3,769 |
0 | petrpan-code/arco-design/arco-design/components/BackTop/__test__ | petrpan-code/arco-design/arco-design/components/BackTop/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders BackTop/demo/basic.md correctly 1`] = `
<div
style="position:relative;padding:8px 12px"
>
<div
class="arco-backtop"
style="position:absolute"
/>
<div
class="arco-typography"
>
The button will appear in the bottom corner of the scroll... | 3,770 |
0 | petrpan-code/arco-design/arco-design/components/BackTop/__test__ | petrpan-code/arco-design/arco-design/components/BackTop/__test__/__snapshots__/index.test.tsx.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`ConfigProvider componentConfig.BackTop default 1`] = `
<div
class="arco-backtop"
/>
`;
exports[`ConfigProvider componentConfig.BackTop set className globally 1`] = `
<div
class="arco-backtop global-default-class"
/>
`;
exports[`ConfigProvider componentConfig.Ba... | 3,771 |
0 | petrpan-code/arco-design/arco-design/components/BackTop | petrpan-code/arco-design/arco-design/components/BackTop/style/index.less | @import './token.less';
@backtop-prefix-cls: ~'@{prefix}-backtop';
.@{backtop-prefix-cls} {
position: fixed;
bottom: @backtop-margin-bottom;
right: @backtop-margin-right;
z-index: 100;
cursor: pointer;
&-button {
width: @backtop-button-size-width;
height: @backtop-button-size-width;
font-size... | 3,772 |
0 | petrpan-code/arco-design/arco-design/components/BackTop | petrpan-code/arco-design/arco-design/components/BackTop/style/index.ts | import '../../style/index.less';
import './index.less';
| 3,773 |
0 | petrpan-code/arco-design/arco-design/components/BackTop | petrpan-code/arco-design/arco-design/components/BackTop/style/token.less | @import '../../style/theme/default.less';
@backtop-margin-bottom: @spacing-9;
@backtop-margin-right: @spacing-9;
@backtop-button-size-width: @size-10;
@backtop-button-size-font: @font-size-body-1;
@backtop-button-size-icon: 14px;
@backtop-button-color-bg: @color-primary-6;
@backtop-button-color-bg_hover: @color-prima... | 3,774 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Badge/README.en-US.md | `````
Component / Data Display
# Badge
Badge normally appears in the upper right corner of the icon or text to prompt important information.
`````
%%Content%%
## API
### Badge
|Property|Description|Type|DefaultValue|
|---|---|---|---|
|dot|Whether to display a red dot instead of `count`|boolean |`-`|
|maxCount|Ma... | 3,775 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Badge/README.zh-CN.md | `````
组件 / 数据展示
# 徽标数 Badge
一般出现在图标或文字的右上角。提供及时、重要的信息提示。
`````
%%Content%%
## API
### Badge
|参数名|描述|类型|默认值|
|---|---|---|---|
|dot|显示为小红点|boolean |`-`|
|maxCount|徽标最大显示数值，如果 count 超过这个数值会显示为 `${maxCount}+`|number |`99`|
|text|自定义提示内容|string |`-`|
|color|内置的一些颜色|\| 'red'\| 'orangered'\| 'orange'\| 'gold'\| 'lime'\... | 3,776 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Badge/count.tsx | import React, { useState } from 'react';
import { CSSTransition } from 'react-transition-group';
import cs from '../_util/classNames';
import usePrevious from '../_util/hooks/usePrevious';
export default function Count({ prefixCls, maxCount, count, className, style }) {
const [isEntered, setIsEntered] = useState(fal... | 3,777 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Badge/index.tsx | import React, { useContext, forwardRef } from 'react';
import { CSSTransition } from 'react-transition-group';
import cs from '../_util/classNames';
import { ConfigContext } from '../ConfigProvider';
import { isObject } from '../_util/is';
import Count from './count';
import { BadgeProps } from './interface';
import us... | 3,778 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Badge/interface.ts | import { HTMLAttributes, CSSProperties, ReactNode } from 'react';
import { Omit } from '../_util/type';
/**
* @title Badge
*/
export interface BadgeProps extends Omit<HTMLAttributes<HTMLElement>, 'className'> {
style?: CSSProperties;
className?: string | string[];
/**
* @zh 徽标显示的数字
* @en Number to show i... | 3,779 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__changelog__/index.en-US.md | ## 2.45.1
2023-03-01
### 💅 Style
- Adjust the text size of the `Badge` component from `12px` to `14px`, aligning with the design specification([#1816](https://github.com/arco-design/arco-design/pull/1816))
## 2.28.2
2022-01-21
### 🐛 BugFix
- Fixed the bug of console waring caused by passing the `color` propert... | 3,780 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__changelog__/index.zh-CN.md | ## 2.45.1
2023-03-01
### 💅 样式更新
- 调整 `Badge` 组件文本大小从 `12px` 到 `14px`，对齐设计规范([#1816](https://github.com/arco-design/arco-design/pull/1816))
## 2.28.2
2022-01-21
### 🐛 问题修复
- 修复`Badge`组件里`CssTransition`传入`string`类型的`color`属性导致控制台waring的bug([#455](https://github.com/arco-design/arco-design/pull/455))
## 2.16.0
... | 3,781 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__demo__/animate.md | ---
order: 7
title:
zh-CN: 动画效果
en-US: Animated
---
## zh-CN
`count` 改变时候存在动画效果。
## en-US
The count will be animated as it changes.
```tsx
import React from 'react';
import { Badge, Avatar, Button, Switch, Space } from '@arco-design/web-react';
import { IconPlus, IconMinus } from '@arco-design/web-react/icon'... | 3,782 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__demo__/basic.md | ---
order: 0
title:
zh-CN: 基础用法
en-US: Basic
---
## zh-CN
基础的用法。只需指定 `count`，即可显示徽标。
## en-US
Basic usage. Just specify `count` to display the badge.
```js
import { Badge, Avatar, Space } from '@arco-design/web-react';
import { IconClockCircle } from '@arco-design/web-react/icon';
const App = () => {
return... | 3,783 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__demo__/color.md | ---
order: 6
title:
zh-CN: 颜色
en-US: Color
---
## zh-CN
我们提供多种预设色彩的徽标样式。如果预设值不能满足你的需求，`color` 字段也可以设置自定义色值。
## en-US
We provide a variety of preset colors for the badge. You can also set a custom color with `color` property.
```js
import { Badge, Divider } from '@arco-design/web-react';
const COLORS = [
'red... | 3,784 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__demo__/dot.md | ---
order: 2
title:
zh-CN: 小红点
en-US: Red Badge
---
## zh-CN
设置 `dot`，即可只显示小红点而不显示数字。`count > 0` 时才显示。
## en-US
A red dot will be displayed instead of the count when `dot=true`. If count equals 0, the dot will be hidden.
```js
import { Badge, Space } from '@arco-design/web-react';
import { IconNotification } f... | 3,785 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__demo__/max_count.md | ---
order: 4
title:
zh-CN: 最大值
en-US: Max Count
---
## zh-CN
设置 `maxCount`，可以限制最大显示的徽标数值，超过将会加 `+` 后缀。`maxCount` 默认为 `99`。
## en-US
If the count is larger than `maxCount`, `${maxCount}+` will be displayed. The default value of `maxCount` is `99`.
```js
import { Badge, Avatar, Space } from '@arco-design/web-rea... | 3,786 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__demo__/no-children.md | ---
order: 1
title:
zh-CN: 独立使用
en-US: Standalone
---
## zh-CN
`children` 为空时，将会独立展示徽标。
## en-US
Used in standalone when children is empty.
```js
import { Badge, Space } from '@arco-design/web-react';
const App = () => {
return (
<Space size={40}>
<Badge count={2} />
<Badge
count={2}
... | 3,787 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__demo__/status.md | ---
order: 5
title:
zh-CN: 状态点
en-US: Status
---
## zh-CN
设置 `status`，可以得到不同的状态点。`default - 默认` `processing - 进行中` `success - 成功` `warning - 提醒` `error - 错误`。
## en-US
A variety of status are available: `default`, `processing`, `success`, `warning` and `error`.
```js
import { Badge, Divider, Space } from '@ar... | 3,788 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__demo__/text.md | ---
order: 3
title:
zh-CN: 文本内容
en-US: Text
---
## zh-CN
设置 `text`，可设置自定义提示内容。
## en-US
Customize the content.
```js
import { Badge, Avatar, Space } from '@arco-design/web-react';
import { IconUser } from '@arco-design/web-react/icon';
const App = () => {
return (
<Space size={40}>
<Badge text="NEW... | 3,789 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__template__/index.en-US.md | ---
file: interface
---
`````
Component / Data Display
# Badge
Badge normally appears in the upper right corner of the icon or text to prompt important information.
`````
%%Content%%
## API
%%Props%%
## Questions
1. How to hide the red dot when `dot=true`?
You can set `count=0`. The logo will be displayed on... | 3,790 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 数据展示
# 徽标数 Badge
一般出现在图标或文字的右上角。提供及时、重要的信息提示。
`````
%%Content%%
## API
%%Props%%
## 常见问题
1. 如何在 `dot=true` 时设置不显示小红点？
可以设置`count=0`。`count > 0` 的时候才会展示徽标。
| 3,791 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('Badge');
| 3,792 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/__test__/index.test.ts | import mountTest from '../../../tests/mountTest';
import componentConfigTest from '../../../tests/componentConfigTest';
import Badge from '..';
mountTest(Badge);
componentConfigTest(Badge, 'Badge');
| 3,793 |
0 | petrpan-code/arco-design/arco-design/components/Badge/__test__ | petrpan-code/arco-design/arco-design/components/Badge/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders Badge/demo/animate.md correctly 1`] = `
<div
class="arco-space arco-space-vertical"
>
<div
class="arco-space-item"
style="margin-bottom:24px"
>
<div
class="arco-space arco-space-horizontal arco-space-align-center"
>
<div
... | 3,794 |
0 | petrpan-code/arco-design/arco-design/components/Badge/__test__ | petrpan-code/arco-design/arco-design/components/Badge/__test__/__snapshots__/index.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`ConfigProvider componentConfig.Badge default 1`] = `
<span
class="arco-badge arco-badge-no-children"
/>
`;
exports[`ConfigProvider componentConfig.Badge set className globally 1`] = `
<span
class="arco-badge arco-badge-no-children global-default-class"
/>
`;
ex... | 3,795 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/style/index.less | @import './token.less';
@badge-prefix-cls: ~'@{prefix}-badge';
.@{badge-prefix-cls} {
display: inline-block;
position: relative;
line-height: 1;
&-rtl {
direction: rtl;
}
&-number,
&-dot,
&-text,
&-custom-dot {
position: absolute;
z-index: 2;
transform: translate(50%, -50%);
tr... | 3,796 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/style/index.ts | import '../../style/index.less';
import './index.less';
| 3,797 |
0 | petrpan-code/arco-design/arco-design/components/Badge | petrpan-code/arco-design/arco-design/components/Badge/style/token.less | @import '../../style/theme/default.less';
@badge-size-count-height: @size-5;
@badge-padding-count-horizontal: @spacing-3;
@badge-margin-status-text-left: @spacing-4;
@badge-font-count-size: @font-size-body-1;
@badge-font-status-text-size: @font-size-body-3;
@badge-color-count-text: var(~'@{arco-cssvars-prefix}-color-... | 3,798 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Breadcrumb/README.en-US.md | `````
Component / Navigation
# Breadcrumb
Used to display the location of the current page and quickly return to the history page.
`````
%%Content%%
## API
### Breadcrumb
|Property|Description|Type|DefaultValue|
|---|---|---|---|
|maxCount|Max count of `Breadcrumb.Item` to show.|number |`-`|
|separator|Custom sep... | 3,799 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.