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/Layout | petrpan-code/arco-design/arco-design/components/Layout/__demo__/collapsed.md | ---
order: 2
title:
zh-CN: 自定义收起按钮
en-US: Customize collapse button
---
## zh-CN
设置 `Menu.Sider` 的 `trigger` 属性为 `null` 后，`Sider` 内置的缩起按钮不会显示。此时可自定义收起按钮。
## en-US
After setting the `trigger` property of `Menu.Sider` to `null`, the built-in trigger of `Sider` will not be displayed. At this time, you can customiz... | 4,500 |
0 | petrpan-code/arco-design/arco-design/components/Layout | petrpan-code/arco-design/arco-design/components/Layout/__demo__/customIcon.md | ---
order: 1
title:
zh-CN: 自定义按钮 Icon
en-US: Customize button's icon
---
## zh-CN
通过设置 `Menu.Sider` 的 `trigger` 属性，实现自定义收起按钮的图标。
## en-US
By setting the `trigger` property of `Menu.Sider`, the icon of the collapse button can be customized.
```js
import React from 'react';
import { Layout, Menu, Breadcrumb, But... | 4,501 |
0 | petrpan-code/arco-design/arco-design/components/Layout | petrpan-code/arco-design/arco-design/components/Layout/__demo__/resize.md | ---
order: 4
title:
zh-CN: 可伸缩侧边栏
en-US: Retractable sidebar
---
## zh-CN
可以用鼠标进行拖拽放大缩小的侧边栏，需要用到的参数：`resizeDirections`。
## en-US
By `resizeDirections`, you can use the mouse to drag the sidebar to zoom in and out.
```js
import { Layout } from '@arco-design/web-react';
const Sider = Layout.Sider;
const Header =... | 4,502 |
0 | petrpan-code/arco-design/arco-design/components/Layout | petrpan-code/arco-design/arco-design/components/Layout/__demo__/resizeProps.md | ---
order: 5
title:
zh-CN: 伸缩+收起侧边栏
en-US: Resizable and collapsible sidebar
---
## zh-CN
通过 `resizeBoxProps.onMoving`方法， 配置 `width` 和 `collapsed` 可以实现即可以拖拽伸缩杆也可以点击收缩的侧边栏。
这时侧边栏的宽度完全受控于 `width` 的值
## en-US
Through the `resizeBoxProps.onMoving` method, configuring `width` and `collapsed` can realize that you ca... | 4,503 |
0 | petrpan-code/arco-design/arco-design/components/Layout | petrpan-code/arco-design/arco-design/components/Layout/__template__/index.en-US.md | ---
file: interface
---
`````
Component / Layout
# Layout
The basic layout framework which is often nested with components to build the overall layout of the page.
`````
%%Content%%
## API
%%Props%%
| 4,504 |
0 | petrpan-code/arco-design/arco-design/components/Layout | petrpan-code/arco-design/arco-design/components/Layout/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 布局
# 布局 Layout
页面的基础布局框架，常与组件嵌套使用，构建页面整体布局。
`````
%%Content%%
## API
%%Props%%
| 4,505 |
0 | petrpan-code/arco-design/arco-design/components/Layout | petrpan-code/arco-design/arco-design/components/Layout/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('Layout');
| 4,506 |
0 | petrpan-code/arco-design/arco-design/components/Layout | petrpan-code/arco-design/arco-design/components/Layout/__test__/index.test.tsx | import React from 'react';
import { render } from '../../../tests/util';
import IconEdit from '../../../icon/react-icon/IconEdit';
import mountTest from '../../../tests/mountTest';
import componentConfigTest from '../../../tests/componentConfigTest';
import Layout from '..';
const { Sider, Content, Footer, Header } = ... | 4,507 |
0 | petrpan-code/arco-design/arco-design/components/Layout/__test__ | petrpan-code/arco-design/arco-design/components/Layout/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders Layout/demo/basic.md correctly 1`] = `
<div
class="layout-basic-demo"
>
<section
class="arco-layout"
style="height:400px"
>
<header
class="arco-layout-header"
>
Header
</header>
<main
class="arco-layout-content"... | 4,508 |
0 | petrpan-code/arco-design/arco-design/components/Layout/__test__ | petrpan-code/arco-design/arco-design/components/Layout/__test__/__snapshots__/index.test.tsx.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`ConfigProvider componentConfig.Layout default 1`] = `
<section
class="arco-layout"
/>
`;
exports[`ConfigProvider componentConfig.Layout set className globally 1`] = `
<section
class="arco-layout global-default-class"
/>
`;
exports[`ConfigProvider componentConfi... | 4,509 |
0 | petrpan-code/arco-design/arco-design/components/Layout | petrpan-code/arco-design/arco-design/components/Layout/style/index.less | @import './token.less';
@layout-prefix-cls: ~'@{prefix}-layout';
.@{layout-prefix-cls} {
display: flex;
flex: 1;
margin: 0;
padding: 0;
flex-direction: column;
&-sider {
position: relative;
width: auto;
margin: 0;
padding: 0;
flex: none; // flex: 0 0 auto; 当右侧文字过长的时候不会被压缩。
backgro... | 4,510 |
0 | petrpan-code/arco-design/arco-design/components/Layout | petrpan-code/arco-design/arco-design/components/Layout/style/index.ts | import '../../style/index.less';
import '../../ResizeBox/style';
import '../../Affix/style';
import './index.less';
| 4,511 |
0 | petrpan-code/arco-design/arco-design/components/Layout | petrpan-code/arco-design/arco-design/components/Layout/style/token.less | @import '../../style/theme/default.less';
@layout-trigger-height: 48px;
// Layout Theme Dark(Default)
@layout-sider-background: var(~'@{arco-cssvars-prefix}-color-menu-dark-bg');
@layout-font-color-dark: var(~'@{arco-cssvars-prefix}-color-white');
@layout-font-color: var(~'@{arco-cssvars-prefix}-color-text-1');
@layo... | 4,512 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Link/README.en-US.md | `````
Component / General
# Link
Basic style of link.
`````
%%Content%%
## API
### Link
|Property|Description|Type|DefaultValue|Version|
|---|---|---|---|---|
|disabled|Whether to disable|boolean |`-`|-|
|hoverable|Whether to hide background when hover|boolean |`true`|2.23.0|
|status|The status of `Link`|'error' ... | 4,513 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Link/README.zh-CN.md | `````
组件 / 通用
# 链接 Link
链接的基本样式。
`````
%%Content%%
## API
### Link
|参数名|描述|类型|默认值|版本|
|---|---|---|---|---|
|disabled|是否禁用|boolean |`-`|-|
|hoverable|悬浮状态是否有底色|boolean |`true`|2.23.0|
|status|不同状态|'error' \| 'success' \| 'warning' |`-`|-|
|className|节点类名|string \| string[] |`-`|-|
|icon|显示图标，设置为 `true` 时展示默认图标。|R... | 4,514 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Link/index.tsx | import React, { forwardRef, useContext, PropsWithChildren } from 'react';
import IconLink from '../../icon/react-icon/IconLink';
import cs from '../_util/classNames';
import { ConfigContext } from '../ConfigProvider';
import { LinkProps } from './interface';
import useMergeProps from '../_util/hooks/useMergeProps';
imp... | 4,515 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Link/interface.ts | import { ReactNode, CSSProperties, AnchorHTMLAttributes } from 'react';
/**
* @title Link
*/
export interface LinkProps extends Omit<AnchorHTMLAttributes<HTMLAnchorElement>, 'className'> {
className?: string | string[];
style?: CSSProperties;
/**
* @zh 显示图标，设置为 `true` 时展示默认图标。
* @en Custom Icon, Display ... | 4,516 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/__changelog__/index.en-US.md | ## 2.23.0-beta.0
2021-09-17
### 🆕 Feature
- The `Link` component supports setting the hover state style through the `hoverable` property
## 2.13.0
2021-03-26
### 💅 Style
- Fix the style problem of the lower position of the `Link` component icon.
- Set the icon size under the `Link` component to default to `12p... | 4,517 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/__changelog__/index.zh-CN.md | ## 2.23.0-beta.0
2021-09-17
### 🆕 功能升级
- `Link` 组件支持通过 `hoverable` 属性设置悬浮状态样式
## 2.13.0
2021-03-26
### 💅 Style
- 修复 `Link` 组件图标位置靠下的样式问题。
- 设置 `Link` 组件下的图标大小默认为 `12px`。
## 2.1.0
2020-11-06
### 🆎 TypeScript
- `Link` 组件支持原生 `a` 标签属性。
| 4,518 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/__demo__/basic.md | ---
order: 0
title:
zh-CN: 基础用法
en-US: Basic
---
## zh-CN
与按钮相比，链接不太突出，因此通常将其用作可选操作。
## en-US
A link text.
```js
import { Link, Space } from '@arco-design/web-react';
const App = () => {
return (
<Space size={40}>
<Link href="#"> Link </Link>
<Link href="#" disabled>
Link
</Lin... | 4,519 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/__demo__/dropdown.md | ---
order: 4
title:
zh-CN: 配合dropdown使用
en-US: Usage with dropdown
---
## zh-CN
配合下拉菜单实现带下拉选择的链接。
## en-US
Display a drop-down menu by the Dropdown component.
```js
import { Link, Dropdown, Menu, Divider } from '@arco-design/web-react';
import { IconDown } from '@arco-design/web-react/icon';
const Droplist = (... | 4,520 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/__demo__/hoverable.md | ---
order: 3
title:
zh-CN: 悬浮状态样式
en-US: Hoverable
---
## zh-CN
可以通过 `hoverable` 属性设置是否在悬浮状态时隐藏底色。
## en-US
You can use the `hoverable` property to set whether to hide the background color of the Link component when it is hovering.
```js
import { Link, Space } from '@arco-design/web-react';
const App = () => ... | 4,521 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/__demo__/icon.md | ---
order: 2
title:
zh-CN: 图标
en-US: Icon
---
## zh-CN
通过 `Icon` 属性设置带图标的链接，设置为 `true`时候显示默认图标。
## en-US
Customize icon node. If true, the default icon will be displayed.
```js
import { Link, Space } from '@arco-design/web-react';
import { IconEdit } from '@arco-design/web-react/icon';
const App = () => {
re... | 4,522 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/__demo__/status.md | ---
order: 1
title:
zh-CN: 其他状态
en-US: Status
---
## zh-CN
失败、警告、成功等其他状态下操作，可出现不同样式的链接。
## en-US
There are three types of status available: `error`, `success`, `warning`.
```js
import { Link } from '@arco-design/web-react';
const App = () => {
return (
<div
style={{
display: 'grid',
... | 4,523 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/__template__/index.en-US.md | ---
file: interface
---
`````
Component / General
# Link
Basic style of link.
`````
%%Content%%
## API
%%Props%%
| 4,524 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 通用
# 链接 Link
链接的基本样式。
`````
%%Content%%
## API
%%Props%%
| 4,525 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('Link');
| 4,526 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/__test__/index.test.tsx | import React from 'react';
import { fireEvent, render, screen } from '../../../tests/util';
import mountTest from '../../../tests/mountTest';
import componentConfigTest from '../../../tests/componentConfigTest';
import Link from '..';
mountTest(Link);
componentConfigTest(Link, 'Link');
describe('Link', () => {
it('... | 4,527 |
0 | petrpan-code/arco-design/arco-design/components/Link/__test__ | petrpan-code/arco-design/arco-design/components/Link/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders Link/demo/basic.md correctly 1`] = `
<div
class="arco-space arco-space-horizontal arco-space-align-center"
>
<div
class="arco-space-item"
style="margin-right:40px"
>
<a
class="arco-link"
href="#"
>
Link
</a>
</d... | 4,528 |
0 | petrpan-code/arco-design/arco-design/components/Link/__test__ | petrpan-code/arco-design/arco-design/components/Link/__test__/__snapshots__/index.test.tsx.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`ConfigProvider componentConfig.Link default 1`] = `
<span
class="arco-link"
/>
`;
exports[`ConfigProvider componentConfig.Link set className globally 1`] = `
<span
class="arco-link global-default-class"
/>
`;
exports[`ConfigProvider componentConfig.Link set cla... | 4,529 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/style/index.less | @import './token.less';
@link-prefix-cls: ~'@{prefix}-link';
.@{link-prefix-cls} {
color: @link-color-text;
font-size: @link-font-size;
line-height: @link-line-height;
display: inline-block;
padding: @link-padding-vertical @link-padding-horizontal;
text-decoration: none;
cursor: pointer;
border-radius... | 4,530 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/style/index.ts | import '../../style/index.less';
import './index.less';
| 4,531 |
0 | petrpan-code/arco-design/arco-design/components/Link | petrpan-code/arco-design/arco-design/components/Link/style/token.less | @import '../../style/theme/default.less';
@link-font-size: @font-size-body-3;
@link-line-height: @line-height-base;
@link-color-bg_hover: var(~'@{arco-cssvars-prefix}-color-fill-2');
@link-color-bg_active: var(~'@{arco-cssvars-prefix}-color-fill-3');
@link-padding-horizontal: @spacing-2;
@link-color-text: @color-link... | 4,532 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/List/README.en-US.md | `````
Component / Data Display
# List
The most basic list display, which can carry text/pictures/paragraphs, and is often used in the data display page.
`````
%%Content%%
## API
### List
|Property|Description|Type|DefaultValue|Version|
|---|---|---|---|---|
|bordered|Whether to render border|boolean |`true`|-|
|h... | 4,533 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/List/README.zh-CN.md | `````
组件 / 数据展示
# 列表 List
最基础的列表展示，可承载文字、列表、图片、段落，常用于后台数据展示页面。
`````
%%Content%%
## API
### List
|参数名|描述|类型|默认值|版本|
|---|---|---|---|---|
|bordered|是否显示边框|boolean |`true`|-|
|hoverable|列表项是否可悬浮|boolean |`-`|2.9.0|
|loading|是否加载中|boolean |`-`|-|
|split|是否显示分割线|boolean |`true`|-|
|defaultCurrent|滚动加载数据当前页码|number |... | 4,534 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/List/index.tsx | import React, { useCallback, useContext, useImperativeHandle, useRef, useState } from 'react';
import throttle from 'lodash/throttle';
import Pagination, { PaginationProps } from '../Pagination';
import Spin from '../Spin';
import Item from './item';
import cs from '../_util/classNames';
import Row from '../Grid/row';
... | 4,535 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/List/interface.ts | import { CSSProperties, HTMLAttributes, MutableRefObject, ReactNode } from 'react';
import { PaginationProps } from '../Pagination/pagination';
import { AvailableVirtualListProps } from '../_class/VirtualList';
import { RowProps, ColProps, GridResponsiveBreakpoint } from '../Grid/interface';
type ListGridProps = {
c... | 4,536 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/List/item.tsx | import React, { useContext } from 'react';
import Meta from './meta';
import { ConfigContext } from '../ConfigProvider';
import cs from '../_util/classNames';
import useMergeProps from '../_util/hooks/useMergeProps';
import { ListItemProps } from './interface';
const defaultProps: Partial<ListItemProps> = {
actionLa... | 4,537 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/List/meta.tsx | import React, { useContext } from 'react';
import cs from '../_util/classNames';
import { ConfigContext } from '../ConfigProvider';
import { ListItemMetaProps } from './interface';
function Meta(props: ListItemMetaProps, ref) {
const { getPrefixCls } = useContext(ConfigContext);
const { className, avatar, title, d... | 4,538 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__changelog__/index.en-US.md | ## 2.55.0
2023-10-27
### 🐛 BugFix
- Fix the `cannot read properties of null (reading 'scrollTop')` error that occasionally occurs when the `List` component is scrolling.([#2316](https://github.com/arco-design/arco-design/pull/2316))
## 2.52.1
2023-08-25
### 🐛 BugFix
- Fix the issue that the drop-down for switc... | 4,539 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__changelog__/index.zh-CN.md | ## 2.55.0
2023-10-27
### 🐛 问题修复
- 修复 `List` 组件滚动时偶现的 `cannot read properties of null (reading 'scrollTop')` 错误。([#2316](https://github.com/arco-design/arco-design/pull/2316))
## 2.52.1
2023-08-25
### 🐛 问题修复
- 修复 `List` 组件设置可翻页时，切换 `pageSize` 的下拉框有时无法展开的问题。([#2186](https://github.com/arco-design/arco-design/pul... | 4,540 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__demo__/action-layout.md | ---
order: 4
title:
zh-CN: 竖排列表样式
en-US: Vertical List
---
## zh-CN
这是一个包括分页、右侧内容、下方列表操作的示例。
## en-US
This is an example including paging, content on the right, and list operations.
```js
import { List, Avatar } from '@arco-design/web-react';
import { IconHeart, IconMessage, IconStar } from '@arco-design/web-r... | 4,541 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__demo__/actions.md | ---
order: 3
title:
zh-CN: 增加操作项
en-US: With Actions
---
## zh-CN
通过 `actions` 来为列表添加操作项。
## en-US
Use `actions` to add operation items to the list.
```js
import { useState } from 'react';
import { List, Avatar } from '@arco-design/web-react';
import { IconEdit, IconDelete, IconDown, IconLoading } from '@arco-... | 4,542 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__demo__/basic.md | ---
order: 0
title:
zh-CN: 基本用法
en-US: Basic
---
## zh-CN
最基础的列表展示，可承载文字、列表、图片、段落，常用于后台数据展示页面。
## en-US
List can carry text, pictures, and paragraphs, and is often used to display data.
```js
import { List } from '@arco-design/web-react';
const App = () => {
return (
<List
style={{ width: 622 }}
... | 4,543 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__demo__/grid.md | ---
order: 5
title:
zh-CN: 栅格列表
en-US: Grid List
---
## zh-CN
通过 `grid.span` 设置期望每行展示的列数。
## en-US
Use `grid.span` to set the number of columns expected to occupy.
```js
import { List, Card } from '@arco-design/web-react';
const data = [
{
title: 'Platform',
data: ['iOS', 'Android', 'Web'],
},
{
... | 4,544 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__demo__/meta.md | ---
order: 2
title:
zh-CN: 基础列表
en-US: With Meta
---
## zh-CN
使用 `List.Item.Meta` 可快速指定头像、标题、文字。
## en-US
Use `List.Item.Meta` to quickly specify avatar, title, and text.
```js
import { List, Avatar } from '@arco-design/web-react';
const App = () => {
return (
<List
style={{ width: 600 }}
da... | 4,545 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__demo__/responsive-grid.md | ---
order: 6
title:
zh-CN: 响应式栅格
en-US: Responsive List Grid
---
## zh-CN
通过 `grid.sm` 等响应式参数动态设置每个单项横跨的列数，注意此时不要设置 `grid.span`。
## en-US
Dynamically set the number of columns occupied by each item through parameters such as `grid.sm`. Be careful not to set `grid.span` at this time.
```js
import { List, Card ... | 4,546 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__demo__/scrollLoad.md | ---
order: 7
title:
zh-CN: 滚动加载列表
en-US: Scroll Loading
---
## zh-CN
可设置 `onReachBottom` 来动态滚动加载列表。当 `onReachBottom` 无法满足需求，可通过 `onListScroll` 来自定义列表滚动监听函数，此时默认的滚动监听函数将失效。
## en-US
You can set `onReachBottom` to dynamically loading data when the list is scrolling. If `onReachBottom` cannot meet the requirements... | 4,547 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__demo__/size.md | ---
order: 1
title:
zh-CN: 不同尺寸
en-US: Size
---
## zh-CN
设置 `size` 可以使用三种尺寸（`small`, `default`, `large`）的列表，可根据业务需求自行选择。
## en-US
There are three sizes (`small` `default` `large`) that you can select according to your need.
```js
import { useState } from 'react';
import { List, Radio } from '@arco-design/web-r... | 4,548 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__demo__/virtual-list.md | ---
order: 8
title:
zh-CN: 无限长列表
en-US: Infinite List
---
## zh-CN
通过指定 `virtualListProps` 来开启虚拟列表，在大量数据时获得高性能表现。
在使用虚拟列表时，如果列表元素之间高度变化较大可能导致滚动时视口出现空白区域，可以通过设定 `virtualListProps.itemHeight` 解决。`itemHeight` 用于计算实际需要渲染的 DOM 节点数目（视口高度 / 元素高度），其值越小实际渲染的 DOM 节点越多，性能开销也会随之增大。
**由于虚拟列表内部使用到了 ListItem 的 `ref`，因此如果你通过 `r... | 4,549 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__template__/index.en-US.md | ---
file: interface
---
`````
Component / Data Display
# List
The most basic list display, which can carry text/pictures/paragraphs, and is often used in the data display page.
`````
%%Content%%
## API
%%Props%%
### `<ListGridProps>`
|Property|Description|Type|Default|
|---|:---:|:---:|---:|
|gutter|Spacing bet... | 4,550 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 数据展示
# 列表 List
最基础的列表展示，可承载文字、列表、图片、段落，常用于后台数据展示页面。
`````
%%Content%%
## API
%%Props%%
### `<ListGridProps>`
|参数名|描述|类型|默认值|
|---|:---:|:---:|---:|
|gutter|行间距|`number`|`-`|
|span|栅格占位格数|`number`|`-`|
|xs|`xs` 对应的栅格占位格数|`number`|`-`|
|sm|`sm` 对应的栅格占位格数|`number`|`-`|
|md|`md` 对... | 4,551 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('List');
| 4,552 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/__test__/index.test.tsx | import React, { useRef } from 'react';
import { render, fireEvent } from '../../../tests/util';
import { requestAnimationFrameMock } from '../../../tests/mockRAF';
import mountTest from '../../../tests/mountTest';
import componentConfigTest from '../../../tests/componentConfigTest';
import { ListHandle, ListProps } fro... | 4,553 |
0 | petrpan-code/arco-design/arco-design/components/List/__test__ | petrpan-code/arco-design/arco-design/components/List/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders List/demo/action-layout.md correctly 1`] = `
<div
class="arco-list-wrapper"
style="max-width:830px"
>
<div
class="arco-list arco-list-default arco-list-no-border list-demo-action-layout"
>
<div
class="arco-list-content"
role="list"... | 4,554 |
0 | petrpan-code/arco-design/arco-design/components/List/__test__ | petrpan-code/arco-design/arco-design/components/List/__test__/__snapshots__/index.test.tsx.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`ConfigProvider componentConfig.List default 1`] = `
<div
class="arco-list-wrapper"
>
<div
class="arco-list arco-list-default"
>
<div
class="arco-list-content"
role="list"
>
<div
class="arco-empty"
>
<div
... | 4,555 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/style/index.less | @import './token.less';
@list-prefix-cls: ~'@{prefix}-list';
.@{list-prefix-cls} {
display: flex;
flex-direction: column;
box-sizing: border-box;
width: 100%;
border-radius: @list-border-radius;
font-size: @list-font-size;
line-height: @list-line-height;
color: @list-color-text;
overflow-y: auto;
... | 4,556 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/style/index.ts | import '../../style/index.less';
import '../../Pagination/style';
import '../../Spin/style';
import '../../Grid/style';
import '../../Empty/style';
import './index.less';
| 4,557 |
0 | petrpan-code/arco-design/arco-design/components/List | petrpan-code/arco-design/arco-design/components/List/style/token.less | @import '../../style/theme/default.less';
@list-border-width: 1px;
@list-border-color: var(~'@{arco-cssvars-prefix}-color-neutral-3');
@list-border-radius: @radius-medium;
@list-color-text: var(~'@{arco-cssvars-prefix}-color-text-1');
@list-font-size: @font-size-body-3;
@list-line-height: @line-height-base;
@list-co... | 4,558 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Mentions/README.en-US.md | `````
Component / Data Entry
# Mentions
Mentions is used to mention someone or something in the input.
`````
%%Content%%
## API
### Mentions
|Property|Description|Type|DefaultValue|Version|
|---|---|---|---|---|
|alignTextarea|Whether the popup is aligned with the input|boolean |`true`|-|
|allowClear|Whether allo... | 4,559 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Mentions/README.zh-CN.md | `````
组件 / 数据输入
# 提及 Mentions
用于在输入中提及某人或某事，常用于发布、聊天或评论功能。
`````
%%Content%%
## API
### Mentions
|参数名|描述|类型|默认值|版本|
|---|---|---|---|---|
|alignTextarea|弹出框是否与输入框对齐|boolean |`true`|-|
|allowClear|允许清空输入框|boolean |`-`|2.2.0|
|disabled|是否禁用|boolean |`-`|-|
|error|是否是错误状态。(废弃，下个大版本移除，使用 status='error' 替代)|boolean |`... | 4,560 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Mentions/index.tsx | import React, { useContext, useEffect, useRef, useState } from 'react';
import cs from '../_util/classNames';
import { ConfigContext } from '../ConfigProvider';
import Input from '../Input';
import Select from '../Select';
import { MentionsProps } from './interface';
import { ArrowDown, ArrowUp, Enter, Esc } from '../_... | 4,561 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Mentions/interface.ts | import { ReactNode } from 'react';
import { TextAreaProps } from '../Input';
import { TriggerProps } from '../Trigger';
/**
* @title Mentions
*/
export interface MentionsProps extends Omit<TextAreaProps, 'prefix' | 'maxLength'> {
maxLength?: number;
children?: ReactNode;
/**
* @zh 输入框的值
* @en To set valu... | 4,562 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Mentions/utils.ts | import { MentionsProps } from './interface';
interface MeasureIndex {
location: number;
prefix: string;
}
export function isValidSearch(text: string, { split }: MentionsProps): boolean {
return !split || text.indexOf(split) === -1;
}
export function getBeforeSelectionText({ value, selectionStart }: HTMLTextAre... | 4,563 |
0 | petrpan-code/arco-design/arco-design/components/Mentions | petrpan-code/arco-design/arco-design/components/Mentions/__changelog__/index.en-US.md | ## 2.38.0
2022-07-29
### 🐛 BugFix
- Fix the position jitter when the `Mentions` dropdown popup appears.([#1222](https://github.com/arco-design/arco-design/pull/1222))
## 2.32.1
2022-04-22
### 🐛 BugFix
- Fixed `Mentions` component `notFoundContent` not taking effect.([#801](https://github.com/arco-design/arco-d... | 4,564 |
0 | petrpan-code/arco-design/arco-design/components/Mentions | petrpan-code/arco-design/arco-design/components/Mentions/__changelog__/index.zh-CN.md | ## 2.38.0
2022-07-29
### 🐛 问题修复
- 修复 `Mentions` 组件下拉弹窗出现时的位置抖动。([#1222](https://github.com/arco-design/arco-design/pull/1222))
## 2.32.1
2022-04-22
### 🐛 问题修复
- 修复 `Mentions` 组件 `notFoundContent` 不生效的问题。([#801](https://github.com/arco-design/arco-design/pull/801))
## 2.10.1
2021-03-05
### 🐛 Bugfix
- 修复 `M... | 4,565 |
0 | petrpan-code/arco-design/arco-design/components/Mentions | petrpan-code/arco-design/arco-design/components/Mentions/__demo__/basic.md | ---
order: 0
title:
zh-CN: 基础用法
en-US: Basic
---
## zh-CN
用于在输入中提及某人或某事，常用于发布、聊天或评论功能。
## en-US
Used to mention someone or something, often used for posting, chatting or commenting.
```js
import { Mentions } from '@arco-design/web-react';
const App = () => {
return (
<Mentions
style={{ width: 154 ... | 4,566 |
0 | petrpan-code/arco-design/arco-design/components/Mentions | petrpan-code/arco-design/arco-design/components/Mentions/__demo__/control.md | ---
order: 2
title:
zh-CN: 受控模式
en-US: Controlled
---
## zh-CN
`Mentions` 在 `Form` 中的使用。
## en-US
An example that `Mentions` is used with `Form`,
```js
import { Form, Input, Button, Mentions } from '@arco-design/web-react';
const FormItem = Form.Item;
function App() {
const onValuesChange = (changeValue, va... | 4,567 |
0 | petrpan-code/arco-design/arco-design/components/Mentions | petrpan-code/arco-design/arco-design/components/Mentions/__demo__/prefix.md | ---
order: 1
title:
zh-CN: 自定义触发字符
en-US: Custom Trigger Word
---
## zh-CN
指定 `prefix` 来自定义触发字符。默认为 `@`，可以自定义为任意字符。
## en-US
Specify `prefix` to customize the trigger character. The default is `@`, which can be customized to any character.
```js
import { Mentions, Space } from '@arco-design/web-react';
const ... | 4,568 |
0 | petrpan-code/arco-design/arco-design/components/Mentions | petrpan-code/arco-design/arco-design/components/Mentions/__demo__/status.md | ---
order: 3
title:
zh-CN: 无效或只读
en-US: Disabled & ReadOnly
---
## zh-CN
通过 `disabled` 设置是否禁用，通过 `readOnly` 属性设置是否只读。
## en-US
Set whether to be disabled via `disabled`, and set whether to be readonly via `readOnly` property.
```js
import { Mentions, Space } from '@arco-design/web-react';
const App = () => {
... | 4,569 |
0 | petrpan-code/arco-design/arco-design/components/Mentions | petrpan-code/arco-design/arco-design/components/Mentions/__template__/index.en-US.md | ---
file: interface
---
`````
Component / Data Entry
# Mentions
Mentions is used to mention someone or something in the input.
`````
%%Content%%
## API
%%Props%%
| 4,570 |
0 | petrpan-code/arco-design/arco-design/components/Mentions | petrpan-code/arco-design/arco-design/components/Mentions/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 数据输入
# 提及 Mentions
用于在输入中提及某人或某事，常用于发布、聊天或评论功能。
`````
%%Content%%
## API
%%Props%%
| 4,571 |
0 | petrpan-code/arco-design/arco-design/components/Mentions | petrpan-code/arco-design/arco-design/components/Mentions/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('Mentions');
| 4,572 |
0 | petrpan-code/arco-design/arco-design/components/Mentions | petrpan-code/arco-design/arco-design/components/Mentions/__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 Mentions from '..';
import { ArrowDown, Enter } from '../../_util/keycode';
mountTest(Mentions);
com... | 4,573 |
0 | petrpan-code/arco-design/arco-design/components/Mentions/__test__ | petrpan-code/arco-design/arco-design/components/Mentions/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders Mentions/demo/basic.md correctly 1`] = `
<div
class="arco-mentions arco-mentions-align-textarea"
style="width:154px"
>
<textarea
class="arco-textarea arco-mentions-textarea"
rows="1"
>
@Bytedance
</textarea>
<div
class="arco-mentio... | 4,574 |
0 | petrpan-code/arco-design/arco-design/components/Mentions/__test__ | petrpan-code/arco-design/arco-design/components/Mentions/__test__/__snapshots__/index.test.tsx.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`ConfigProvider componentConfig.Mentions default 1`] = `
<div
class="arco-mentions arco-mentions-align-textarea"
>
<textarea
class="arco-textarea arco-mentions-textarea"
rows="1"
/>
<div
class="arco-mentions-measure"
>
<span
class="arco... | 4,575 |
0 | petrpan-code/arco-design/arco-design/components/Mentions | petrpan-code/arco-design/arco-design/components/Mentions/style/index.less | @import './token.less';
@mentions-prefix-cls: ~'@{prefix}-mentions';
.@{mentions-prefix-cls} {
display: inline-block;
position: relative;
box-sizing: border-box;
width: 100%;
vertical-align: middle;
white-space: pre-wrap;
&-textarea,
&-measure {
padding: @mentions-padding-vertical @mentions-paddin... | 4,576 |
0 | petrpan-code/arco-design/arco-design/components/Mentions | petrpan-code/arco-design/arco-design/components/Mentions/style/index.ts | import '../../style/index.less';
import './index.less';
| 4,577 |
0 | petrpan-code/arco-design/arco-design/components/Mentions | petrpan-code/arco-design/arco-design/components/Mentions/style/token.less | @import '../../style/theme/default.less';
@mentions-padding-horizontal: @spacing-6;
@mentions-padding-vertical: @spacing-2;
@mentions-font-size: @font-size-body-3;
@mentions-line-height: @line-height-base;
| 4,578 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Menu/README.en-US.md | `````
Component / Navigation
# Menu
A component to organize, arrange, and display a list of options.
`````
%%Content%%
## API
### Menu
|Property|Description|Type|DefaultValue|Version|
|---|---|---|---|---|
|accordion|Whether to render as Accordion|boolean |`-`|-|
|autoOpen|Whether to expand all multi-level menus ... | 4,579 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Menu/README.zh-CN.md | `````
组件 / 导航
# 菜单 Menu
收纳、排列并展示一系列选项的列表。
`````
%%Content%%
## API
### Menu
|参数名|描述|类型|默认值|版本|
|---|---|---|---|---|
|accordion|开启手风琴效果|boolean |`-`|-|
|autoOpen|默认展开所有多级菜单|boolean |`-`|-|
|autoScrollIntoView|是否自动滚动选中项目到可见区域|boolean |`-`|-|
|collapse|是否水平折叠收起菜单|boolean |`-`|-|
|hasCollapseButton|是否内置折叠按钮|boolean ... | 4,580 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Menu/context.ts | import { createContext } from 'react';
import { MenuProps } from './interface';
export type HotkeyInfo = {
update: boolean;
activeKeyPath: string[];
type: 'sibling' | 'generation' | 'enter';
};
export type ResetHotkeyInfo = (activeKey?: string) => void;
const MenuContext = createContext<
Pick<
MenuProps,... | 4,581 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Menu/indent.tsx | import React, { useContext } from 'react';
import MenuContext from './context';
export default function MenuIndent(props: {
prefixCls: string;
level?: number;
levelIndent?: number;
}) {
const { prefixCls, levelIndent } = props;
const { collapse } = useContext(MenuContext);
const level = props.level - 1;
... | 4,582 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Menu/index.tsx | import React, { useEffect, useContext, ReactNode, forwardRef, useRef, useMemo } from 'react';
import cs from '../_util/classNames';
import Item from './item';
import ItemGroup from './item-group';
import SubMenu from './sub-menu';
import OverflowWrap from './overflow-wrap';
import omit from '../_util/omit';
import { ge... | 4,583 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Menu/interface.tsx | import React, { ReactNode, CSSProperties, HTMLAttributes } from 'react';
import { TriggerProps } from '../Trigger';
import { TooltipProps } from '../Tooltip';
/**
* @title Menu
*/
export interface MenuProps extends Omit<HTMLAttributes<HTMLDivElement>, 'className'> {
children?: ReactNode;
style?: CSSProperties;
... | 4,584 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Menu/item-group.tsx | import React, { forwardRef, ReactNode, useContext } from 'react';
import cs from '../_util/classNames';
import { processChildren } from './util';
import { MenuItemGroupProps } from './interface';
import MenuContext from './context';
import MenuIndent from './indent';
function ItemGroup(props: MenuItemGroupProps, ref) ... | 4,585 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Menu/item.tsx | import React, { forwardRef, useContext, useEffect, useRef } from 'react';
import scrollIntoView from 'scroll-into-view-if-needed';
import cs from '../_util/classNames';
import Tooltip from '../Tooltip';
import { MenuItemProps } from './interface';
import useIsFirstRender from '../_util/hooks/useIsFirstRender';
import M... | 4,586 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Menu/overflow-wrap.tsx | import React, { useState, useRef, useContext, ReactElement, ReactNode } from 'react';
import SubMenu from './sub-menu';
import { getStyle } from '../_util/style';
import MenuContext from './context';
import ResizeObserver from '../_util/resizeObserver';
const OVERFLOW_THRESHOLD = 5;
function getNodeWidth(node) {
//... | 4,587 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Menu/util.ts | import React, { ReactElement } from 'react';
export type MenuInfo = {
keyPath: string[];
prev: string;
next: string;
firstChild?: string;
lastChild?: string;
disabled?: boolean;
};
export const PROPS_NEED_TO_BE_PASSED_IN_SUBMENU = ['popup', 'triggerProps', 'selectable'];
// Expand MenuGroup to get an arr... | 4,588 |
0 | petrpan-code/arco-design/arco-design/components/Menu | petrpan-code/arco-design/arco-design/components/Menu/__changelog__/index.en-US.md | ## 2.52.2
2023-09-01
### 🐛 BugFix
- Fix the location of the collapse button in the `rtl` mode of the `Menu` component([#2201](https://github.com/arco-design/arco-design/pull/2201))
## 2.51.2
2023-08-11
### 🐛 BugFix
- Fix the problem that `Popover` is reported as a direct child node of `Menu`.([#2138](https://g... | 4,589 |
0 | petrpan-code/arco-design/arco-design/components/Menu | petrpan-code/arco-design/arco-design/components/Menu/__changelog__/index.zh-CN.md | ## 2.52.2
2023-09-01
### 🐛 问题修复
- 修复 `Menu` 组件 `rtl` 模式下折叠按钮的位置问题。([#2201](https://github.com/arco-design/arco-design/pull/2201))
## 2.51.2
2023-08-11
### 🐛 问题修复
- 修复 `Popover` 作为 `Menu` 直接子节点报错的问题。([#2138](https://github.com/arco-design/arco-design/pull/2138))
## 2.51.0
2023-07-28
### 🆕 功能升级
- `Menu.Item... | 4,590 |
0 | petrpan-code/arco-design/arco-design/components/Menu | petrpan-code/arco-design/arco-design/components/Menu/__demo__/button.md | ---
order: 6
title:
zh-CN: 悬浮按钮菜单
en-US: Floating Button Menu
---
## zh-CN
指定 `mode` 为 `popButton` 使用按钮组样式的悬浮菜单。
## en-US
By setting `mode` to `popButton`, you can use a button group style floating menu.
```js
import { useState } from 'react';
import { Menu, Trigger } from '@arco-design/web-react';
import { Ic... | 4,591 |
0 | petrpan-code/arco-design/arco-design/components/Menu | petrpan-code/arco-design/arco-design/components/Menu/__demo__/collapse-control.md | ---
order: 2
title:
zh-CN: 缩起内嵌菜单
en-US: Collapsed Menu
---
## zh-CN
通过 `collapse` 来指定菜单收起。通过 `renderItemInTooltip` 指定菜单收起时，`Tooltip` 中展示的菜单项内容。
## en-US
Use `collapse` to specify the menu to collapse. Use `renderItemInTooltip` to specify the content of the menu item displayed in `Tooltip` when the menu is coll... | 4,592 |
0 | petrpan-code/arco-design/arco-design/components/Menu | petrpan-code/arco-design/arco-design/components/Menu/__demo__/dark-horizontal.md | ---
order: 1
title:
zh-CN: 深色模式导航
en-US: Dark Theme
---
## zh-CN
通过 `theme` 指定主题，分为 `light` 和 `dark` 两种。
## en-US
The theme is specified by `theme`, which can be divided into two types: `light` and `dark`.
```js
import { Menu } from '@arco-design/web-react';
const MenuItem = Menu.Item;
const SubMenu = Menu.Sub... | 4,593 |
0 | petrpan-code/arco-design/arco-design/components/Menu | petrpan-code/arco-design/arco-design/components/Menu/__demo__/horizontal.md | ---
order: 0
title:
zh-CN: 顶部导航菜单
en-US: Horizontal
---
## zh-CN
设置 `mode` 为 `horizontal` 时，使用水平菜单。
## en-US
By setting `mode` to `horizontal`, you can use the horizontal menu.
```js
import { Menu } from '@arco-design/web-react';
const MenuItem = Menu.Item;
const SubMenu = Menu.SubMenu;
function App() {
ret... | 4,594 |
0 | petrpan-code/arco-design/arco-design/components/Menu | petrpan-code/arco-design/arco-design/components/Menu/__demo__/pop.md | ---
order: 5
title:
zh-CN: 悬浮菜单
en-US: Floating Menu
---
## zh-CN
指定 `mode` 为 `pop` 可以使用悬浮菜单。
## en-US
Specify `mode` as `pop` to use floating menu.
```js
import { Menu } from '@arco-design/web-react';
import { IconApps, IconSafe, IconBulb, IconRobot, IconFire } from '@arco-design/web-react/icon';
const MenuIt... | 4,595 |
0 | petrpan-code/arco-design/arco-design/components/Menu | petrpan-code/arco-design/arco-design/components/Menu/__demo__/size.md | ---
order: 4
title:
zh-CN: 不同大小菜单
en-US: Custom Size
---
## zh-CN
通过 `style` 自由指定菜单的宽度和菜单项的高度。
## en-US
Freely specify width of menu and height of menu item through `style`.
```js
import { useState } from 'react';
import { Menu, Slider } from '@arco-design/web-react';
import { IconApps, IconBug, IconBulb } fro... | 4,596 |
0 | petrpan-code/arco-design/arco-design/components/Menu | petrpan-code/arco-design/arco-design/components/Menu/__demo__/sub-menu.md | ---
order: 3
title:
zh-CN: 内嵌菜单
en-US: Sub Menu
---
## zh-CN
菜单内可以嵌入多个子项，通过 `defaultOpenKeys` 可以设置默认打开的子项。
## en-US
Multiple sub-items can be embedded in the menu, and the items that are opened by default can be set through `defaultOpenKeys`.
```js
import { Menu } from '@arco-design/web-react';
import { IconAp... | 4,597 |
0 | petrpan-code/arco-design/arco-design/components/Menu | petrpan-code/arco-design/arco-design/components/Menu/__template__/index.en-US.md | ---
file: interface
---
`````
Component / Navigation
# Menu
A component to organize, arrange, and display a list of options.
`````
%%Content%%
## API
%%Props%%
| 4,598 |
0 | petrpan-code/arco-design/arco-design/components/Menu | petrpan-code/arco-design/arco-design/components/Menu/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 导航
# 菜单 Menu
收纳、排列并展示一系列选项的列表。
`````
%%Content%%
## API
%%Props%%
| 4,599 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.