mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-02 20:19:44 +08:00
cbcfd38ca7
* build: try to use dumi as doc tool * docs: migrate demo structure to dumi way * refactor: use type export & import * docs: migrate demo previewer to dumi * docs: create empty layout & components * docs: apply custom rehype plugin * docs: create empty extra pages * docs: Add Banner component * chore: move theme tsconfig.json * docs: home page init * docs: migrate header (#37896) * docs: header * docs: update * docs: home init * clean up * test: fix site lint * chore: tsc ignore demo * chore: dumi demo migrate script * chore: cards * docs: home layout * docs: Update locale logic * docs: fix getLink logic * chore: fix ci (#37899) * chore: fix ci * ci: remove check-ts-demo * ci: preview build * test: ignore demo.tsx * chore: update script * test: update snapshot * test: update node and image test * chore: add .surgeignore * docs: layout providers (#37908) * docs: add components sidebar (#37923) * docs: sidebar * docs: update docs title * docs: update design doc * chore: code clean * docs: handle changelog page * docs: add title * docs: add subtitle * docs: active header nav * chore: code clean * docs: overview * chore: code clean * docs: update intl (#37918) * docs: update intl * chore: code clean * docs: update favicons * chore: update testPathIgnorePatterns * chore: code clean * chore: code clean * chore: copy 404.html (#37996) * docs: Home page theme picker * chore: Update migrate script * docs: home page update * docs: theme editor style * docs: theme lang * chore: update migrate.js * docs: fix demo (#38094) * chore: update migrate.js * docs: update md * docs: update demo * test: fix snapshot * chore: move debug to code attr in migrate script * chore: update md Co-authored-by: PeachScript <scdzwyxst@gmail.com> * feat: overview page * feat: Migrate `404` page (#38118) * feat: migrate IconSearch component (#37916) * feat<site/IconSearch>: copy IconDisplay from site to .dumi * feat<site/IconSearch>: change docs of icon * feat<site/IconSearch>: tweak * feat<site/IconSearch>: use useIntl instead of injectIntl * feat<site/IconSearch>: fix ts type error * feat<site/IconSearch>: use intl.formatMessage to render text * docs: Adjust home btn sizw * docs: Update doc * feat: v5 site overview page (#38131) * feat: site * fix: fix * feat: v5 site overview page * fix: fix path * fix: fix * fix: fix * docs: fix margin logic * feat: v5 site change-log page (#38137) * feat: v5 site change-log page (#38162) * docs: site redirect to home pag * docs: theme picker * docs: use react-intl from dumi (#38183) * docs: Theme Picker * docs: update dumi config * docs: home back fix * docs: picker colorful * docs: locale of it * docs: update components desc * docs: site of links * docs: update components list * docs: update desc * feat: Migrate `DemoWrapper` component (#38166) * feat: Migrate `DemoWrapper` component * feat: remove invalid comments and add comment for `key` prop * docs: FloatButton pure panel * chore: update demo * chore: update dumi config * Revert "chore: update demo" This reverts commit 028265d3ba5987df5f13c3e9d42cf76cb1812b2e. * chore: test logic adjust to support cnpm modules * chore: add locale alias * docs: /index to / * docs: add locale redirect head script * chore: adjust compact * docs: fix missing token * feat: compact switch * chore: code clean * docs: update home * docs: fix radius token * docs: hash of it * chore: adjust home page * docs: Add background map * docs: site theme bac logic * docs: avatar * docs: update logo color * docs: home banner * docs: adjust tour size * docs: purepanl update * docs: transfooter * docs: update banner gif * docs: content (#38361) * docs: title & EditButton * docs: content * chore: fix toc * docs: resource page * docs: transform resource data from hast * docs: filename & Resource Card * chore: enable prerender * chore: remove less * docs: toc style * chore: fix lint * docs: fix Layout page * docs: fix CP page * chore: update demos * docs: workaround for export dynamic html * chore: enable demo eslint * docs: table style * fix: header shadow * chore: update snapshot * fix: toc style * docs: add title * docs: Adjust site * feat: helmet * docs: site css * fix: description * feat: toc debug * docs: update config-provider * feat: use colorPanel * fix: colorPanel value * feat: anchor ink ball style * feat: apply theme editor * fix: code block style * chore: update demo * chore: fix lint * chore: code clean * chore: update snapshot * feat: ts2js * chore: description * docs: site ready for ssr includes: - move client render logic to useEffect in site theme - extract antd cssinjs to a single css file like bisheng - workaround to support react@18 pipeableStream for emotion * chore: bump testing lib * docs: font size of title * chore: remove react-sortable-hoc * chore: update snapshot * chore: update script Co-authored-by: PeachScript <scdzwyxst@gmail.com> Co-authored-by: MadCcc <1075746765@qq.com> Co-authored-by: zqran <uuxnet@gmail.com> Co-authored-by: TrickyPi <530257315@qq.com> Co-authored-by: lijianan <574980606@qq.com>
73 lines
2.7 KiB
Markdown
73 lines
2.7 KiB
Markdown
---
|
|
category: Components
|
|
subtitle: 提及
|
|
group: 数据录入
|
|
title: Mentions
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/jPE-itMFM/Mentions.svg
|
|
demo:
|
|
cols: 2
|
|
---
|
|
|
|
提及组件。
|
|
|
|
## 何时使用
|
|
|
|
用于在输入中提及某人或某事，常用于发布、聊天或评论功能。
|
|
|
|
## 代码演示
|
|
|
|
<code src="./demo/basic.tsx">基本使用</code>
|
|
<code src="./demo/async.tsx">异步加载</code>
|
|
<code src="./demo/form.tsx">配合 Form 使用</code>
|
|
<code src="./demo/prefix.tsx">自定义触发字符</code>
|
|
<code src="./demo/readonly.tsx">无效或只读</code>
|
|
<code src="./demo/placement.tsx">向上展开</code>
|
|
<code src="./demo/autoSize.tsx">自动大小</code>
|
|
<code src="./demo/status.tsx">自定义状态</code>
|
|
<code src="./demo/render-panel.tsx" debug>_InternalPanelDoNotUseOrYouWillBeFired</code>
|
|
|
|
## API
|
|
|
|
```jsx
|
|
<Mentions onChange={onChange}>
|
|
<Mentions.Option value="sample">Sample</Mentions.Option>
|
|
</Mentions>
|
|
```
|
|
|
|
### Mentions
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
| --- | --- | --- | --- | --- |
|
|
| autoFocus | 自动获得焦点 | boolean | false | |
|
|
| autoSize | 自适应内容高度，可设置为 true \| false 或对象：{ minRows: 2, maxRows: 6 } | boolean \| object | false | |
|
|
| defaultValue | 默认值 | string | - | |
|
|
| filterOption | 自定义过滤逻辑 | false \| (input: string, option: OptionProps) => boolean | - | |
|
|
| getPopupContainer | 指定建议框挂载的 HTML 节点 | () => HTMLElement | - | |
|
|
| notFoundContent | 当下拉列表为空时显示的内容 | ReactNode | `Not Found` | |
|
|
| placement | 弹出层展示位置 | `top` \| `bottom` | `bottom` | |
|
|
| prefix | 设置触发关键字 | string \| string\[] | `@` | |
|
|
| split | 设置选中项前后分隔符 | string | ` ` | |
|
|
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 |
|
|
| validateSearch | 自定义触发验证逻辑 | (text: string, props: MentionsProps) => void | - | |
|
|
| value | 设置值 | string | - | |
|
|
| onBlur | 失去焦点时触发 | () => void | - | |
|
|
| onChange | 值改变时触发 | (text: string) => void | - | |
|
|
| onFocus | 获得焦点时触发 | () => void | - | |
|
|
| onResize | resize 回调 | function({ width, height }) | - | |
|
|
| onSearch | 搜索时触发 | (text: string, prefix: string) => void | - | |
|
|
| onSelect | 选择选项时触发 | (option: OptionProps, prefix: string) => void | - | |
|
|
|
|
### Mentions 方法
|
|
|
|
| 名称 | 描述 |
|
|
| ------- | -------- |
|
|
| blur() | 移除焦点 |
|
|
| focus() | 获取焦点 |
|
|
|
|
### Option
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
| -------- | -------------- | --------- | ------ |
|
|
| children | 选项内容 | ReactNode | - |
|
|
| value | 选择时填充的值 | string | - |
|