idea-react 2.3.5 → 3.0.0-alpha.1
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.
- package/AGENTS.md +253 -0
- package/ReadMe.md +81 -67
- package/dist/index.d.mts +419 -203
- package/dist/index.d.ts +419 -203
- package/dist/index.js +18 -18
- package/dist/index.mjs +17 -17
- package/dist/style.css +5 -1
- package/package.json +36 -35
- package/source/Avatar.tsx +65 -12
- package/source/Badge.tsx +34 -0
- package/source/Button.tsx +73 -0
- package/source/ButtonGroup.tsx +28 -0
- package/source/Card.tsx +26 -0
- package/source/ClickBoundary.tsx +6 -5
- package/source/CloseButton.tsx +23 -0
- package/source/CodeBlock.tsx +5 -3
- package/source/Countdown.tsx +2 -0
- package/source/Drawer.tsx +62 -0
- package/source/Editor.tsx +5 -8
- package/source/Grid.tsx +92 -0
- package/source/HorizontalMarquee/index.tsx +4 -10
- package/source/Image.tsx +15 -0
- package/source/ListGroup.tsx +103 -0
- package/source/LiveTSX.tsx +1 -1
- package/source/Loading.tsx +4 -3
- package/source/Menu.tsx +282 -0
- package/source/MonthCalendar.tsx +60 -22
- package/source/NativeDialog/index.tsx +139 -0
- package/source/NativeDialog/style.module.css +4 -0
- package/source/Nav.tsx +52 -0
- package/source/Navbar.tsx +64 -0
- package/source/Overlay.ts +22 -0
- package/source/OverlayBox.tsx +200 -32
- package/source/PageNav.tsx +56 -32
- package/source/Popover.tsx +36 -0
- package/source/ScrollNav/Scroller.tsx +107 -0
- package/source/ScrollNav/index.tsx +12 -99
- package/source/Select.tsx +66 -55
- package/source/ShareBox.tsx +5 -11
- package/source/Spinner.tsx +30 -0
- package/source/SpinnerButton.tsx +8 -10
- package/source/Table.tsx +59 -0
- package/source/TableSpinner.tsx +7 -5
- package/source/{TextTruncate.tsx → TextTruncate/Content.tsx} +24 -20
- package/source/TextTruncate/index.tsx +25 -0
- package/source/Time.tsx +7 -33
- package/source/TimeDistance.tsx +1 -1
- package/source/Timeline/index.tsx +7 -7
- package/source/Toast.tsx +114 -29
- package/source/ToggleButton.tsx +47 -0
- package/source/Tooltip.tsx +32 -0
- package/source/TypeEcho/Content.tsx +58 -0
- package/source/TypeEcho/index.tsx +14 -0
- package/source/UserRank/index.module.less +9 -20
- package/source/UserRank/index.tsx +35 -32
- package/source/VerticalMarquee/index.module.less +0 -1
- package/source/VerticalMarquee/index.tsx +3 -5
- package/source/ZodiacBar.tsx +1 -1
- package/source/animate.ts +4 -2
- package/source/color.ts +3 -5
- package/source/index.ts +18 -0
- package/source/types.d.ts +4 -0
- package/tsconfig.json +6 -2
- package/source/TypeEcho.tsx +0 -49
package/AGENTS.md
ADDED
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
# AGENTS.md
|
|
2
|
+
|
|
3
|
+
## 上游同步
|
|
4
|
+
|
|
5
|
+
[Bootstrap][1] 组件更新时,应遵循以下步骤更新本代码库:
|
|
6
|
+
|
|
7
|
+
1. 拉取 https://github.com/twbs/bootstrap/tree/main/site/src/content/docs/components 目录下的最新代码
|
|
8
|
+
2. 将更新的组件文档同步到本库的 `document/app` 目录,可能需要转为 MDX 格式
|
|
9
|
+
3. 根据更新的组件文档,新增或修改本库中的对应组件,并将实现的组件应用回前面的 MDX 文档中
|
|
10
|
+
4. 根据更新的文档和组件,编写 `test` 目录的单元测试,以 `ComponentName.test.tsx` 规范命名文件
|
|
11
|
+
|
|
12
|
+
## 组件风格
|
|
13
|
+
|
|
14
|
+
### 只依赖 Props 的组件
|
|
15
|
+
|
|
16
|
+
```tsx
|
|
17
|
+
import { FC } from 'react';
|
|
18
|
+
|
|
19
|
+
export interface MyComponentProps {
|
|
20
|
+
message: string;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export const MyComponent: FC<MyComponentProps> = ({ message }) => <div>{message}</div>;
|
|
24
|
+
|
|
25
|
+
MyComponent.displayName = 'MyComponent';
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### 依赖 State 的组件
|
|
29
|
+
|
|
30
|
+
```tsx
|
|
31
|
+
import { action, observable } from 'mobx';
|
|
32
|
+
import { observer } from 'mobx-react';
|
|
33
|
+
import { Component } from 'react';
|
|
34
|
+
|
|
35
|
+
@observer
|
|
36
|
+
export class MyComponent extends Component {
|
|
37
|
+
static displayName = 'MyComponent';
|
|
38
|
+
|
|
39
|
+
@observable
|
|
40
|
+
accessor count = 0;
|
|
41
|
+
|
|
42
|
+
@action
|
|
43
|
+
increment = () => {
|
|
44
|
+
this.count++;
|
|
45
|
+
};
|
|
46
|
+
|
|
47
|
+
render() {
|
|
48
|
+
return <button onClick={this.increment}>{this.count}</button>;
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### 依赖 Store 的组件
|
|
54
|
+
|
|
55
|
+
```tsx
|
|
56
|
+
import { action, observable } from 'mobx';
|
|
57
|
+
import { observer } from 'mobx-react';
|
|
58
|
+
import { Component } from 'react';
|
|
59
|
+
|
|
60
|
+
export class MyModel {
|
|
61
|
+
@observable
|
|
62
|
+
accessor count = 0;
|
|
63
|
+
|
|
64
|
+
@action
|
|
65
|
+
increment() {
|
|
66
|
+
this.count++;
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
@observer
|
|
71
|
+
export class MyComponent extends Component {
|
|
72
|
+
static displayName = 'MyComponent';
|
|
73
|
+
|
|
74
|
+
store = new MyModel();
|
|
75
|
+
|
|
76
|
+
handleIncrement = () => this.store.increment();
|
|
77
|
+
|
|
78
|
+
render() {
|
|
79
|
+
const { count } = this.store;
|
|
80
|
+
|
|
81
|
+
return <button onClick={this.handleIncrement}>{count}</button>;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### 依赖事件委托、监听数据变更的组件
|
|
87
|
+
|
|
88
|
+
```tsx
|
|
89
|
+
import { observer } from 'mobx-react';
|
|
90
|
+
import { ObservedComponent, on, reaction } from 'mobx-react-helper';
|
|
91
|
+
import { MouseEvent } from 'react';
|
|
92
|
+
|
|
93
|
+
export interface MyComponentProps {
|
|
94
|
+
someKey: string;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
@observer
|
|
98
|
+
export class MyComponent extends ObservedComponent<MyComponentProps> {
|
|
99
|
+
static displayName = 'MyComponent';
|
|
100
|
+
|
|
101
|
+
componentDidMount() {
|
|
102
|
+
super.componentDidMount();
|
|
103
|
+
this.init();
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
@reaction(({ observedProps: { someKey } }) => someKey)
|
|
107
|
+
init() {
|
|
108
|
+
console.log('someKey changed', this.observedProps.someKey);
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
@on('click', 'td')
|
|
112
|
+
handleClick(event: MouseEvent<HTMLTableCellElement>, target: HTMLTableCellElement) {
|
|
113
|
+
console.log('TD clicked', event, target);
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
render() {
|
|
117
|
+
const { someKey } = this.props;
|
|
118
|
+
|
|
119
|
+
return (
|
|
120
|
+
<table data-some-key={someKey}>
|
|
121
|
+
<thead>
|
|
122
|
+
<tr>
|
|
123
|
+
<th>Header</th>
|
|
124
|
+
</tr>
|
|
125
|
+
</thead>
|
|
126
|
+
<tbody>
|
|
127
|
+
<tr>
|
|
128
|
+
<td>Cell</td>
|
|
129
|
+
</tr>
|
|
130
|
+
</tbody>
|
|
131
|
+
</table>
|
|
132
|
+
);
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## 工作范围与组件边界
|
|
138
|
+
|
|
139
|
+
- 只实现用户要求的内容;不要擅自新增页面、组件规格文档、示例或其它功能。
|
|
140
|
+
- 文档站要用到的 [Bootstrap 官方组件][2] 必须先在 `source/` 封装为通用组件,
|
|
141
|
+
再由文档站引用,不是将其专用组件放进组件库。
|
|
142
|
+
- 文档与示例统一引用封装后的组件,MDX 不直接书写 Bootstrap 组件类名,只有展示原始 HTML(如无 JS 示例)时,代码块才保留类名写法。
|
|
143
|
+
- 文档站专用布局、组件、模型和样式放在 `document/component/`,不得从组件库导出或混入发布包。
|
|
144
|
+
- 多个同前缀的文件归入同名文件夹,文件使用 `index.tsx`、`model.ts`、
|
|
145
|
+
`style.module.css` 等短名,并同步调整所有引用。
|
|
146
|
+
|
|
147
|
+
## 状态与回调
|
|
148
|
+
|
|
149
|
+
- 遵循 AOP、单一职责与关注点分离,优先复用现有模型和框架组合机制,避免过度抽象。
|
|
150
|
+
- 仅依赖 props 的展示组件使用函数组件;需要状态、行为或生命周期时使用类组件与 MobX。
|
|
151
|
+
- 业务行为、异步流程和状态集中在内聚的模型类中;组件负责展示、生命周期和事件转发,
|
|
152
|
+
不要把这些逻辑集中到 React hooks 或零散工具函数里。
|
|
153
|
+
- 少量、仅供单个组件使用的状态直接写为类组件实例成员,不必独立状态类。
|
|
154
|
+
- 充分利用类属性初始化状态、恢复 Promise 和订阅 disposer,不将可声明的初始化集中到 `initialize()` 中。浏览器副作用应在客户端挂载后启动,卸载时释放订阅,并防止异步恢复完成后给已销毁实例重新绑定监听。
|
|
155
|
+
- 使用 MobX stage-3 装饰器(如 `@observable accessor`、`@computed`、`@action`)。
|
|
156
|
+
- 已有 action 边界(`@action` 或 `action()`)时不要再套 `runInAction()`。异步方法的 `await` 之后不继承 action 边界,后续状态更新应调用独立的 action(`@action` 方法或 `action()` 包装的实例方法),不能直接删除包装后裸写状态。
|
|
157
|
+
- 仅把调用转发给模型 action 的事件方法不再加 `@action`,action 边界由模型方法负责。
|
|
158
|
+
- 回调函数的对象参数优先解构;需要把完整事件传给外部回调或保留事件方法调用上下文时,
|
|
159
|
+
可以保留事件对象,在函数体中解构所需字段。
|
|
160
|
+
- 类组件的所有事件回调写成箭头函数形式的类实例方法,直接传给事件属性;
|
|
161
|
+
不在 JSX 中内联事件处理函数,也不在渲染过程中创建事件包装函数。
|
|
162
|
+
- 事件处理器先调用外部 `props` 回调,空行后再执行组件自身逻辑;处理器内的不同步骤之间用空行分组。
|
|
163
|
+
- 类型兼容时直接传入已有函数作为回调,不添加只转发调用的包装函数。
|
|
164
|
+
- 返回值不参与逻辑的外部回调类型写作 `(...) => unknown`(如 `onSelect`),不用 `void` 限制返回值,也不写 `any`。
|
|
165
|
+
- 可迭代集合(如 `NodeList`)优先用展开语法;可选查询结果需保留空集合回退。
|
|
166
|
+
- 多个同类型字段使用 `type` 和 `Record` 简写;含子元素的属性优先使用 `PropsWithChildren`。
|
|
167
|
+
- 文本内容优先通过 `children` 传入,不另设重复用途的命名属性。
|
|
168
|
+
- 嵌套较深、行数较长的大型 JSX 功能块提取为类组件渲染方法或无状态函数组件;类组件的多个渲染片段写成独立的 `renderXxx` 类实例方法,可直接作为 `map` 回调,不在函数组件内嵌套渲染函数或用闭包模拟类。
|
|
169
|
+
- 所有图标通过 [Icon][3] 渲染,不另写图标组件或自绘 SVG;
|
|
170
|
+
使用相应图标字体样式,并保留必要的无障碍标签。
|
|
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
|
+
|
|
185
|
+
## 错误处理
|
|
186
|
+
|
|
187
|
+
- 没有特殊恢复或业务处理的错误不在局部捕获、转换为错误状态或重复展示,让其继续向上传播。
|
|
188
|
+
- 页面根组件统一监听 `unhandledrejection`,以 `alert()` 或 Toast 展示错误;监听随组件挂载注册、卸载移除,不在每个页面或模型重复实现。
|
|
189
|
+
- 仅为释放资源、复位加载状态时使用 `finally`,不吞掉异常;异步后的状态修改仍经过 action。
|
|
190
|
+
- 标准浏览器 API 直接调用,不为已广泛支持的能力额外添加检测或静默降级;调用失败交由统一错误处理。
|
|
191
|
+
|
|
192
|
+
## 文档站、样式与文案
|
|
193
|
+
|
|
194
|
+
- 文档站使用 ViNext,保留 MDX 支持并以纯 SSG 导出;部署静态文件,不依赖运行时服务器。
|
|
195
|
+
- 文档站页面参考上游设计,但品牌使用 **Idea React**,版本、许可证、安装命令、链接及其它文案
|
|
196
|
+
均以本项目实际情况为准;保留必要的上游版权和许可证声明。
|
|
197
|
+
- 页面格式以简洁、可读为准:文档可用 MDX,非文档页(包括首页)在能减少缩进时也可用
|
|
198
|
+
MDX,不强制非文档页只能使用 TSX 或 MDX。
|
|
199
|
+
- 跨页面共享的导航栏等结构放在公共布局中,不重复写入单个页面。
|
|
200
|
+
- MDX 中的大段静态文本优先使用 Markdown,而非嵌套的 JSX 文本块。
|
|
201
|
+
- 从 `unpkg.com` 引入 Bootstrap CSS,严禁使用 Tailwind CSS 及其插件、配置和工具类。
|
|
202
|
+
- 能用 [Bootstrap 6 CSS 工具类][4] 的样式不写自定义 CSS;
|
|
203
|
+
剩余样式全部使用 CSS modules,不另建全局自定义样式;需要嵌套的样式使用 LESS modules。
|
|
204
|
+
- 样式模块的类型声明合入已有的 `source/types.d.ts`,不要另建重复声明文件。
|
|
205
|
+
- 除 agent 指南外,文档以功能简介与 quick start 为主,只保留使用者必要的安装、使用、启动和部署信息;开发规范、实现约束、测试与发布注意事项集中放在本文件,不把 Read Me 写成规格文档。
|
|
206
|
+
- 代码和目录结构变化时同步更新相关 Markdown,移除失效的路径与描述。
|
|
207
|
+
- Markdown 正文中的链接采用文末数字引用:正文写 `[text][number]`,文末写 `[number]: URL`;图片链接同样使用引用形式。行末链接(如组件列表项)无需改为文末引用,可保留 `[text](URL)`。
|
|
208
|
+
- 每篇文档的数字引用按首次出现顺序从 1 连续编号;重复链接复用同一编号,修改后同步整理正文与定义,移除未使用定义,不留跳号、重复或悬空引用。
|
|
209
|
+
- 组件目录优先列出上游标准组件,再列扩展组件。
|
|
210
|
+
- 静态站搜索优先采用最简单可用的方案,自动索引导出内容,不维护手写页面清单,不为索引格式或具体技术额外引入不必要的服务和框架。
|
|
211
|
+
|
|
212
|
+
## 测试与验证
|
|
213
|
+
|
|
214
|
+
- 使用 Node.js 原生 test runner、`node:assert/strict` 和原生 mock,不引入外部测试框架。
|
|
215
|
+
- 不同测试阶段的断言与后续操作之间留空行,区分准备、操作和验证。
|
|
216
|
+
- 通用组件单元测试放在 `test/`,遵循 `ComponentName.test.tsx` 命名;
|
|
217
|
+
不为文档站专用组件和模型编写或保留单元测试。
|
|
218
|
+
- 按改动范围运行相关类型检查、Lint、测试和构建;页面交互与响应式布局通过浏览器验证。
|
|
219
|
+
- 纯 SSG 构建不仅要检查退出码,还要确认实际导出的 HTML 等静态文件及路由,
|
|
220
|
+
避免将路由被跳过的构建误判为成功。
|
|
221
|
+
|
|
222
|
+
## 开发命令与部署
|
|
223
|
+
|
|
224
|
+
从仓库根目录执行:
|
|
225
|
+
|
|
226
|
+
```sh
|
|
227
|
+
pnpm install -r
|
|
228
|
+
pnpm test -r
|
|
229
|
+
pnpm build -r
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
- `test` 使用 Node.js 原生 runner,需要 Node.js 22.18+,并做 TypeScript 检查。Lint 与格式检查针对本次修改文件运行。
|
|
233
|
+
- 根目录 `pnpm build` 构建 TypeDoc、旧预览站与组件发布包;现有根构建、发布部署仍使用 `docs/`,不能将其误当作 ViNext 文档工作区的构建或部署。
|
|
234
|
+
- 文档工作区单独构建,只部署 `document/dist/client/`;部署到子目录前配置 `document/next.config.ts` 的 `basePath`,并验证静态资源、搜索索引和结果链接。
|
|
235
|
+
- 搜索索引在导出 HTML 后生成;验证搜索时先构建,再预览静态产物。
|
|
236
|
+
- 浏览器验证包括键盘交互、主题恢复、错误弹窗、失败后重试与不同视口;文档站不依赖 Node.js 或 Worker 运行时。
|
|
237
|
+
|
|
238
|
+
## 发布维护
|
|
239
|
+
|
|
240
|
+
- 仅在用户明确要求发布时更新 `package.json` 版本、创建对应版本标签并推送;推送目标应核实当前分支和远程配置,不照搬固定分支名或推送所有标签。
|
|
241
|
+
- 发布前运行相关验证及根构建,检查产物;组件包发布与文档工作区部署分别处理。
|
|
242
|
+
|
|
243
|
+
## Git 操作
|
|
244
|
+
|
|
245
|
+
- 未经用户明确要求,不创建提交、不推送、不 amend 或改写现有提交。
|
|
246
|
+
- “完成实现”“修复问题”“完成 PR”或“运行测试”均不等于提交或推送授权;
|
|
247
|
+
完成验证后保留未提交改动供用户审阅。
|
|
248
|
+
- 审核意见应通查同类问题,而非只改被评论的单行;将可复用的要求归纳到本文件,不夹带无关功能或修改。
|
|
249
|
+
|
|
250
|
+
[1]: https://getbootstrap.com/
|
|
251
|
+
[2]: https://getbootstrap.com/docs/6.0/components/
|
|
252
|
+
[3]: source/Icon.tsx
|
|
253
|
+
[4]: https://getbootstrap.com/docs/6.0/utilities/
|
package/ReadMe.md
CHANGED
|
@@ -2,14 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
A **[React][1] advanced components library** based on [TypeScript][2] & [Bootstrap][3], built by **[idea2app][4] remote developers team**.
|
|
4
4
|
|
|
5
|
-
[![MobX compatibility]
|
|
6
|
-
[![NPM Dependency]
|
|
7
|
-
[![CI & CD]
|
|
5
|
+
[![MobX compatibility][5]][6]
|
|
6
|
+
[![NPM Dependency][7]][8]
|
|
7
|
+
[![CI & CD][9]][10]
|
|
8
8
|
|
|
9
|
-
[![NPM]
|
|
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
|
|
|
@@ -22,35 +21,47 @@ A **[React][1] advanced components library** based on [TypeScript][2] & [Bootstr
|
|
|
22
21
|
|
|
23
22
|
### Components
|
|
24
23
|
|
|
25
|
-
1. [
|
|
26
|
-
2. [
|
|
27
|
-
3. [
|
|
28
|
-
4. [
|
|
29
|
-
5. [
|
|
30
|
-
6. [
|
|
31
|
-
7. [
|
|
32
|
-
8. [
|
|
33
|
-
9. [
|
|
34
|
-
10. [
|
|
35
|
-
11. [
|
|
36
|
-
12. [
|
|
37
|
-
13. [
|
|
38
|
-
14. [
|
|
39
|
-
15. [
|
|
40
|
-
16. [
|
|
41
|
-
17. [
|
|
42
|
-
18. [
|
|
43
|
-
19. [
|
|
44
|
-
20. [
|
|
45
|
-
21. [
|
|
46
|
-
22. [
|
|
47
|
-
23. [
|
|
48
|
-
24. [
|
|
49
|
-
25. [
|
|
50
|
-
26. [
|
|
51
|
-
27. [
|
|
52
|
-
28. [
|
|
53
|
-
29. [
|
|
24
|
+
1. [Button](source/Button.tsx)
|
|
25
|
+
2. [Badge](source/Badge.tsx)
|
|
26
|
+
3. [Navbar](source/Navbar.tsx)
|
|
27
|
+
4. [Menu](source/Menu.tsx)
|
|
28
|
+
5. [Native Dialog](source/NativeDialog/index.tsx)
|
|
29
|
+
6. [Nav](source/Nav.tsx)
|
|
30
|
+
7. [Card](source/Card.tsx)
|
|
31
|
+
8. [Grid](source/Grid.tsx)
|
|
32
|
+
9. [Image](source/Image.tsx)
|
|
33
|
+
10. [Table](source/Table.tsx)
|
|
34
|
+
11. [Popover](source/Popover.tsx)
|
|
35
|
+
12. [Tooltip](source/Tooltip.tsx)
|
|
36
|
+
13. [Time](source/Time.tsx)
|
|
37
|
+
14. [Time Distance](source/TimeDistance.tsx)
|
|
38
|
+
15. [Timeline](source/Timeline/)
|
|
39
|
+
16. [Countdown](source/Countdown.tsx)
|
|
40
|
+
17. [Icon](source/Icon.tsx)
|
|
41
|
+
18. [Avatar](source/Avatar.tsx)
|
|
42
|
+
19. [Nameplate](source/Nameplate.tsx)
|
|
43
|
+
20. [Text Truncate](source/TextTruncate/)
|
|
44
|
+
21. [Type Echo](source/TypeEcho/)
|
|
45
|
+
22. [Horizontal Marquee](source/HorizontalMarquee/)
|
|
46
|
+
23. [Vertical Marquee](source/VerticalMarquee/)
|
|
47
|
+
24. [Click Boundary](source/ClickBoundary.tsx)
|
|
48
|
+
25. [Spinner Button](source/SpinnerButton.tsx)
|
|
49
|
+
26. [Select](source/Select.tsx)
|
|
50
|
+
27. [Month Calendar](source/MonthCalendar.tsx)
|
|
51
|
+
28. [Code Block](source/CodeBlock.tsx)
|
|
52
|
+
29. [Live TSX](source/LiveTSX.tsx)
|
|
53
|
+
30. [Scroll Nav](source/ScrollNav/)
|
|
54
|
+
31. [Page Nav](source/PageNav.tsx)
|
|
55
|
+
32. [Editor](source/Editor.tsx)
|
|
56
|
+
33. [Editor HTML](source/EditorHTML.tsx)
|
|
57
|
+
34. [Table Spinner](source/TableSpinner.tsx)
|
|
58
|
+
35. [Loading](source/Loading.tsx)
|
|
59
|
+
36. [Share Box](source/ShareBox.tsx)
|
|
60
|
+
37. [Overlay Box](source/OverlayBox.tsx)
|
|
61
|
+
38. [Dialog](source/Dialog.tsx)
|
|
62
|
+
39. [Toast](source/Toast.tsx)
|
|
63
|
+
40. [User Rank](source/UserRank/)
|
|
64
|
+
41. [Zodiac Bar](source/ZodiacBar.tsx)
|
|
54
65
|
|
|
55
66
|
#### Data components
|
|
56
67
|
|
|
@@ -67,18 +78,26 @@ Open Map component & model, have been migrated to https://github.com/idea2app/Op
|
|
|
67
78
|
|
|
68
79
|
## Usage
|
|
69
80
|
|
|
81
|
+
```sh
|
|
82
|
+
npm install idea-react mobx mobx-react react react-dom react-element-to-jsx-string
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
For the current alpha release, use `idea-react@next` instead of `idea-react`.
|
|
86
|
+
|
|
70
87
|
### Scaffolds
|
|
71
88
|
|
|
72
|
-
1. MobX: [demo][
|
|
73
|
-
2. Next.js: [demo][
|
|
89
|
+
1. MobX: [demo][13] & [usage][14]
|
|
90
|
+
2. Next.js: [demo][15] & [usage][16]
|
|
74
91
|
|
|
75
92
|
### CSS on CDN
|
|
76
93
|
|
|
77
94
|
```html
|
|
78
|
-
<link
|
|
95
|
+
<link
|
|
96
|
+
rel="stylesheet"
|
|
97
|
+
href="https://unpkg.com/bootstrap@6.0.0-alpha.1/dist/css/bootstrap.min.css"
|
|
98
|
+
/>
|
|
79
99
|
<link rel="stylesheet" href="https://unpkg.com/bootstrap-icons@1.13.1/font/bootstrap-icons.css" />
|
|
80
100
|
<link rel="stylesheet" href="https://unpkg.com/animate.css@4.1.1/animate.min.css" />
|
|
81
|
-
<link rel="stylesheet" href="https://unpkg.com/prismjs@1.30.0/themes/prism.min.css" />
|
|
82
101
|
<link rel="stylesheet" href="https://unpkg.com/idea-react/dist/index.css" />
|
|
83
102
|
```
|
|
84
103
|
|
|
@@ -167,8 +186,7 @@ export class ExamplePage extends Component {
|
|
|
167
186
|
|
|
168
187
|
```tsx
|
|
169
188
|
import { Component } from 'react';
|
|
170
|
-
import { Button } from 'react
|
|
171
|
-
import { Toast } from 'idea-react';
|
|
189
|
+
import { Button, Toast } from 'idea-react';
|
|
172
190
|
|
|
173
191
|
export class ExamplePage extends Component {
|
|
174
192
|
toast = new Toast();
|
|
@@ -182,7 +200,7 @@ export class ExamplePage extends Component {
|
|
|
182
200
|
.open({
|
|
183
201
|
title: 'Notification',
|
|
184
202
|
body: 'Hello, world!',
|
|
185
|
-
|
|
203
|
+
theme: 'success'
|
|
186
204
|
})
|
|
187
205
|
.then(() => console.log('Toast closed'))
|
|
188
206
|
}
|
|
@@ -199,37 +217,33 @@ export class ExamplePage extends Component {
|
|
|
199
217
|
|
|
200
218
|
## Development
|
|
201
219
|
|
|
202
|
-
###
|
|
220
|
+
### Documentation
|
|
203
221
|
|
|
204
|
-
|
|
222
|
+
The [document workspace][17] provides a static website with MDX pages, theme switching,
|
|
223
|
+
and local search, adapting the upstream website to Idea React.
|
|
205
224
|
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
git tag vx.xx.x # such as v2.0.0
|
|
225
|
+
```sh
|
|
226
|
+
pnpm install
|
|
227
|
+
pnpm --filter @idea-react/document dev
|
|
210
228
|
```
|
|
211
229
|
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
```shell
|
|
215
|
-
git tag
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
4. publish code with tag version
|
|
219
|
-
|
|
220
|
-
```shell
|
|
221
|
-
git push origin master --tags # push all branches and tags on master
|
|
222
|
-
```
|
|
230
|
+
For build and deployment quick start, see the document workspace guide above.
|
|
231
|
+
Contributor conventions, validation, and release instructions are in [AGENTS.md](AGENTS.md).
|
|
223
232
|
|
|
224
233
|
[1]: https://reactjs.org/
|
|
225
234
|
[2]: https://www.typescriptlang.org/
|
|
226
235
|
[3]: https://getbootstrap.com/
|
|
227
|
-
[4]: https://
|
|
228
|
-
[5]: https://
|
|
229
|
-
[6]: https://
|
|
230
|
-
[7]: https://
|
|
231
|
-
[8]: https://
|
|
232
|
-
[9]: https://
|
|
233
|
-
[10]: https://github.com/idea2app/React
|
|
234
|
-
[11]: https://
|
|
235
|
-
[12]: https://
|
|
236
|
+
[4]: https://idea2.app/
|
|
237
|
+
[5]: https://img.shields.io/badge/Compatible-1?logo=mobx&label=MobX%206%2F7
|
|
238
|
+
[6]: https://mobx.js.org/
|
|
239
|
+
[7]: https://img.shields.io/librariesio/github/idea2app/Idea-React.svg
|
|
240
|
+
[8]: https://libraries.io/npm/idea-react
|
|
241
|
+
[9]: https://github.com/idea2app/Idea-React/actions/workflows/main.yml/badge.svg
|
|
242
|
+
[10]: https://github.com/idea2app/Idea-React/actions/workflows/main.yml
|
|
243
|
+
[11]: https://nodei.co/npm/idea-react.png?downloads=true&downloadRank=true&stars=true
|
|
244
|
+
[12]: https://npm.im/idea-react/
|
|
245
|
+
[13]: https://idea2app.github.io/React-MobX-Bootstrap-ts/
|
|
246
|
+
[14]: https://github.com/idea2app/React-MobX-Bootstrap-ts/blob/master/src/page/Component.tsx
|
|
247
|
+
[15]: https://next-bootstrap-ts.vercel.app/
|
|
248
|
+
[16]: https://github.com/idea2app/next-bootstrap-ts/blob/main/pages/component.tsx
|
|
249
|
+
[17]: document/README.md
|