idea-react 3.0.0-beta.1 → 3.0.0-beta.2
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 +9 -1
- package/ReadMe.md +34 -6
- package/dist/index.d.mts +270 -186
- package/dist/index.d.ts +270 -186
- package/dist/index.js +16 -16
- package/dist/index.mjs +15 -15
- package/dist/style.css +0 -3
- package/package.json +1 -1
- package/source/Accordion.tsx +61 -37
- package/source/Alert.tsx +30 -15
- package/source/Avatar.tsx +55 -50
- package/source/Badge.tsx +16 -16
- package/source/Breadcrumb.tsx +36 -22
- package/source/Button.tsx +63 -69
- package/source/ButtonGroup.tsx +21 -25
- package/source/Card.tsx +67 -59
- package/source/Carousel/index.tsx +22 -21
- package/source/CloseButton.tsx +20 -15
- package/source/Collapse.tsx +74 -19
- package/source/Drawer.tsx +40 -17
- package/source/Extension/ClickBoundary.tsx +24 -5
- package/source/Extension/CodeBlock.tsx +64 -0
- package/source/Extension/Countdown.tsx +21 -9
- package/source/Extension/Editor.tsx +53 -18
- package/source/Extension/EditorHTML.tsx +7 -3
- package/source/Extension/HorizontalMarquee/index.tsx +69 -45
- package/source/Extension/Icon.tsx +15 -14
- package/source/Extension/Loading.tsx +20 -17
- package/source/Extension/MonthCalendar.tsx +26 -10
- package/source/Extension/OverlayBox.tsx +28 -15
- package/source/Extension/PageNav.tsx +16 -7
- package/source/Extension/ScrollNav/Scroller.tsx +21 -5
- package/source/Extension/ScrollNav/index.tsx +32 -7
- package/source/Extension/Select.tsx +12 -11
- package/source/Extension/SpinnerButton.tsx +19 -24
- package/source/Extension/TableSpinner.tsx +10 -14
- package/source/Extension/TextTruncate/index.tsx +17 -13
- package/source/Extension/Time.tsx +7 -5
- package/source/Extension/TimeDistance.tsx +22 -18
- package/source/Extension/Timeline/index.tsx +37 -34
- package/source/Extension/TypeEcho/Content.tsx +79 -14
- package/source/Extension/TypeEcho/index.tsx +13 -5
- package/source/Extension/UserRank/Address.tsx +17 -15
- package/source/Extension/UserRank/index.tsx +79 -84
- package/source/Extension/VerticalMarquee/index.tsx +14 -16
- package/source/Extension/ZodiacBar.tsx +40 -32
- package/source/Form/Adorn.tsx +30 -32
- package/source/Form/Checkbox.tsx +9 -5
- package/source/Form/ChipInput.tsx +9 -5
- package/source/Form/Chips.tsx +41 -39
- package/source/Form/Combobox.tsx +80 -61
- package/source/Form/Control.tsx +53 -58
- package/source/Form/DatePicker.tsx +74 -65
- package/source/Form/Feedback.tsx +18 -19
- package/source/Form/FloatingLabel.tsx +16 -19
- package/source/Form/InputGroup.tsx +27 -26
- package/source/Form/OTP.tsx +30 -12
- package/source/Form/Primitives.tsx +47 -39
- package/source/Form/Radio.tsx +25 -22
- package/source/Form/Range.tsx +30 -12
- package/source/Form/Switch.tsx +43 -40
- package/source/Grid.tsx +67 -59
- package/source/Image.tsx +10 -6
- package/source/ListGroup.tsx +57 -69
- package/source/Menu.tsx +128 -66
- package/source/NativeDialog/index.tsx +51 -29
- package/source/Nav.tsx +46 -46
- package/source/NavOverflow/index.tsx +26 -10
- package/source/Navbar.tsx +60 -55
- package/source/Pagination.tsx +63 -69
- package/source/Placeholder.tsx +47 -43
- package/source/Polymorphic.ts +57 -0
- package/source/Popover.tsx +34 -31
- package/source/Progress/index.tsx +59 -54
- package/source/ScrollSpy/index.tsx +48 -33
- package/source/Spinner.tsx +27 -23
- package/source/Stack.tsx +25 -0
- package/source/Stepper.tsx +46 -40
- package/source/Tab.tsx +40 -27
- package/source/Table.tsx +53 -42
- package/source/Toast.tsx +62 -47
- package/source/ToggleButton.tsx +40 -37
- package/source/Toggler.tsx +17 -8
- package/source/Tooltip.tsx +31 -29
- package/source/index.ts +2 -0
- package/source/Extension/CodeBlock/index.tsx +0 -58
- package/source/Extension/CodeBlock/style.module.css +0 -3
package/AGENTS.md
CHANGED
|
@@ -183,6 +183,11 @@ export class MyComponent extends ObservedComponent<MyComponentProps> {
|
|
|
183
183
|
- 向子组件透传时只解构需要特殊处理的 props,其余用 `...this.props` 展开,不逐项转发。
|
|
184
184
|
- 多个组件共享的属性定义在基础模块,组件通过 `extends`、`Omit` 或类型别名复用,不从组件文件再导出基础模块的类型。
|
|
185
185
|
- 没有成员声明体的 `interface` 改用 `type` 与交叉类型表达。
|
|
186
|
+
- 单根节点组件复用 `source/Polymorphic.ts` 的泛型与组合机制支持 `as`,透传目标组件属性;
|
|
187
|
+
片段或多根节点组件不强行添加包装节点,类组件的 `ref` 保持实例语义。
|
|
188
|
+
类组件显式声明 `declare readonly props: PolymorphicClassProps<T, Props>`,避免 React 的
|
|
189
|
+
`Readonly` 映射丢失目标属性的联合类型;内部按需使用类型收窄 getter。
|
|
190
|
+
- 用通用组件替换原生元素或已有组件时,使用 `as` 指定原元素/组件,并保留其语义、属性、事件和行为;不因替换标签而丢失原有能力。优先复用组件已有的属性透传,避免重复包装。
|
|
186
191
|
- 组件 Props 优先用 `Pick`/`Omit`/`extends` 复用已有类型,不重复声明;按外观、内容、状态、行为的顺序分组排列。
|
|
187
192
|
- JSX 属性按 `as`、HTML 通用静态属性、组件专属属性、状态属性、回调属性排序;相同键值的 props 可用对象字面量简写后展开。
|
|
188
193
|
- 同一模块的类型与值合并为一条 import,不拆成 `import type` 与 `import` 两条。
|
|
@@ -200,10 +205,13 @@ export class MyComponent extends ObservedComponent<MyComponentProps> {
|
|
|
200
205
|
- 文档站使用 ViNext,保留 MDX 支持并以纯 SSG 导出;部署静态文件,不依赖运行时服务器。
|
|
201
206
|
- 文档站页面参考上游设计,但品牌使用 **Idea React**,版本、许可证、安装命令、链接及其它文案
|
|
202
207
|
均以本项目实际情况为准;保留必要的上游版权和许可证声明。
|
|
208
|
+
- 同步上游文档时保留正文主题、章节顺序、示例覆盖与必要资源;逐段将说明和示例改写为本项目真实 API,仅删除确实不适用的内容,不将完整指南大幅缩写成 quick start。文档示例只使用本库实际导出的包路径、组件能力和已验证的官方链接。
|
|
209
|
+
- 文案中的缩写使用全大写形式(如 NPM、CSS)。
|
|
210
|
+
- 修改导航分类或路由命名时,同步更新页面标题、导航、页脚、站点链接和所有引用;确认新路由真实存在,并全局清理旧名称及失效路径。
|
|
203
211
|
- 页面格式以简洁、可读为准:文档可用 MDX,非文档页(包括首页)在能减少缩进时也可用
|
|
204
212
|
MDX,不强制非文档页只能使用 TSX 或 MDX。
|
|
205
213
|
- 跨页面共享的导航栏等结构放在公共布局中,不重复写入单个页面。
|
|
206
|
-
-
|
|
214
|
+
- 上游来源与版权许可说明集中在网站公共页脚,不在各篇组件文档重复,也不添加指向上游单页源码的链接。
|
|
207
215
|
- MDX 中的大段静态文本优先使用 Markdown,而非嵌套的 JSX 文本块。
|
|
208
216
|
- 从 `unpkg.com` 引入 Bootstrap CSS,严禁使用 Tailwind CSS 及其插件、配置和工具类。
|
|
209
217
|
- 能用 [Bootstrap 6 CSS 工具类][4] 的样式不写自定义 CSS;
|
package/ReadMe.md
CHANGED
|
@@ -12,10 +12,11 @@ A **[React][1] advanced components library** based on [TypeScript][2] & [Bootstr
|
|
|
12
12
|
|
|
13
13
|
## Versions
|
|
14
14
|
|
|
15
|
-
|
|
|
16
|
-
|
|
|
17
|
-
|
|
|
18
|
-
|
|
|
15
|
+
| SemVer | status | ES decorator | MobX | Bootstrap |
|
|
16
|
+
| :------: | :----------: | :----------: | :---------: | :-------: |
|
|
17
|
+
| `>=3` | ✅developing | stage-3 | `>=6.11` | v6 |
|
|
18
|
+
| `>=2 <3` | ❌deprecated | stage-3 | `>=6.11` | v5 |
|
|
19
|
+
| `<2` | ❌deprecated | stage-2 | `>=4 <6.11` | v5 |
|
|
19
20
|
|
|
20
21
|
## Content
|
|
21
22
|
|
|
@@ -76,7 +77,7 @@ A **[React][1] advanced components library** based on [TypeScript][2] & [Bootstr
|
|
|
76
77
|
### Extension components
|
|
77
78
|
|
|
78
79
|
1. [Click Boundary](source/Extension/ClickBoundary.tsx)
|
|
79
|
-
2. [Code Block](source/Extension/CodeBlock
|
|
80
|
+
2. [Code Block](source/Extension/CodeBlock.tsx)
|
|
80
81
|
3. [Countdown](source/Extension/Countdown.tsx)
|
|
81
82
|
4. [Dialog](source/Extension/Dialog.tsx)
|
|
82
83
|
5. [Editor](source/Extension/Editor.tsx)
|
|
@@ -136,7 +137,7 @@ For the current alpha release, use `idea-react@next` instead of `idea-react`.
|
|
|
136
137
|
rel="stylesheet"
|
|
137
138
|
href="https://unpkg.com/bootstrap@6.0.0-alpha.1/dist/css/bootstrap.min.css"
|
|
138
139
|
/>
|
|
139
|
-
<link rel="stylesheet" href="https://unpkg.com/bootstrap-icons@1.13.
|
|
140
|
+
<link rel="stylesheet" href="https://unpkg.com/bootstrap-icons@1.13.2/font/bootstrap-icons.css" />
|
|
140
141
|
<link rel="stylesheet" href="https://unpkg.com/animate.css@4.1.1/animate.min.css" />
|
|
141
142
|
<link rel="stylesheet" href="https://unpkg.com/idea-react/dist/index.css" />
|
|
142
143
|
```
|
|
@@ -157,6 +158,33 @@ Compatible with MobX 6/7:
|
|
|
157
158
|
}
|
|
158
159
|
```
|
|
159
160
|
|
|
161
|
+
### Polymorphic roots
|
|
162
|
+
|
|
163
|
+
Components with a single root support `as`, accepting an HTML tag or another React component:
|
|
164
|
+
|
|
165
|
+
```tsx
|
|
166
|
+
import { ComponentPropsWithRef, FC } from 'react';
|
|
167
|
+
import { Button, Card, PolymorphicProps } from 'idea-react';
|
|
168
|
+
|
|
169
|
+
const RouterLink: FC<ComponentPropsWithRef<'a'> & { to: string }> = ({ to, ...props }) => (
|
|
170
|
+
<a {...props} href={to} />
|
|
171
|
+
);
|
|
172
|
+
|
|
173
|
+
type LinkCardProps = PolymorphicProps<typeof RouterLink, { theme?: 'primary' }>;
|
|
174
|
+
|
|
175
|
+
<Card as="article">Article content</Card>;
|
|
176
|
+
|
|
177
|
+
<Button as={RouterLink} to="/docs" variant="solid" theme="primary">
|
|
178
|
+
Documentation
|
|
179
|
+
</Button>;
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
The target's additional props are inferred and forwarded, including required props and compatible
|
|
183
|
+
refs. Component-specific props keep their existing meaning and take precedence on name collisions.
|
|
184
|
+
Without `as`, the default markup and props stay unchanged. Class component refs still refer to the
|
|
185
|
+
component instance. Behavioral components require compatible root elements; custom roots must forward
|
|
186
|
+
their DOM props and refs. Components that render fragments or multiple roots do not support `as`.
|
|
187
|
+
|
|
160
188
|
### Dialog
|
|
161
189
|
|
|
162
190
|
```tsx
|