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/petyosi/react-virtuoso | petrpan-code/petyosi/react-virtuoso/test/ssr.test.tsx | /**
* @jest-environment node
*/
import React from 'react'
import ReactDOMServer from 'react-dom/server'
import { JSDOM } from 'jsdom'
import { Virtuoso, GroupedVirtuoso } from '../src/Virtuoso'
import { VirtuosoGrid } from '../src/VirtuosoGrid'
import { describe, it, expect } from 'vitest'
describe('SSR List', () =>... | 3,600 |
0 | petrpan-code/petyosi/react-virtuoso | petrpan-code/petyosi/react-virtuoso/test/tsconfig.json | {
"extends": "../tsconfig.json",
"include": [
"./"
],
"compilerOptions": {
"rootDirs": [
"./",
"../src"
]
}
}
| 3,601 |
0 | petrpan-code/petyosi/react-virtuoso | petrpan-code/petyosi/react-virtuoso/test/windowScrollerSystem.test.ts | import * as u from '../src/urx'
import { listSystem } from '../src/listSystem'
import { describe, it, expect, vi } from 'vitest'
describe('window scroller system', () => {
it('offsets the window scroll top with the element offset top', () => {
const { windowViewportRect, scrollTop, windowScrollContainerState } =... | 3,602 |
0 | petrpan-code/petyosi/react-virtuoso/test | petrpan-code/petyosi/react-virtuoso/test/__snapshots__/VirtuosoMockContext.test.tsx.snap | // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
exports[`VirtuosoMockContext > Grid > correctly renders items 1`] = `
<div>
<div
data-test-id="virtuoso-scroller"
data-virtuoso-scroller="true"
style="height: 100%; outline: none; overflow-y: auto; position: relative;"
tabindex="0"
>
... | 3,603 |
0 | petrpan-code/petyosi/react-virtuoso/test | petrpan-code/petyosi/react-virtuoso/test/react-urx/index.test.tsx | /* eslint-disable react/display-name */
import * as React from 'react'
import { createRef, FC } from 'react'
import { createRoot, Root } from 'react-dom/client'
import { act } from 'react-dom/test-utils'
import {
combineLatest,
connect,
system,
map,
pipe,
statefulStream,
statefulStreamFromEmitter,
stre... | 3,604 |
0 | petrpan-code/petyosi/react-virtuoso/test | petrpan-code/petyosi/react-virtuoso/test/react-urx/ssr.test.tsx | /**
* @jest-environment node
*/
import { connect, statefulStream, stream, system } from '../../src/urx'
import { JSDOM } from 'jsdom'
import * as React from 'react'
import ReactDOMServer from 'react-dom/server'
import { systemToComponent } from '../../src/react-urx'
import { describe, it, expect } from 'vitest'
cons... | 3,605 |
0 | petrpan-code/petyosi/react-virtuoso/test | petrpan-code/petyosi/react-virtuoso/test/urx/actions.test.ts | import { map, handleNext, statefulStream, connect, pipe, publish, subscribe, stream } from '../../src/urx'
import { describe, it, expect, vi } from 'vitest'
describe('connect', () => {
it('subscribes a publisher to the emitter', () => {
const a = stream<number>()
const b = stream<number>()
connect(a, b)... | 3,606 |
0 | petrpan-code/petyosi/react-virtuoso/test | petrpan-code/petyosi/react-virtuoso/test/urx/combineLatest.test.ts | import { combineLatest, statefulStream, subscribe, stream, publish } from '../../src/urx'
import { describe, it, expect, vi } from 'vitest'
describe('combine latest', () => {
it('combines the provided streams', () => {
const foo = statefulStream('foo')
const bar = statefulStream('bar')
const spy = vi.fn... | 3,607 |
0 | petrpan-code/petyosi/react-virtuoso/test | petrpan-code/petyosi/react-virtuoso/test/urx/eventHandler.test.ts | import { eventHandler, publish, reset, stream, subscribe, statefulStream } from '../../src/urx'
import { describe, it, expect, vi } from 'vitest'
describe('event handler', () => {
it('creates a single handler subscriber for a stream', () => {
const str = stream<number>()
const handler = eventHandler(str)
... | 3,608 |
0 | petrpan-code/petyosi/react-virtuoso/test | petrpan-code/petyosi/react-virtuoso/test/urx/merge.test.ts | import { merge, stream, publish, subscribe } from '../../src/urx'
import { describe, it, expect, vi } from 'vitest'
describe('merge', () => {
it('emits values from both emitters', () => {
const stream1 = stream<number>()
const stream2 = stream<number>()
const result = merge(stream1, stream2)
const su... | 3,609 |
0 | petrpan-code/petyosi/react-virtuoso/test | petrpan-code/petyosi/react-virtuoso/test/urx/operators.test.ts | import {
filter,
map,
mapTo,
pipe,
scan,
withLatestFrom,
skip,
distinctUntilChanged,
debounceTime,
statefulStream,
publish,
stream,
subscribe,
} from '../../src/urx'
import { describe, it, expect, vi } from 'vitest'
describe('pipe', () => {
it('map transforms the output', () => {
const ... | 3,610 |
0 | petrpan-code/petyosi/react-virtuoso/test | petrpan-code/petyosi/react-virtuoso/test/urx/statefulStream.test.ts | import { getValue, statefulStream, subscribe } from '../../src/urx'
import { describe, it, expect, vi } from 'vitest'
describe('behavior stream', () => {
it('creates a next / subscribe function', () => {
const foo = statefulStream(5)
const callback = vi.fn()
subscribe(foo, callback)
expect(callback).... | 3,611 |
0 | petrpan-code/petyosi/react-virtuoso/test | petrpan-code/petyosi/react-virtuoso/test/urx/stream.test.ts | import { subscribe, stream, publish } from '../../src/urx'
import { describe, it, expect, vi } from 'vitest'
describe('stream', () => {
it('creates a next / subscribe function', () => {
const foo = stream<number>()
const callback = vi.fn()
subscribe(foo, callback)
publish(foo, 4)
expect(callback)... | 3,612 |
0 | petrpan-code/petyosi/react-virtuoso/test | petrpan-code/petyosi/react-virtuoso/test/urx/system.test.ts | import { system, init, statefulStream, tup } from '../../src/urx'
import { describe, it, expect } from 'vitest'
describe('system', () => {
it('run executes the factory', () => {
const a = statefulStream(0)
const eng = system(() => {
return { a }
})
const sys = init(eng)
expect(sys).toMatc... | 3,613 |
0 | petrpan-code/petyosi/react-virtuoso/test | petrpan-code/petyosi/react-virtuoso/test/urx/utils.test.ts | import { call, joinProc } from '../../src/urx'
import { describe, it, expect, vi } from 'vitest'
describe('utils', () => {
describe('call', () => {
it('calls the argument', () => {
const proc = vi.fn()
call(proc)
expect(proc).toHaveBeenCalledTimes(1)
})
})
describe('joinProc', () => {
... | 3,614 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/.browserslistrc | chrome 49
edge 16
firefox 31
safari 10
opera 36 | 3,615 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/.editorconfig | root = true
[*]
charset = utf-8
end_of_line = lf
indent_style = space
indent_size = 2
insert_final_newline = true
max_line_length = 100
trim_trailing_whitespace = true
| 3,616 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/.eslintignore | icon/index.js
icon/index.es.js
icon/demo.js
icon/index.d.ts
stories/**/*.jsx
*.json
react-icon/
react-icon-cjs/
| 3,617 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/.eslintrc | {
"root": true,
"env": {
"browser": true,
"commonjs": true,
"es6": true,
"node": true,
"jest": true
},
"parser": "@typescript-eslint/parser",
"extends": [
"airbnb",
"plugin:react/recommended",
"plugin:prettier/recommended",
"plugin:react-hooks/recommended"
],
"parserOpt... | 3,618 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/.prettierignore | components/index.tsx
*.md
!**/demo/*.md
| 3,619 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/.prettierrc | {
"arrowParens": "always",
"semi": true,
"singleQuote": true,
"jsxSingleQuote": false,
"printWidth": 100,
"useTabs": false,
"tabWidth": 2,
"trailingComma": "es5"
}
| 3,620 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/.stylelintignore | components/style/theme/color
*.tsx
*.ts
*.md
| 3,621 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/.stylelintrc | {
"extends": ["stylelint-config-standard", "stylelint-config-prettier"],
"customSyntax": "postcss-less",
"rules": {
"no-descending-specificity": null,
"no-duplicate-selectors": null,
"font-family-no-missing-generic-family-keyword": null,
"block-opening-brace-space-before": "always",
"declarati... | 3,622 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/CODE_OF_CONDUCT.md | # Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex ch... | 3,623 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/CONTRIBUTING.md |
> English | [简体中文](./CONTRIBUTING.zh-CN.md)
# Contributing
Thank you for taking your time to contribute and make this project better! Here are some guidelines to help you get started. Please make sure to take a moment and read through them before submitting your contributions.
## Code of Conduct
This project is gov... | 3,624 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/CONTRIBUTING.zh-CN.md |
> [English](./CONTRIBUTING.md) | 简体中文
# 贡献指南
感谢你的宝贵时间。你的贡献将使这个项目变得更好！在提交贡献之前，请务必花点时间阅读下面的入门指南。
## 行为准则
该项目有一份 [行为准则](./CODE_OF_CONDUCT.md)，希望参与项目的贡献者都能严格遵守。
## 透明的开发
所有工作都直接透明地在 GitHub 上进行。核心团队成员和外部贡献者的 pull requests 都需要经过相同的 review 流程。
## 语义化版本
该项目遵循语义化版本。我们对重要的漏洞修复发布修订号，对新特性或不重要的变更发布次版本号，对重大且不兼容的变更发布主版本号。
每... | 3,625 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/LICENSE | MIT License
Copyright (c) 2021 Bytedance, Inc. and its affiliates.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modif... | 3,626 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/README.md | <div align="center">
<a href="https://arco.design" target="_blank">
<img alt="Arco Design Logo" width="200" src="https://avatars.githubusercontent.com/u/64576149?s=200&v=4"/>
</a>
</div>
<div align="center">
<h1>Arco Design</h1>
</div>
<div align="center">
A comprehensive React UI components library based o... | 3,627 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/README.zh-CN.md | <div align="center">
<a href="https://arco.design" target="_blank">
<img alt="Arco Design Logo" width="200" src="https://avatars.githubusercontent.com/u/64576149?s=200&v=4"/>
</a>
</div>
<div align="center">
<h1>Arco Design</h1>
</div>
<div align="center">
基于 [Arco Design](https://arco.design/) 的 React UI ... | 3,628 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/netlify.toml | [[redirects]]
from = "/*"
to = "/index.html"
status = 200
| 3,629 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/package.json | {
"name": "@arco-design/web-react",
"version": "2.56.0",
"description": "Arco Design React UI Library.",
"module": "./es/index.js",
"main": "./lib/index.js",
"unpkg": "./dist/arco.min.js",
"types": "./es/index.d.ts",
"scripts": {
"prepublishOnly": "yarn generate-version && yarn icon && yarn build",
... | 3,630 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/tsconfig.json | {
"compilerOptions": {
"outDir": "es",
"jsx": "react",
"module": "es6",
"target": "es5",
"lib": ["es5", "dom"],
"moduleResolution": "node",
"declaration": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"skipLibCheck": true,
"esModuleInterop": true,
"downlevel... | 3,631 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/tsdoc.json | {
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"tagDefinitions": [
{
"tagName": "@zh",
"syntaxKind": "modifier"
},
{
"tagName": "@en",
"syntaxKind": "modifier"
},
{
"tagName": "@title",
"syntaxKind": "modifier"
},
... | 3,632 |
0 | petrpan-code/arco-design | petrpan-code/arco-design/arco-design/yarn.lock | # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
# yarn lockfile v1
"@arco-design/color@^0.4.0":
version "0.4.0"
resolved "https://registry.yarnpkg.com/@arco-design/color/-/color-0.4.0.tgz#52ddb40d318ee6df1057ca8c653cc1675023928f"
integrity sha512-s7p9MSwJgHeL8DwcATaXvWT3m2SigKpxx4JA1BGPHL4gfvaQ... | 3,633 |
0 | petrpan-code/arco-design/arco-design | petrpan-code/arco-design/arco-design/.codesandbox/ci.json | {
"installCommand": "init",
"buildCommand": "build",
"sandboxes": ["arco-react-pr-template-jyk795"],
"node": "16"
}
| 3,634 |
0 | petrpan-code/arco-design/arco-design | petrpan-code/arco-design/arco-design/.config/docgen.config.js | module.exports = (config) => {
config.languages = ['zh-CN', 'en-US'];
config.template = '__template__/index.[language].md';
config.outputFileName = 'README.[language].md';
config.tsParseTool = [
'ts-document',
{
strictComment: true,
linkFormatter: ({ typeName, jsDocTitle, fullPath }) => {
... | 3,635 |
0 | petrpan-code/arco-design/arco-design | petrpan-code/arco-design/arco-design/.config/jest.config.js | // Custom Jest config
const BASE_JEST_CONFIG = {
// Find component demos' dependencies from /site/node_modules
modulePaths: ['<rootDir>/site/node_modules'],
moduleNameMapper: {
'^@arco-design/web-react/(.+)$': '<rootDir>/$1',
'^@arco-design/web-react$': '<rootDir>',
'^test-utils$': '<rootDir>/tests/u... | 3,636 |
0 | petrpan-code/arco-design/arco-design | petrpan-code/arco-design/arco-design/.config/style.config.js | module.exports = function StyleConfig(config) {
config.less.cssJsEntry = ['components/**/style/index.ts'];
config.less.output.dist.cssFileName = 'arco.min.css';
config.less.watch = [
'components/**/*.{less,woff,woff2,png,jpg}',
'components/style/theme/color/*.js',
];
config.less.watchBase = {
['co... | 3,637 |
0 | petrpan-code/arco-design/arco-design | petrpan-code/arco-design/arco-design/.config/webpack.config.js | // 自定义 webpack 构建配置
const path = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const webpack = require('webpack');
const { version } = require('../package.json');
// const { getPWAConfig } = require('../site/config/pwa');
// 组件 dist 打包
exports.component = (config) => {
config.entry = pat... | 3,638 |
0 | petrpan-code/arco-design/arco-design | petrpan-code/arco-design/arco-design/.husky/pre-commit | #!/bin/sh
. "$(dirname "$0")/_/husky.sh"
npm run pre-commit
| 3,639 |
0 | petrpan-code/arco-design/arco-design | petrpan-code/arco-design/arco-design/.storybook/index.less | html,
body,
#root {
width: 100%;
height: 100%;
margin: 0;
}
#root {
padding: 20px;
box-sizing: border-box;
}
@dark: #00a0e9;
@light: rgba(0, 160, 233, 0.7);
.story-grid-wrapper {
.dark,
.light {
height: 120px;
line-height: 120px;
color: #fff;
text-align: center;
// overflow: hidden;
... | 3,640 |
0 | petrpan-code/arco-design/arco-design | petrpan-code/arco-design/arco-design/.storybook/main.js | const path = require('path');
const lessRegex = /\.less$/;
const lessModuleRegex = /\.module\.less$/;
function getLoaderForStyle(isCssModule) {
return [
{
loader: 'style-loader',
},
{
loader: 'css-loader',
options: isCssModule ? { modules: true } : {},
},
{
loader: 'less-... | 3,641 |
0 | petrpan-code/arco-design/arco-design | petrpan-code/arco-design/arco-design/.storybook/preview.js | import '../dist/css/index.less';
import './index.less';
export const parameters = {
actions: { argTypesRegex: '^on[A-Z].*' },
};
| 3,642 |
0 | petrpan-code/arco-design/arco-design | petrpan-code/arco-design/arco-design/components/index.tsx | export type { AlertProps } from './Alert/interface';
export { default as Alert } from './Alert';
export type { AnchorProps, AnchorLinkProps } from './Anchor/interface';
export { default as Anchor } from './Anchor';
export type { AffixProps } from './Affix/interface';
export { default as Affix } from './Affix';
expor... | 3,643 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Affix/README.en-US.md | `````
Component / Other
# Affix
Pin the elements to the visible range. When the content area is relatively long and the page needs to scroll, the Affix can fix the element on the screen. Often used for side menu and button group.
`````
%%Content%%
## API
### Affix
|Property|Description|Type|DefaultValue|Version|
... | 3,644 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Affix/README.zh-CN.md | `````
组件 / 其他
# 固钉 Affix
将页面元素钉在可视范围。当内容区域比较长，需要滚动页面时，固钉可以将内容固定在屏幕上。常用于侧边菜单和按钮组合。
`````
%%Content%%
## API
### Affix
|参数名|描述|类型|默认值|版本|
|---|---|---|---|---|
|offsetBottom|距离窗口底部达到指定偏移量后触发|number |`-`|-|
|offsetTop|距离窗口顶部达到指定偏移量后触发|number |`0`|-|
|affixClassName|给 `fixed` 的元素设置 className。|string \| string[] |`-`|... | 3,645 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Affix/index.tsx | import React, {
CSSProperties,
forwardRef,
useRef,
useImperativeHandle,
useContext,
PropsWithChildren,
useState,
useEffect,
useCallback,
} from 'react';
import throttleByRaf from '../_util/throttleByRaf';
import cs from '../_util/classNames';
import { ConfigContext } from '../ConfigProvider';
import {... | 3,646 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Affix/interface.ts | import { CSSProperties } from 'react';
/**
* @title Affix
*/
export interface AffixProps {
className?: string | string[];
style?: CSSProperties;
/**
* @zh 给 `fixed` 的元素设置 className。
* @en ClassName of the fixed element.
* @version 2.8.0
*/
affixClassName?: string | string[];
/**
* @zh
* 给... | 3,647 |
0 | petrpan-code/arco-design/arco-design/components/Affix | petrpan-code/arco-design/arco-design/components/Affix/__changelog__/index.en-US.md | ## 2.31.2
2022-04-01
### 🐛 BugFix
- Fix the bug that resizeObserver will report an error when the children of Affix is invalid.([#726](https://github.com/arco-design/arco-design/pull/726))
## 2.20.2
2021-08-09
### 🐛 Bugfix
- Fix the bug that the `onChange` callback of the `Affix` component is triggered frequen... | 3,648 |
0 | petrpan-code/arco-design/arco-design/components/Affix | petrpan-code/arco-design/arco-design/components/Affix/__changelog__/index.zh-CN.md | ## 2.31.2
2022-04-01
### 🐛 问题修复
- 修复 `Affix` 子元素不合法时 `ResizeObserver`会报错的bug([#726](https://github.com/arco-design/arco-design/pull/726))
## 2.20.2
2021-08-09
### 🐛 Bugfix
- 修复 `Affix` 组件的 `onChange` 回调被频繁触发的 bug。
## 2.20.1
2021-08-06
### 🐛 Bugfix
- 修复 `Affix` 组件在 `fixed` 状态下更新内容或者修改参数位置没有更新的 bug。
## 2.1... | 3,649 |
0 | petrpan-code/arco-design/arco-design/components/Affix | petrpan-code/arco-design/arco-design/components/Affix/__demo__/basic.md | ---
order: 0
title:
zh-CN: 基本用法
en-US: Basic
---
## zh-CN
基本用法，不设置固定位置时，当页面滚动元素不可见时，元素固定在页面最顶部。
## en-US
Basic usage. If the fixed position is not set, the element will be fixed at the top of the page when it scrolls outside the page.
```js
import { Affix, Button } from '@arco-design/web-react';
const App = (... | 3,650 |
0 | petrpan-code/arco-design/arco-design/components/Affix | petrpan-code/arco-design/arco-design/components/Affix/__demo__/bottom.md | ---
order: 2
title:
zh-CN: 底部固定
en-US: Fixed Bottom
---
## zh-CN
元素向下滚动到距底部一定距离时固定。
## en-US
The element will be fixed when it scrolls down to a certain distance from the bottom of the viewport.
```js
import { Affix, Button } from '@arco-design/web-react';
const App = () => {
return (
<Affix offsetBotto... | 3,651 |
0 | petrpan-code/arco-design/arco-design/components/Affix | petrpan-code/arco-design/arco-design/components/Affix/__demo__/container.md | ---
order: 4
title:
zh-CN: 滚动容器
en-US: Container
---
## zh-CN
用 `target` 设置需要监听其滚动事件的元素，默认为 `window`。
`target` 指定为非 window 容器时，可能会出现 `target` 外层元素滚动，固钉元素跑出滚动容器的问题。这个时候可以通过传入 `targetContainer` 设置 `target` 外层的滚动元素。`Affix` 会监听该元素的滚动事件来实时更新滚钉元素的位置。也可以在业务代码中自己监听 `target` 外层滚动元素的 `scroll` 事件，并调用 `this.affixRef.updateP... | 3,652 |
0 | petrpan-code/arco-design/arco-design/components/Affix | petrpan-code/arco-design/arco-design/components/Affix/__demo__/fixChange.md | ---
order: 3
title:
zh-CN: 固定状态改变回调
en-US: Callback
---
## zh-CN
当固定状态发生改变时，会触发事件。
## en-US
Callback when the fixed state changes.
```js
import { Affix, Button, Message } from '@arco-design/web-react';
const App = () => {
return (
<Affix
offsetBottom={80}
onChange={(fixed) => {
Messa... | 3,653 |
0 | petrpan-code/arco-design/arco-design/components/Affix | petrpan-code/arco-design/arco-design/components/Affix/__demo__/top.md | ---
order: 1
title:
zh-CN: 顶部固定
en-US: Fixed Top
---
## zh-CN
元素向上滚动到距顶部一定距离时固定。
## en-US
The element will be fixed when it scrolls down to a certain distance from the top of the viewport.
```js
import { Affix, Button } from '@arco-design/web-react';
const App = () => {
return (
<Affix offsetTop={80}>
... | 3,654 |
0 | petrpan-code/arco-design/arco-design/components/Affix | petrpan-code/arco-design/arco-design/components/Affix/__template__/index.en-US.md | ---
file: interface
---
`````
Component / Other
# Affix
Pin the elements to the visible range. When the content area is relatively long and the page needs to scroll, the Affix can fix the element on the screen. Often used for side menu and button group.
`````
%%Content%%
## API
%%Props%%
| 3,655 |
0 | petrpan-code/arco-design/arco-design/components/Affix | petrpan-code/arco-design/arco-design/components/Affix/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 其他
# 固钉 Affix
将页面元素钉在可视范围。当内容区域比较长，需要滚动页面时，固钉可以将内容固定在屏幕上。常用于侧边菜单和按钮组合。
`````
%%Content%%
## API
%%Props%%
| 3,656 |
0 | petrpan-code/arco-design/arco-design/components/Affix | petrpan-code/arco-design/arco-design/components/Affix/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('Affix');
| 3,657 |
0 | petrpan-code/arco-design/arco-design/components/Affix | petrpan-code/arco-design/arco-design/components/Affix/__test__/index.test.tsx | import React from 'react';
import { sleep, render } from '../../../tests/util';
import mountTest from '../../../tests/mountTest';
import componentConfigTest from '../../../tests/componentConfigTest';
import Affix from '..';
import Button from '../../Button';
mountTest(Affix);
componentConfigTest(Affix, 'Affix');
cons... | 3,658 |
0 | petrpan-code/arco-design/arco-design/components/Affix/__test__ | petrpan-code/arco-design/arco-design/components/Affix/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders Affix/demo/basic.md correctly 1`] = `
<div
class=""
>
<div
class=""
>
<button
class="arco-btn arco-btn-primary arco-btn-size-default arco-btn-shape-square"
type="button"
>
<span>
Affix Top
</span>
</button... | 3,659 |
0 | petrpan-code/arco-design/arco-design/components/Affix/__test__ | petrpan-code/arco-design/arco-design/components/Affix/__test__/__snapshots__/index.test.tsx.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`ConfigProvider componentConfig.Affix default 1`] = `
<div
class=""
>
<div
class=""
>
<span />
</div>
</div>
`;
exports[`ConfigProvider componentConfig.Affix set className globally 1`] = `
<div
class="global-default-class"
>
<div
class=""
>
... | 3,660 |
0 | petrpan-code/arco-design/arco-design/components/Affix | petrpan-code/arco-design/arco-design/components/Affix/style/index.less | @import '../../style/theme/default.less';
@affix-prefix-cls: ~'@{prefix}-affix';
.@{affix-prefix-cls} {
position: fixed;
z-index: @z-index-affix;
}
| 3,661 |
0 | petrpan-code/arco-design/arco-design/components/Affix | petrpan-code/arco-design/arco-design/components/Affix/style/index.ts | import '../../style/index.less';
import './index.less';
| 3,662 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Alert/README.en-US.md | `````
Component / Feedback
# Alert
Used to display warning information in a way that attracts attention.
`````
%%Content%%
## API
### Alert
|Property|Description|Type|DefaultValue|
|---|---|---|---|
|banner|Whether to show as banner|boolean |`-`|
|closable|Whether Alert can be closed|boolean |`-`|
|showIcon|Wheth... | 3,663 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Alert/README.zh-CN.md | `````
组件 / 反馈
# 警告提示 Alert
向用户显示警告的信息时，通过警告提示，展现需要关注的信息。
`````
%%Content%%
## API
### Alert
|参数名|描述|类型|默认值|
|---|---|---|---|
|banner|是否用作顶部公告|boolean |`-`|
|closable|是否可关闭|boolean |`-`|
|showIcon|是否显示图标|boolean |`true`|
|type|警告的类型|'info' \| 'success' \| 'warning' \| 'error' |`info`|
|action|自定义操作项|ReactNode |`-... | 3,664 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Alert/index.tsx | import React, { useState, useContext, ReactNode, forwardRef } from 'react';
import { CSSTransition } from 'react-transition-group';
import IconCheckCircleFill from '../../icon/react-icon/IconCheckCircleFill';
import IconCloseCircleFill from '../../icon/react-icon/IconCloseCircleFill';
import IconInfoCircleFill from '..... | 3,665 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Alert/interface.ts | import { CSSProperties, ReactNode } from 'react';
/**
* @title Alert
*/
export interface AlertProps {
style?: CSSProperties;
className?: string | string[];
/**
* @zh 自定义操作项
* @en Custom action item
*/
action?: ReactNode;
/**
* @zh 是否可关闭
* @en Whether Alert can be closed
*/
closable?: bo... | 3,666 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__changelog__/index.en-US.md | ## 2.38.0
2022-07-29
### 🐛 BugFix
- Fixed a bug where clicking the close button of an `Alert` component accidentally triggered the `submit` event of an external `form`.([#1205](https://github.com/arco-design/arco-design/pull/1205))
## 2.20.0
2021-07-30
### 🆎 TypeScript
- Modify the TS definition of the `title`... | 3,667 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__changelog__/index.zh-CN.md | ## 2.38.0
2022-07-29
### 🐛 问题修复
- 修复点击 `Alert` 组件的关闭按钮误触外部 `form` 的 `submit` 事件的 bug。([#1205](https://github.com/arco-design/arco-design/pull/1205))
## 2.20.0
2021-07-30
### 🆎 TypeScript
- 修改 `Alert` 组件 `title` 属性的 TS 定义。
## 2.11.0
2021-03-12
### 🆕 Feature
- `Alert` 组件支持 `action` 定制操作项。
| 3,668 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__demo__/action.md | ---
order: 7
title:
zh-CN: 操作项
en-US: Action
---
## zh-CN
通过 `action` 可以自定义右上角操作项。
## en-US
Customize the action items through `action`.
```js
import { Alert, Button, Space } from '@arco-design/web-react';
const App = () => {
return (
<div>
<Alert
content="Here is an example text"
... | 3,669 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__demo__/banner.md | ---
order: 6
title:
zh-CN: 顶部公告
en-US: Top Banner
browser: true
---
## zh-CN
设置 `banner = true`，可以当作顶部公告使用。
## en-US
Use `banner = true` to display Alert as a banner on top of the page.
```js
import { Alert } from '@arco-design/web-react';
const App = () => {
return (
<div>
<Alert
banner
... | 3,670 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__demo__/basic.md | ---
order: 0
title:
zh-CN: 基本用法
en-US: Basic
---
## zh-CN
警告提示，展现需要关注的信息，适用于简短的警告提示。
## en-US
Warning prompts. Suitable for displaying short warning prompts in a way that attracts attention.
```js
import { Alert } from '@arco-design/web-react';
const App = () => {
return <Alert content="Here is an example t... | 3,671 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__demo__/closable.md | ---
order: 2
title:
zh-CN: 可关闭
en-US: Closable
---
## zh-CN
指定 `closable = true`，可开启关闭按钮。
## en-US
Use `closable = true` to turn on the close button.
```js
import { Alert, Grid } from '@arco-design/web-react';
const { Row, Col } = Grid;
const App = () => {
return (
<div>
<Row gutter={40}>
... | 3,672 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__demo__/closeElement.md | ---
order: 3
title:
zh-CN: 自定义关闭元素
en-US: Custom close element
---
## zh-CN
指定 `closeElement`，自定义关闭元素。`closeElement` 可以接收 `onClick`，并且自带 `close` 参数，调用 `close()` 可以关闭。
## en-US
Use `closeElement` to customize the close element. `closeElement` can receive `onClick`, has its own `close` parameter, and can be close... | 3,673 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__demo__/type.md | ---
order: 1
title:
zh-CN: 不同类型
en-US: Different type
---
## zh-CN
警告提示的类型有 `info`, `success`, `warning`, `error` 四种。
## en-US
There are four types of warnings: `info`, `success`, `warning`, and `error`.
```js
import { Alert, Grid } from '@arco-design/web-react';
const { Row, Col } = Grid;
const App = () => {... | 3,674 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__demo__/with-title.md | ---
order: 4
title:
zh-CN: 含有标题
en-US: With title
---
## zh-CN
通过设置 `title` 可以给添加标题，将 `content` 变为辅助性介绍文字。
## en-US
`content` is turned into auxiliary introduction text with presence of `title`.
```js
import { Alert, Grid } from '@arco-design/web-react';
const { Row, Col } = Grid;
const App = () => {
return... | 3,675 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__demo__/without-icon.md | ---
order: 5
title:
zh-CN: 不含图标
en-US: Without icon
---
## zh-CN
通过指定 `showIcon=false` 来不显示图标。
## en-US
Use `showIcon=false` to hide the icon.
```js
import { Alert, Grid } from '@arco-design/web-react';
const { Row, Col } = Grid;
const App = () => {
return (
<Row gutter={40}>
<Col span={12}>
... | 3,676 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__template__/index.en-US.md | ---
file: interface
---
`````
Component / Feedback
# Alert
Used to display warning information in a way that attracts attention.
`````
%%Content%%
## API
%%Props%%
| 3,677 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__template__/index.zh-CN.md | ---
file: interface
---
`````
组件 / 反馈
# 警告提示 Alert
向用户显示警告的信息时，通过警告提示，展现需要关注的信息。
`````
%%Content%%
## API
%%Props%%
| 3,678 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__test__/demo.test.ts | import demoTest from '../../../tests/demoTest';
demoTest('Alert');
| 3,679 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/__test__/index.test.tsx | import React from 'react';
import mountTest from '../../../tests/mountTest';
import componentConfigTest from '../../../tests/componentConfigTest';
import Alert from '..';
import { fireEvent, render } from '../../../tests/util';
mountTest(Alert);
componentConfigTest(Alert, 'Alert');
describe('Alert', () => {
it('sho... | 3,680 |
0 | petrpan-code/arco-design/arco-design/components/Alert/__test__ | petrpan-code/arco-design/arco-design/components/Alert/__test__/__snapshots__/demo.test.ts.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`renders Alert/demo/action.md correctly 1`] = `
<div>
<div
class="arco-alert arco-alert-info"
role="alert"
>
<div
class="arco-alert-icon-wrapper"
>
<svg
aria-hidden="true"
class="arco-icon arco-icon-info-circle-fill"
... | 3,681 |
0 | petrpan-code/arco-design/arco-design/components/Alert/__test__ | petrpan-code/arco-design/arco-design/components/Alert/__test__/__snapshots__/index.test.tsx.snap | // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`ConfigProvider componentConfig.Alert default 1`] = `
<div
class="arco-alert arco-alert-info"
role="alert"
>
<div
class="arco-alert-icon-wrapper"
>
<svg
aria-hidden="true"
class="arco-icon arco-icon-info-circle-fill"
fill="none"
... | 3,682 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/style/index.less | @import './token.less';
@alert-prefix-cls: ~'@{prefix}-alert';
.@{alert-prefix-cls} {
box-sizing: border-box;
border-radius: @alert-border-radius;
padding: (@alert-padding-vertical - @alert-border-width)
(@alert-padding-horizontal - @alert-border-width);
font-size: @alert-font-size-text-content;
overflo... | 3,683 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/style/index.ts | import '../../style/index.less';
import './index.less';
| 3,684 |
0 | petrpan-code/arco-design/arco-design/components/Alert | petrpan-code/arco-design/arco-design/components/Alert/style/token.less | @import '../../style/theme/default.less';
@alert-border-width: @border-1;
@alert-margin-close-icon-left: @spacing-4;
@alert-margin-icon-right: @spacing-4;
@alert-margin-action-right: @spacing-4;
@alert-margin-action-left: @spacing-4;
@alert-border-radius: @radius-small;
@alert-line-height: 1.5715;
@alert-title-line-h... | 3,685 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Anchor/README.en-US.md | `````
Component / Other
# Anchor
By the Anchor can quickly find the information content of the current page.
`````
%%Content%%
## API
### Anchor
|Property|Description|Type|DefaultValue|Version|
|---|---|---|---|---|
|affix|Whether to wrap anchor within [Affix](/react/components/affix)|boolean |`true`|-|
|animatio... | 3,686 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Anchor/README.zh-CN.md | `````
组件 / 其他
# 锚点 Anchor
通过锚点可快速找到信息内容在当前页面的位置。
`````
%%Content%%
## API
### Anchor
|参数名|描述|类型|默认值|版本|
|---|---|---|---|---|
|affix|是否固定。当设置为 `true`时，锚点组件将会嵌套在[固钉](/react/components/affix) 组件内|boolean |`true`|-|
|animation|是否平滑滚动|boolean |`true`|-|
|hash|是否改变 hash，设置为 `false` 点击锚点不会改变页面 hash。|boolean |`true`|-|
... | 3,687 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Anchor/anchor.tsx | import React, {
forwardRef,
useCallback,
useContext,
useEffect,
useImperativeHandle,
useRef,
useState,
} from 'react';
import throttle from 'lodash/throttle';
import compute from 'compute-scroll-into-view';
import scrollIntoViewIfNeeded from 'scroll-into-view-if-needed';
import { isFunction, isNumber, isW... | 3,688 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Anchor/context.ts | import { createContext } from 'react';
import { AnchorProps } from '..';
interface AnchorContext {
currentLink: string;
onLinkClick: (e: React.MouseEvent<HTMLAnchorElement, MouseEvent>, href: string) => void;
addLink: (href: string, node: HTMLElement) => void;
removeLink: (href: string) => void;
direction: A... | 3,689 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Anchor/index.tsx | import Anchor from './anchor';
import { AnchorProps } from './interface';
export default Anchor;
export { AnchorProps };
| 3,690 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Anchor/interface.ts | import { ReactNode, CSSProperties } from 'react';
/**
* @title Anchor
*/
export interface AnchorProps {
className?: string | string[];
style?: CSSProperties;
/**
* @zh 是否平滑滚动
* @en Whether to enable smooth scrolling
* @defaultValue true
*/
animation?: boolean;
/**
* @zh 方向
* @en Direction... | 3,691 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Anchor/link.tsx | import React, {
forwardRef,
useContext,
useEffect,
useImperativeHandle,
useRef,
isValidElement,
} from 'react';
import AnchorContext from './context';
import { AnchorLinkProps } from './interface';
import { ConfigContext } from '../ConfigProvider';
import cs from '../_util/classNames';
import { isString, is... | 3,692 |
0 | petrpan-code/arco-design/arco-design/components | petrpan-code/arco-design/arco-design/components/Anchor/utils.ts | import BTween from 'b-tween';
import { isString, isWindow } from '../_util/is';
export function findNode(dom: HTMLElement | Document, selector: string): HTMLElement | null {
// handle id start with number
// e.g. id #123
const s =
isString(selector) && selector[0] === '#' ? `[id='${selector.replace('#', '')}... | 3,693 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/__changelog__/index.en-US.md | ## 2.52.0
2023-08-18
### 🐛 BugFix
- Fix the problem that the blue-line position of the active anchor is not updated after the sub-anchor of the `Anchor` component is removed.([#2161](https://github.com/arco-design/arco-design/pull/2161))
## 2.51.0
2023-07-28
### 🆕 Feature
- Support horizontal `Anchor`([#2108](... | 3,694 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/__changelog__/index.zh-CN.md | ## 2.52.0
2023-08-18
### 🐛 问题修复
- 修复 `Anchor` 组件子锚点被移除后，激活态锚点的蓝色标识位置未更新的问题。([#2161](https://github.com/arco-design/arco-design/pull/2161))
## 2.51.0
2023-07-28
### 🆕 功能升级
- 支持横向 `Anchor`([#2108](https://github.com/arco-design/arco-design/pull/2108) '')
## 2.43.1
2022-12-30
### 🐛 问题修复
- 优化 `Anchor` 组件在锚点元素... | 3,695 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/__demo__/affix.md | ---
order: 3
title:
zh-CN: 固钉样式
en-US: Affix
---
## zh-CN
示例中的锚点将会出现在页面右侧。
当设置 `affix` 为 `true` 时，锚点组件将会嵌套在[固钉](/react/components/affix)组件内。通过 `affixStyle` 属性可以设置 `Affix` 组件的样式。
## en-US
The anchor in the example will appear on the right side of the page.
Use `affix=true` to wrap the anchor within [Affix](/re... | 3,696 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/__demo__/basic.md | ---
order: 0
title:
zh-CN: 基本用法
en-US: Basic
---
## zh-CN
基本用法，随着页面滚动，锚点浮动在页面固定位置。
## en-US
Basic usage. The anchor will be fixed on the page as the page scrolls.
```js
import { Anchor } from '@arco-design/web-react';
const AnchorLink = Anchor.Link;
const App = () => {
return (
<Anchor
offsetTop={... | 3,697 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/__demo__/boundary.md | ---
order: 4
title:
zh-CN: 设置锚点滚动偏移量
en-US: Scroll boundary
---
## zh-CN
可以设置 `boundary` 来定制锚点滚动偏移量。
## en-US
Use `boundary` to customize the scrolling offset of the anchor.
```js
import { Anchor } from '@arco-design/web-react';
const AnchorLink = Anchor.Link;
const App = () => {
return (
<Anchor affix=... | 3,698 |
0 | petrpan-code/arco-design/arco-design/components/Anchor | petrpan-code/arco-design/arco-design/components/Anchor/__demo__/hash.md | ---
order: 5
title:
zh-CN: 点击锚点不记录历史
en-US: Hash mode
---
## zh-CN
可以设置点击锚点而不改变浏览器历史。
## en-US
Click anchor without changing the browser history.
```js
import { Anchor } from '@arco-design/web-react';
const AnchorLink = Anchor.Link;
const App = () => {
return (
<Anchor affix={false} hash={false}>
... | 3,699 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.