Skip to content

Commit ab1229c

Browse files
committed
chore: align father config and Chinese README
1 parent dd6e304 commit ab1229c

3 files changed

Lines changed: 16 additions & 21 deletions

File tree

.fatherrc.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import { defineConfig } from 'father';
2+
3+
export default defineConfig({
4+
plugins: ['@rc-component/father-plugin'],
5+
});

README.zh-CN.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -84,33 +84,33 @@ npm start
8484
| allowClear | `boolean \| { clearIcon?: ReactNode }` | `false` | 显示文本区域值的清除按钮。 |
8585
| autoFocus | `boolean` | `false` | 安装后聚焦文本区域。 |
8686
| autoSize | `boolean \| { minRows?: number; maxRows?: number }` | - | 自动调整文本区域高度。 |
87-
| children | `ReactNode` | - | `Mentions.Option` 小朋友|
87+
| children | `ReactNode` | - | `Mentions.Option` 子元素|
8888
| className | `string` | - | 根元素的 className。 |
8989
| classNames | `MentionsProps['classNames']` | - | 插槽的语义 className。 |
9090
| defaultValue | `string` | - | 初始值。 |
9191
| direction | `'ltr' \| 'rtl'` | `ltr` | 弹层方向。 |
9292
| filterOption | `false \| (input: string, option: OptionProps) => boolean` | - | 自定义选项过滤。 |
93-
| getPopupContainer | `() => HTMLElement` | - | 建议弹层窗口的容器|
94-
| id | `string` | - | Textarea id. |
93+
| getPopupContainer | `() => HTMLElement` | - | 指定弹层窗口的容器|
94+
| id | `string` | - | 文本域 id |
9595
| notFoundContent | `ReactNode` | `Not Found` | 没有选项匹配时显示的内容。 |
9696
| options | `DataDrivenOptionProps[]` | - | 数据驱动的选项。 |
97-
| placement | `'top' \| 'bottom'` | `bottom` | 建议弹层窗口放置。 |
97+
| placement | `'top' \| 'bottom'` | `bottom` | 弹层窗口位置。 |
9898
| popupClassName | `string` | - | 弹层窗口的 className。 |
9999
| prefix | `string \| string[]` | `@` | 触发前缀或前缀。 |
100100
| prefixCls | `string` | `rc-mentions` | className 前缀。 |
101101
| rows | `number` | `1` | 文本域行数。 |
102102
| silent | `boolean` | `false` | 忽略过渡阶段的 Enter 行为。 |
103103
| split | `string` | `' '` | 在选定的提及之后插入的字符串。 |
104104
| style | `React.CSSProperties` | - | 根元素的内联样式。 |
105-
| styles | `MentionsProps['styles']` | - | Semantic styles for slots. |
105+
| styles | `MentionsProps['styles']` | - | 插槽的语义化样式。 |
106106
| transitionName | `string` | - | 弹层过渡名称。 |
107107
| validateSearch | `(text: string, split: MentionsProps['split']) => boolean` | - | 自定义触发搜索逻辑。 |
108108
| value | `string` | - | 受控值。 |
109109
| onBlur | `React.FocusEventHandler<HTMLTextAreaElement>` | - | 当文本区域失去焦点时触发。 |
110110
| onChange | `(text: string) => void` | - | 当值改变时触发。 |
111111
| onFocus | `React.FocusEventHandler<HTMLTextAreaElement>` | - | 当文本区域获得焦点时触发。 |
112-
| onKeyDown | `React.KeyboardEventHandler<HTMLTextAreaElement>` | - | Triggered on key down. |
113-
| onKeyUp | `React.KeyboardEventHandler<HTMLTextAreaElement>` | - | Triggered on key up. |
112+
| onKeyDown | `React.KeyboardEventHandler<HTMLTextAreaElement>` | - | 按键按下时触发。 |
113+
| onKeyUp | `React.KeyboardEventHandler<HTMLTextAreaElement>` | - | 按键释放时触发。 |
114114
| onPopupScroll | `(event: React.UIEvent<HTMLDivElement>) => void` | - | 当弹层窗口滚动时触发。 |
115115
| onPressEnter | `React.KeyboardEventHandler<HTMLTextAreaElement>` | - | 当按下 Enter 时触发。 |
116116
| onResize | `(size: { width: number; height: number }) => void` | - | 当文本区域大小改变时触发。 |

tsconfig.json

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,11 @@
88
"skipLibCheck": true,
99
"esModuleInterop": true,
1010
"paths": {
11-
"@/*": [
12-
"src/*"
13-
],
14-
"@@/*": [
15-
".dumi/tmp/*"
16-
],
17-
"@rc-component/mentions": [
18-
"src/index.ts"
19-
]
11+
"@/*": ["src/*"],
12+
"@@/*": [".dumi/tmp/*"],
13+
"@rc-component/mentions": ["src/index.ts"]
2014
},
2115
"ignoreDeprecations": "5.0"
2216
},
23-
"include": [
24-
".dumirc.ts",
25-
"**/*.ts",
26-
"**/*.tsx"
27-
]
17+
"include": [".dumirc.ts", ".fatherrc.ts", "**/*.ts", "**/*.tsx"]
2818
}

0 commit comments

Comments
 (0)