idea-react 3.0.0-alpha.0 → 3.0.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/AGENTS.md +31 -10
  2. package/ReadMe.md +75 -41
  3. package/dist/index.d.mts +451 -100
  4. package/dist/index.d.ts +451 -100
  5. package/dist/index.js +16 -16
  6. package/dist/index.mjs +15 -15
  7. package/dist/style.css +5 -5
  8. package/package.json +7 -8
  9. package/source/Avatar.tsx +65 -12
  10. package/source/Button.tsx +13 -4
  11. package/source/ButtonGroup.tsx +28 -0
  12. package/source/Card.tsx +34 -0
  13. package/source/ClickBoundary.tsx +6 -5
  14. package/source/CloseButton.tsx +23 -0
  15. package/source/CodeBlock.tsx +5 -3
  16. package/source/Countdown.tsx +2 -0
  17. package/source/Drawer.tsx +62 -0
  18. package/source/Editor.tsx +5 -8
  19. package/source/Form/Adorn.tsx +38 -0
  20. package/source/Form/Checkbox.tsx +73 -0
  21. package/source/Form/Chips.tsx +51 -0
  22. package/source/Form/Combobox.tsx +109 -0
  23. package/source/Form/Control.tsx +59 -0
  24. package/source/Form/DatePicker.tsx +89 -0
  25. package/source/Form/Feedback.tsx +29 -0
  26. package/source/Form/FloatingLabel.tsx +15 -0
  27. package/source/Form/InputGroup.tsx +23 -0
  28. package/source/Form/OTP.tsx +48 -0
  29. package/source/Form/PasswordStrength.tsx +157 -0
  30. package/source/Form/Primitives.tsx +46 -0
  31. package/source/Form/Radio.tsx +51 -0
  32. package/source/Form/Range.tsx +65 -0
  33. package/source/Form/Switch.tsx +35 -0
  34. package/source/Form/index.ts +15 -0
  35. package/source/Grid.tsx +92 -0
  36. package/source/HorizontalMarquee/index.tsx +4 -10
  37. package/source/Image.tsx +15 -0
  38. package/source/ListGroup.tsx +103 -0
  39. package/source/LiveTSX.tsx +1 -1
  40. package/source/Loading.tsx +4 -3
  41. package/source/Menu.tsx +99 -1
  42. package/source/MonthCalendar.tsx +60 -22
  43. package/source/NativeDialog/index.tsx +37 -1
  44. package/source/Nav.tsx +52 -0
  45. package/source/Navbar.tsx +58 -1
  46. package/source/Overlay.ts +22 -0
  47. package/source/OverlayBox.tsx +200 -32
  48. package/source/PageNav.tsx +56 -32
  49. package/source/Popover.tsx +36 -0
  50. package/source/ScrollNav/Scroller.tsx +107 -0
  51. package/source/ScrollNav/index.tsx +12 -99
  52. package/source/Select.tsx +66 -55
  53. package/source/ShareBox.tsx +5 -11
  54. package/source/Spinner.tsx +30 -0
  55. package/source/SpinnerButton.tsx +8 -10
  56. package/source/Table.tsx +59 -0
  57. package/source/TableSpinner.tsx +7 -5
  58. package/source/{TextTruncate.tsx → TextTruncate/Content.tsx} +24 -20
  59. package/source/TextTruncate/index.tsx +25 -0
  60. package/source/Time.tsx +7 -33
  61. package/source/TimeDistance.tsx +1 -1
  62. package/source/Timeline/index.tsx +7 -7
  63. package/source/Toast.tsx +120 -29
  64. package/source/ToggleButton.tsx +47 -0
  65. package/source/Tooltip.tsx +32 -0
  66. package/source/TypeEcho/Content.tsx +58 -0
  67. package/source/TypeEcho/index.tsx +14 -0
  68. package/source/UserRank/index.module.less +9 -20
  69. package/source/UserRank/index.tsx +35 -32
  70. package/source/VerticalMarquee/index.module.less +0 -1
  71. package/source/VerticalMarquee/index.tsx +3 -5
  72. package/source/ZodiacBar.tsx +1 -1
  73. package/source/animate.ts +4 -2
  74. package/source/color.ts +3 -5
  75. package/source/index.ts +14 -0
  76. package/source/TypeEcho.tsx +0 -49
package/AGENTS.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  [Bootstrap][1] 组件更新时,应遵循以下步骤更新本代码库:
6
6
 
7
- 1. 拉取 https://github.com/twbs/bootstrap/tree/main/site/src/components 目录下的最新代码
7
+ 1. 拉取 https://github.com/twbs/bootstrap/tree/main/site/src/content/docs/components 目录下的最新代码
8
8
  2. 将更新的组件文档同步到本库的 `document/app` 目录,可能需要转为 MDX 格式
9
9
  3. 根据更新的组件文档,新增或修改本库中的对应组件,并将实现的组件应用回前面的 MDX 文档中
10
10
  4. 根据更新的文档和组件,编写 `test` 目录的单元测试,以 `ComponentName.test.tsx` 规范命名文件
@@ -21,17 +21,21 @@ export interface MyComponentProps {
21
21
  }
22
22
 
23
23
  export const MyComponent: FC<MyComponentProps> = ({ message }) => <div>{message}</div>;
24
+
25
+ MyComponent.displayName = 'MyComponent';
24
26
  ```
25
27
 
26
28
  ### 依赖 State 的组件
27
29
 
28
30
  ```tsx
29
- import { observable, action } from 'mobx';
31
+ import { action, observable } from 'mobx';
30
32
  import { observer } from 'mobx-react';
31
33
  import { Component } from 'react';
32
34
 
33
35
  @observer
34
36
  export class MyComponent extends Component {
37
+ static displayName = 'MyComponent';
38
+
35
39
  @observable
36
40
  accessor count = 0;
37
41
 
@@ -49,7 +53,7 @@ export class MyComponent extends Component {
49
53
  ### 依赖 Store 的组件
50
54
 
51
55
  ```tsx
52
- import { observable, action } from 'mobx';
56
+ import { action, observable } from 'mobx';
53
57
  import { observer } from 'mobx-react';
54
58
  import { Component } from 'react';
55
59
 
@@ -65,6 +69,8 @@ export class MyModel {
65
69
 
66
70
  @observer
67
71
  export class MyComponent extends Component {
72
+ static displayName = 'MyComponent';
73
+
68
74
  store = new MyModel();
69
75
 
70
76
  handleIncrement = () => this.store.increment();
@@ -80,10 +86,9 @@ export class MyComponent extends Component {
80
86
  ### 依赖事件委托、监听数据变更的组件
81
87
 
82
88
  ```tsx
83
- import { observable, action } from 'mobx';
84
89
  import { observer } from 'mobx-react';
85
90
  import { ObservedComponent, on, reaction } from 'mobx-react-helper';
86
- import { Component, MouseEvent } from 'react';
91
+ import { MouseEvent } from 'react';
87
92
 
88
93
  export interface MyComponentProps {
89
94
  someKey: string;
@@ -91,6 +96,8 @@ export interface MyComponentProps {
91
96
 
92
97
  @observer
93
98
  export class MyComponent extends ObservedComponent<MyComponentProps> {
99
+ static displayName = 'MyComponent';
100
+
94
101
  componentDidMount() {
95
102
  super.componentDidMount();
96
103
  this.init();
@@ -132,6 +139,7 @@ export class MyComponent extends ObservedComponent<MyComponentProps> {
132
139
  - 只实现用户要求的内容;不要擅自新增页面、组件规格文档、示例或其它功能。
133
140
  - 文档站要用到的 [Bootstrap 官方组件][2] 必须先在 `source/` 封装为通用组件,
134
141
  再由文档站引用,不是将其专用组件放进组件库。
142
+ - 文档与示例统一引用封装后的组件,MDX 不直接书写 Bootstrap 组件类名,只有展示原始 HTML(如无 JS 示例)时,代码块才保留类名写法。
135
143
  - 文档站专用布局、组件、模型和样式放在 `document/component/`,不得从组件库导出或混入发布包。
136
144
  - 多个同前缀的文件归入同名文件夹,文件使用 `index.tsx`、`model.ts`、
137
145
  `style.module.css` 等短名,并同步调整所有引用。
@@ -145,22 +153,35 @@ export class MyComponent extends ObservedComponent<MyComponentProps> {
145
153
  - 少量、仅供单个组件使用的状态直接写为类组件实例成员,不必独立状态类。
146
154
  - 充分利用类属性初始化状态、恢复 Promise 和订阅 disposer,不将可声明的初始化集中到 `initialize()` 中。浏览器副作用应在客户端挂载后启动,卸载时释放订阅,并防止异步恢复完成后给已销毁实例重新绑定监听。
147
155
  - 使用 MobX stage-3 装饰器(如 `@observable accessor`、`@computed`、`@action`)。
148
- - 已有 `@action` 时不要再套 `runInAction()`。异步方法的 `await` 之后不继承 action
149
- 边界,后续状态更新应调用独立的 `@action` 方法,不能直接删除包装后裸写状态。
156
+ - 已有 action 边界(`@action` 或 `action()`)时不要再套 `runInAction()`。异步方法的 `await` 之后不继承 action 边界,后续状态更新应调用独立的 action(`@action` 方法或 `action()` 包装的实例方法),不能直接删除包装后裸写状态。
157
+ - 仅把调用转发给模型 action 的事件方法不再加 `@action`,action 边界由模型方法负责。
150
158
  - 回调函数的对象参数优先解构;需要把完整事件传给外部回调或保留事件方法调用上下文时,
151
159
  可以保留事件对象,在函数体中解构所需字段。
152
160
  - 类组件的所有事件回调写成箭头函数形式的类实例方法,直接传给事件属性;
153
161
  不在 JSX 中内联事件处理函数,也不在渲染过程中创建事件包装函数。
162
+ - 事件处理器先调用外部 `props` 回调,空行后再执行组件自身逻辑;处理器内的不同步骤之间用空行分组。
154
163
  - 类型兼容时直接传入已有函数作为回调,不添加只转发调用的包装函数。
155
- - 只有返回语句的函数简化为箭头函数表达式;相邻的两个返回分支优先合为三目表达式。
156
- - 返回前的最后一个语句不影响返回值时,可与 `return` 合并。
164
+ - 返回值不参与逻辑的外部回调类型写作 `(...) => unknown`(如 `onSelect`),不用 `void` 限制返回值,也不写 `any`。
157
165
  - 可迭代集合(如 `NodeList`)优先用展开语法;可选查询结果需保留空集合回退。
158
166
  - 多个同类型字段使用 `type` 和 `Record` 简写;含子元素的属性优先使用 `PropsWithChildren`。
159
167
  - 文本内容优先通过 `children` 传入,不另设重复用途的命名属性。
160
- - 嵌套较深、行数较长的大型 JSX 功能块提取为类组件渲染方法或无状态函数组件。
168
+ - 嵌套较深、行数较长的大型 JSX 功能块提取为类组件渲染方法或无状态函数组件;类组件的多个渲染片段写成独立的 `renderXxx` 类实例方法,可直接作为 `map` 回调,不在函数组件内嵌套渲染函数或用闭包模拟类。
161
169
  - 所有图标通过 [Icon][3] 渲染,不另写图标组件或自绘 SVG;
162
170
  使用相应图标字体样式,并保留必要的无障碍标签。
163
171
 
172
+ ## 代码风格
173
+
174
+ - 只有返回或赋值一条语句的函数/箭头方法化简为表达式体(含 `action(() => ...)`); 相邻的两个返回分支优先合为三目表达式,仅用于区分两种返回值的提前 `return` 也改为三目。
175
+ - 返回前的最后一个语句不影响返回值时,可与 `return` 合并。
176
+ - 可空引用上的单个调用或链式操作直接使用可选链,不写单独的 `if (!value) return;` 守卫。
177
+ - 对象字面量与 JSX 中的复杂条件表达式或片段先提取为具名局部变量,保持结构简洁。
178
+ - 可选 props 的默认值写在解构参数中(如 `className = ''`、`rows = 3`),不在表达式里用 `|| ''` 兜底。
179
+ - 向子组件透传时只解构需要特殊处理的 props,其余用 `...this.props` 展开,不逐项转发。
180
+ - 多个组件共享的属性定义在基础模块,组件通过 `extends`、`Omit` 或类型别名复用,不从组件文件再导出基础模块的类型。
181
+ - 组件 Props 优先用 `Pick`/`Omit`/`extends` 复用已有类型,不重复声明;按外观、内容、状态、行为的顺序分组排列。
182
+ - 同一模块的类型与值合并为一条 import,不拆成 `import type` 与 `import` 两条。
183
+ - JSX 中不同逻辑块(如触发器与浮层)之间用空行分隔。
184
+
164
185
  ## 错误处理
165
186
 
166
187
  - 没有特殊恢复或业务处理的错误不在局部捕获、转换为错误状态或重复展示,让其继续向上传播。
package/ReadMe.md CHANGED
@@ -9,7 +9,6 @@ A **[React][1] advanced components library** based on [TypeScript][2] & [Bootstr
9
9
  [![NPM][11]][12]
10
10
 
11
11
  - API document: https://idea2app.github.io/Idea-React/
12
- - Preview site: https://idea2app.github.io/Idea-React/preview/
13
12
 
14
13
  ## Versions
15
14
 
@@ -20,48 +19,82 @@ A **[React][1] advanced components library** based on [TypeScript][2] & [Bootstr
20
19
 
21
20
  ## Content
22
21
 
23
- ### Components
22
+ ### Basic components
24
23
 
25
- 1. [Button](source/Button.tsx)
24
+ 1. [Avatar](source/Avatar.tsx)
26
25
  2. [Badge](source/Badge.tsx)
27
- 3. [Navbar](source/Navbar.tsx)
28
- 4. [Menu](source/Menu.tsx)
29
- 5. [Native Dialog](source/NativeDialog/index.tsx)
30
- 6. [Time](source/Time.tsx)
31
- 7. [Time Distance](source/TimeDistance.tsx)
32
- 8. [Timeline](source/Timeline/)
33
- 9. [Countdown](source/Countdown.tsx)
34
- 10. [Icon](source/Icon.tsx)
35
- 11. [Avatar](source/Avatar.tsx)
26
+ 3. [Button](source/Button.tsx)
27
+ 4. [Button Group](source/ButtonGroup.tsx)
28
+ 5. [Card](source/Card.tsx)
29
+ 6. [Close Button](source/CloseButton.tsx)
30
+ 7. [Drawer](source/Drawer.tsx)
31
+ 8. [Grid](source/Grid.tsx)
32
+ 9. [Image](source/Image.tsx)
33
+ 10. [List Group](source/ListGroup.tsx)
34
+ 11. [Menu](source/Menu.tsx)
35
+ 12. [Native Dialog](source/NativeDialog/)
36
+ 13. [Nav](source/Nav.tsx)
37
+ 14. [Navbar](source/Navbar.tsx)
38
+ 15. [Popover](source/Popover.tsx)
39
+ 16. [Spinner](source/Spinner.tsx)
40
+ 17. [Table](source/Table.tsx)
41
+ 18. [Toast](source/Toast.tsx)
42
+ 19. [Toggle Button](source/ToggleButton.tsx)
43
+ 20. [Tooltip](source/Tooltip.tsx)
44
+
45
+ ### Form components
46
+
47
+ 1. [Form, Fieldset, Field, Group, Field Content & Label](source/Form/Primitives.tsx)
48
+ 2. [Form Control, Text Area & Select](source/Form/Control.tsx)
49
+ 3. [Checkbox](source/Form/Checkbox.tsx)
50
+ 4. [Radio & Form Check](source/Form/Radio.tsx)
51
+ 5. [Switch](source/Form/Switch.tsx)
52
+ 6. [Range](source/Form/Range.tsx)
53
+ 7. [Input Group](source/Form/InputGroup.tsx)
54
+ 8. [Floating Label](source/Form/FloatingLabel.tsx)
55
+ 9. [Form Adornment & Ghost](source/Form/Adorn.tsx)
56
+ 10. [Chip & Chip Input](source/Form/Chips.tsx)
57
+ 11. [Combobox](source/Form/Combobox.tsx)
58
+ 12. [Date Picker](source/Form/DatePicker.tsx)
59
+ 13. [OTP Input](source/Form/OTP.tsx)
60
+ 14. [Password Strength](source/Form/PasswordStrength.tsx)
61
+ 15. [Form Feedback & Text](source/Form/Feedback.tsx)
62
+
63
+ ### Advanced components
64
+
65
+ 1. [Click Boundary](source/ClickBoundary.tsx)
66
+ 2. [Code Block](source/CodeBlock.tsx)
67
+ 3. [Countdown](source/Countdown.tsx)
68
+ 4. [Dialog](source/Dialog.tsx)
69
+ 5. [Editor](source/Editor.tsx)
70
+ 6. [Editor HTML](source/EditorHTML.tsx)
71
+ 7. [Horizontal Marquee](source/HorizontalMarquee/)
72
+ 8. [Icon](source/Icon.tsx)
73
+ 9. [Live TSX](source/LiveTSX.tsx)
74
+ 10. [Loading](source/Loading.tsx)
75
+ 11. [Month Calendar](source/MonthCalendar.tsx)
36
76
  12. [Nameplate](source/Nameplate.tsx)
37
- 13. [Text Truncate](source/TextTruncate.tsx)
38
- 14. [Type Echo](source/TypeEcho.tsx)
39
- 15. [Horizontal Marquee](source/HorizontalMarquee/)
40
- 16. [Vertical Marquee](source/VerticalMarquee/)
41
- 17. [Click Boundary](source/ClickBoundary.tsx)
77
+ 13. [Overlay Box](source/OverlayBox.tsx)
78
+ 14. [Page Nav](source/PageNav.tsx)
79
+ 15. [Scroll Nav](source/ScrollNav/)
80
+ 16. [Select](source/Select.tsx)
81
+ 17. [Share Box](source/ShareBox.tsx)
42
82
  18. [Spinner Button](source/SpinnerButton.tsx)
43
- 19. [Select](source/Select.tsx)
44
- 20. [Month Calendar](source/MonthCalendar.tsx)
45
- 21. [Code Block](source/CodeBlock.tsx)
46
- 22. [Live TSX](source/LiveTSX.tsx)
47
- 23. [Scroll Nav](source/ScrollNav/)
48
- 24. [Page Nav](source/PageNav.tsx)
49
- 25. [Editor](source/Editor.tsx)
50
- 26. [Editor HTML](source/EditorHTML.tsx)
51
- 27. [Table Spinner](source/TableSpinner.tsx)
52
- 28. [Loading](source/Loading.tsx)
53
- 29. [Share Box](source/ShareBox.tsx)
54
- 30. [Overlay Box](source/OverlayBox.tsx)
55
- 31. [Dialog](source/Dialog.tsx)
56
- 32. [Toast](source/Toast.tsx)
57
- 33. [User Rank](source/UserRank/)
58
- 34. [Zodiac Bar](source/ZodiacBar.tsx)
59
-
60
- #### Data components
83
+ 19. [Table Spinner](source/TableSpinner.tsx)
84
+ 20. [Text Truncate](source/TextTruncate/)
85
+ 21. [Time](source/Time.tsx)
86
+ 22. [Time Distance](source/TimeDistance.tsx)
87
+ 23. [Timeline](source/Timeline/)
88
+ 24. [Type Echo](source/TypeEcho/)
89
+ 25. [User Rank](source/UserRank/)
90
+ 26. [Vertical Marquee](source/VerticalMarquee/)
91
+ 27. [Zodiac Bar](source/ZodiacBar.tsx)
92
+
93
+ ### Data components
61
94
 
62
95
  Table, List & Form components around Data models, have been migrated to https://github.com/idea2app/MobX-RESTful-table, since Idea-React v1.0.0.
63
96
 
64
- #### Map components
97
+ ### Map components
65
98
 
66
99
  Open Map component & model, have been migrated to https://github.com/idea2app/OpenReactMap, since Idea-React v1.0.0.
67
100
 
@@ -86,10 +119,12 @@ For the current alpha release, use `idea-react@next` instead of `idea-react`.
86
119
  ### CSS on CDN
87
120
 
88
121
  ```html
89
- <link rel="stylesheet" href="https://unpkg.com/bootstrap@5.3.8/dist/css/bootstrap.min.css" />
122
+ <link
123
+ rel="stylesheet"
124
+ href="https://unpkg.com/bootstrap@6.0.0-alpha.1/dist/css/bootstrap.min.css"
125
+ />
90
126
  <link rel="stylesheet" href="https://unpkg.com/bootstrap-icons@1.13.1/font/bootstrap-icons.css" />
91
127
  <link rel="stylesheet" href="https://unpkg.com/animate.css@4.1.1/animate.min.css" />
92
- <link rel="stylesheet" href="https://unpkg.com/prismjs@1.30.0/themes/prism.min.css" />
93
128
  <link rel="stylesheet" href="https://unpkg.com/idea-react/dist/index.css" />
94
129
  ```
95
130
 
@@ -178,8 +213,7 @@ export class ExamplePage extends Component {
178
213
 
179
214
  ```tsx
180
215
  import { Component } from 'react';
181
- import { Button } from 'react-bootstrap';
182
- import { Toast } from 'idea-react';
216
+ import { Button, Toast } from 'idea-react';
183
217
 
184
218
  export class ExamplePage extends Component {
185
219
  toast = new Toast();
@@ -193,7 +227,7 @@ export class ExamplePage extends Component {
193
227
  .open({
194
228
  title: 'Notification',
195
229
  body: 'Hello, world!',
196
- variant: 'success'
230
+ theme: 'success'
197
231
  })
198
232
  .then(() => console.log('Toast closed'))
199
233
  }