rujian-ui-kit 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,29 @@
+rujian-ui-kit
+Copyright 2026 sungbin <chengbin@3578.cn>
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+This product includes icon shapes from Tabler Icons (https://tabler.io/icons),
+licensed under the MIT License:
+
+MIT License
+
+Copyright (c) 2020-2026 Paweł Kuna
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,67 @@
-# Temporary Holding Version
+# rujian-ui-kit
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+如见的 React 界面组件库：设计令牌、深浅两套主题和常用控件（按钮、输入、选择、下拉、菜单、表格、列表、面板、对话框、通知、悬停提示等），供如见桌面客户端与网站共用。
+
+## 安装
+
+环境要求：Node.js 22.12 及以上，React 18.3 或 19。
+
+```bash
+npm install rujian-ui-kit
+```
+
+## 使用
+
+在应用入口引入一次样式表，在根组件外包一层 `UiProvider`，并在 `html` 元素上写主题类：
+
+```tsx
+import 'rujian-ui-kit/styles.css';
+import { Button, UiProvider, themeClassName, useNotify } from 'rujian-ui-kit';
+
+document.documentElement.classList.add(themeClassName('dark'));
+
+function SaveButton() {
+  const notify = useNotify();
+  return <Button onClick={() => notify('已保存', 'success')}>保存</Button>;
+}
+
+export function App() {
+  return (
+    <UiProvider>
+      <SaveButton />
+    </UiProvider>
+  );
+}
+```
+
+- 主题：`html` 元素上的 `theme-dark` 或 `theme-light` 类决定颜色；切换主题只换这个类。
+- 对话框：`useDialog()` 提供 `openDialog`、`openPage`、`alert`、`confirm`、`confirmDiscard`、`confirmDelete`。
+- 通知：`useNotify()` 返回发通知的函数，级别为 `info`、`success`、`warning`、`error`。
+- 悬停提示：元素写 `title` 属性即可；需要标题与分条说明时用 `useTooltip`。
+- 按钮图标按文字自动匹配；应用自己的按钮文字用 `registerIconRules` 登记规则。
+
+### 在 Next.js 中使用
+
+构建产物开头带 `'use client'`，服务端组件可以直接引入组件库的组件。在 `app/layout.tsx` 中引入样式表，把主题类写在 `<html>` 上，并用 `UiProvider` 包住页面内容。
+
+## 开发
+
+```bash
+npm install
+npm run storybook        # 在 http://localhost:6006 预览全部组件
+npm test                 # 运行测试
+npm run typecheck        # 类型检查
+npm run build            # 构建到 dist
+npm run check            # 依次运行类型检查、测试与构建
+```
+
+发布新版本：修改 `package.json` 的 `version`，提交后运行 `npm publish`（发布前会自动运行 `npm run check`），再打同名标签（如 `v0.2.0`）并推送。
+
+## 限制
+
+- 对话框正文渲染在 `UiProvider` 所在位置，只能使用 `UiProvider` 外层的上下文（React Context）。
+- 自绘滚动条只在 Chromium 内核中生效，其他浏览器使用系统滚动条。
+
+## 许可证
+
+[Apache-2.0](LICENSE)。图标图形取自 [Tabler Icons](https://tabler.io/icons)（MIT 许可），声明见 [NOTICE](NOTICE)。

package/dist/base/LayerPortal.d.ts

@@ -0,0 +1,23 @@
+import { type ReactNode } from 'react';
+import './ui-layer.css';
+/**
+ * 取得文档里唯一的层容器，没有或已被移除时新建。
+ * @param ownerDocument 文档。
+ * @returns 层容器元素。
+ */
+export declare function getLayerContainer(ownerDocument: Document): HTMLElement;
+/** 弹层传送门的属性。 */
+export interface LayerPortalProps {
+    /** 渲染到层容器中的内容。 */
+    children: ReactNode;
+}
+/**
+ * 是否已在浏览器中渲染：服务端渲染与水合时为 false，之后为 true。
+ * @returns 是否在浏览器中。
+ */
+export declare function useIsClient(): boolean;
+/**
+ * 把内容渲染到层容器中；服务端渲染与水合时不输出，之后的渲染同步输出，弹层可在绘制前定位。
+ * @param props 属性。
+ */
+export declare function LayerPortal({ children }: LayerPortalProps): import("react").ReactPortal | null;

package/dist/base/choice-options.d.ts

@@ -0,0 +1,29 @@
+/** 对象形式的选项。 */
+export interface ChoiceOptionObject {
+    /** 选项值。 */
+    value: string;
+    /** 显示文字，缺省同值。 */
+    label?: string;
+    /** 是否禁用：显示但不能选中。 */
+    disabled?: boolean;
+    /** 第二行说明（下拉弹层中显示）。 */
+    description?: string;
+    /** 悬停提示，常用来说明禁用原因。 */
+    tooltip?: string;
+}
+/** 选项：字符串的值与文字相同。 */
+export type ChoiceOption = string | ChoiceOptionObject;
+/** 规范化后的选项。 */
+export interface NormalizedOption {
+    value: string;
+    label: string;
+    disabled: boolean;
+    description: string;
+    tooltip: string;
+}
+/**
+ * 把选项规范化为统一形状；字符串选项的值与文字相同，默认不禁用，没有说明和悬停提示。
+ * @param options 选项。
+ * @returns 规范化后的选项数组。
+ */
+export declare function normalizeOptions(options: readonly ChoiceOption[]): NormalizedOption[];

package/dist/base/class-names.d.ts

@@ -0,0 +1,8 @@
+/** 可参与拼接的类名片段；空值与 false 会被跳过。 */
+export type ClassNamePart = string | false | null | undefined;
+/**
+ * 拼接类名。
+ * @param parts 类名片段。
+ * @returns 用空格连接的类名；没有有效片段时为空串。
+ */
+export declare function classNames(...parts: ClassNamePart[]): string;

package/dist/base/controllable-state.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 受控与非受控两用的状态。
+ * @param value 受控值；undefined 表示非受控。
+ * @param defaultValue 非受控时的初始值。
+ * @param onChange 值变化时的回调。
+ * @returns 当前值与设置函数；设置相同的值不回调。
+ */
+export declare function useControllableState<T>(value: T | undefined, defaultValue: T, onChange?: (next: T) => void): [T, (next: T) => void];

package/dist/base/field-context.d.ts

@@ -0,0 +1,35 @@
+/** 字段向控件提供的关联信息。 */
+export interface FieldContextValue {
+    /** 控件聚焦目标的 id，标签用 for 指向它。 */
+    controlId: string;
+    /** 标签元素的 id；没有标签时为 undefined。 */
+    labelId: string | undefined;
+    /** 说明与错误元素的 id，空格分隔。 */
+    describedBy: string;
+    /** 是否校验失败。 */
+    invalid: boolean;
+}
+/** 字段上下文；不在字段中时为 null。 */
+export declare const FieldContext: import("react").Context<FieldContextValue | null>;
+/** 控件自己传入的关联属性。 */
+export interface FieldControlOverrides {
+    id?: string | undefined;
+    invalid?: boolean | undefined;
+    'aria-labelledby'?: string | undefined;
+    'aria-describedby'?: string | undefined;
+}
+/** 控件最终使用的关联属性。 */
+export interface FieldControlProps {
+    id: string | undefined;
+    invalid: boolean;
+    'aria-labelledby': string | undefined;
+    'aria-describedby': string | undefined;
+    'aria-invalid': true | undefined;
+}
+/**
+ * 合并字段上下文与控件自己的属性。
+ * @param overrides 控件自己传入的属性，优先使用。
+ * @param labelable 控件能否被 label for 关联（原生输入、文本域）；不能时用 aria-labelledby 关联标签。
+ * @returns 控件应设置到聚焦目标或承载 aria 的元素上的属性。
+ */
+export declare function useFieldControl(overrides: FieldControlOverrides, labelable: boolean): FieldControlProps;

package/dist/base/isomorphic-layout-effect.d.ts

@@ -0,0 +1,3 @@
+import { useLayoutEffect } from 'react';
+/** 浏览器中为 useLayoutEffect，服务端为 useEffect。 */
+export declare const useIsomorphicLayoutEffect: typeof useLayoutEffect;

package/dist/base/merge-refs.d.ts

@@ -0,0 +1,7 @@
+import type { Ref, RefCallback } from 'react';
+/**
+ * 合并多个 ref 为一个回调 ref。
+ * @param refs 要同步赋值的 ref。
+ * @returns 回调 ref。
+ */
+export declare function mergeRefs<T>(...refs: Array<Ref<T> | undefined>): RefCallback<T>;

package/dist/base/pointer-tracking.d.ts

@@ -0,0 +1,9 @@
+import type { PointerEvent as ReactPointerEvent } from 'react';
+/**
+ * 跟踪一次拖动。
+ * @param target 接收指针事件的元素（会捕获指针，移出元素后仍能收到事件）。
+ * @param downEvent 按下事件。
+ * @param onMove 移动时回调，参数为相对按下点的位移。
+ * @param onEnd 结束时回调。
+ */
+export declare function trackPointer(target: HTMLElement, downEvent: PointerEvent | ReactPointerEvent, onMove: (deltaX: number, deltaY: number) => void, onEnd?: () => void): void;

package/dist/base/text-format.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 值统一转为文本，空值（undefined、null）按空串。
+ * @param value 任意值。
+ * @returns 文本。
+ */
+export declare function toText(value: unknown): string;
+/**
+ * 字节数的可读文字：按 1024 进位，单位 B、KB、MB、GB；B 取整，其余保留一位小数，如“1.5 MB”。
+ * @param size 字节数。
+ * @returns 可读大小。
+ */
+export declare function formatBytes(size: number): string;

package/dist/components/audio-preview/AudioPreview.d.ts

@@ -0,0 +1,30 @@
+import './ui-audio-preview.css';
+/** 音频来源：地址，或 MIME 类型加不带前缀的 Base64 内容。 */
+export type AudioSource = {
+    src: string;
+} | {
+    mime: string;
+    data: string;
+};
+/** 试听的属性。 */
+export interface AudioPreviewProps {
+    /** 读取音频；读取失败时由调用方提示原因并返回 undefined。 */
+    load: () => Promise<AudioSource | undefined>;
+    /** 空闲时的按钮文字，默认“试听”。 */
+    text?: string;
+    /** 播放时的按钮文字，默认“停止”。 */
+    stopText?: string;
+    /** 空闲时的可访问名称，同一页有多个试听按钮时用来区分；播放时自动变为“停止”加这个名称。 */
+    'aria-label'?: string;
+    /** 只显示图标。 */
+    iconOnly?: boolean;
+    /** 紧凑尺寸，默认 true。 */
+    compact?: boolean;
+    /** 追加的类名。 */
+    className?: string;
+}
+/**
+ * 试听。
+ * @param props 属性。
+ */
+export declare function AudioPreview({ load, text, stopText, iconOnly, compact, className, ...aria }: AudioPreviewProps): import("react").JSX.Element;

package/dist/components/audio-preview/index.d.ts

@@ -0,0 +1 @@
+export { AudioPreview, type AudioPreviewProps, type AudioSource } from './AudioPreview';

package/dist/components/button/Button.d.ts

@@ -0,0 +1,31 @@
+import { type ButtonHTMLAttributes, type ReactNode } from 'react';
+import { type IconName, type IconPosition } from '../icons';
+import './ui-button.css';
+/** 按钮样式。 */
+export type ButtonVariant = 'primary' | 'secondary' | 'danger' | 'accent' | 'ghost' | 'link';
+/** 操作预设。 */
+export type ButtonKind = 'add' | 'edit' | 'delete';
+/** 按钮的属性；其余属性透传给 button 元素。 */
+export interface ButtonProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'children'> {
+    /** 按钮文字；用 kind 时缺省为预设文字。纯图标按钮的文字作为可访问名称。 */
+    children?: ReactNode;
+    /** 使用“添加/修改/删除”预设（样式、默认文字、图标），children 与 variant 可覆盖。 */
+    kind?: ButtonKind;
+    /** 样式，默认 secondary；ghost 平时无底色，link 显示为嵌在文字里的链接。 */
+    variant?: ButtonVariant;
+    /** 指定图标覆盖自动匹配；false 不显示图标。 */
+    icon?: IconName | false;
+    /** 图标在文字前（start）或后（end）；缺省按匹配规则，规则未指定时在前。 */
+    iconPosition?: IconPosition;
+    /** 只显示图标，文字作为可访问名称；没有图标时仍显示文字。 */
+    iconOnly?: boolean;
+    /** 紧凑按钮（表格行内操作），只有最小宽度不同。 */
+    compact?: boolean;
+    /** 切换按钮的按下状态；undefined 表示不是切换按钮。 */
+    pressed?: boolean;
+}
+/**
+ * 按钮。
+ * @param props 属性。
+ */
+export declare const Button: import("react").ForwardRefExoticComponent<ButtonProps & import("react").RefAttributes<HTMLButtonElement>>;

package/dist/components/button/index.d.ts

@@ -0,0 +1 @@
+export { Button, type ButtonKind, type ButtonProps, type ButtonVariant } from './Button';

package/dist/components/choice-controls/Checkbox.d.ts

@@ -0,0 +1,27 @@
+import './ui-choice-controls.css';
+/** 复选框的属性。 */
+export interface CheckboxProps {
+    /** 选项文字。 */
+    label: string;
+    /** 受控的勾选状态。 */
+    checked?: boolean;
+    /** 非受控时的初始状态。 */
+    defaultChecked?: boolean;
+    /** 禁用。 */
+    disabled?: boolean;
+    /** 校验失败。 */
+    invalid?: boolean;
+    /** 元素 id。 */
+    id?: string;
+    /** 可访问名称，缺省为文字。 */
+    'aria-label'?: string;
+    /** 追加的类名。 */
+    className?: string;
+    /** 勾选状态变化时回调。 */
+    onChange?: (checked: boolean) => void;
+}
+/**
+ * 复选框。
+ * @param props 属性。
+ */
+export declare function Checkbox({ label, checked, defaultChecked, disabled, invalid, id, className, onChange, ...aria }: CheckboxProps): import("react").JSX.Element;

package/dist/components/choice-controls/CheckboxGroup.d.ts

@@ -0,0 +1,31 @@
+import { type ChoiceOption } from '../../base/choice-options';
+import { type ChoiceDirection } from './choice-group-class';
+import './ui-choice-controls.css';
+/** 复选框组的属性。 */
+export interface CheckboxGroupProps {
+    /** 选项；单个选项可禁用。 */
+    options: readonly ChoiceOption[];
+    /** 受控的已选值。 */
+    value?: readonly string[];
+    /** 非受控时的初始已选值。 */
+    defaultValue?: readonly string[];
+    /** 排列方向，默认 vertical。 */
+    direction?: ChoiceDirection;
+    /** 整组禁用。 */
+    disabled?: boolean;
+    /** 校验失败。 */
+    invalid?: boolean;
+    /** 根元素 id。 */
+    id?: string;
+    /** 可访问名称；在 Field 中时由标签提供。 */
+    'aria-label'?: string;
+    /** 追加到根元素的类名。 */
+    className?: string;
+    /** 已选值变化时回调，按选项顺序排列。 */
+    onChange?: (value: readonly string[]) => void;
+}
+/**
+ * 复选框组。
+ * @param props 属性。
+ */
+export declare function CheckboxGroup({ options, value, defaultValue, direction, disabled, invalid, id, className, onChange, ...aria }: CheckboxGroupProps): import("react").JSX.Element;

package/dist/components/choice-controls/ChoiceItem.d.ts

@@ -0,0 +1,13 @@
+import { type HTMLAttributes } from 'react';
+/** 选项元素的属性。 */
+export interface ChoiceItemProps extends Omit<HTMLAttributes<HTMLDivElement>, 'role'> {
+    role: 'radio' | 'checkbox';
+    label: string;
+    checked: boolean;
+    disabled: boolean;
+}
+/**
+ * 单个选项元素。
+ * @param props 属性。
+ */
+export declare const ChoiceItem: import("react").ForwardRefExoticComponent<ChoiceItemProps & import("react").RefAttributes<HTMLDivElement>>;

package/dist/components/choice-controls/RadioGroup.d.ts

@@ -0,0 +1,33 @@
+import { type ChoiceOption } from '../../base/choice-options';
+import { type ChoiceDirection } from './choice-group-class';
+import './ui-choice-controls.css';
+/** 单选组的属性。 */
+export interface RadioGroupProps {
+    /** 选项；单个选项可禁用，tooltip 常用来说明禁用原因。 */
+    options: readonly ChoiceOption[];
+    /** 受控值，未选为空串。 */
+    value?: string;
+    /** 非受控时的初始值。 */
+    defaultValue?: string;
+    /** 排列方向，默认 vertical。 */
+    direction?: ChoiceDirection;
+    /** segmented 时选项等宽排成一行。 */
+    variant?: 'segmented';
+    /** 整组禁用。 */
+    disabled?: boolean;
+    /** 校验失败。 */
+    invalid?: boolean;
+    /** 根元素 id。 */
+    id?: string;
+    /** 可访问名称；在 Field 中时由标签提供。 */
+    'aria-label'?: string;
+    /** 追加到根元素的类名。 */
+    className?: string;
+    /** 选中项变化时回调。 */
+    onChange?: (value: string) => void;
+}
+/**
+ * 单选组。
+ * @param props 属性。
+ */
+export declare function RadioGroup({ options, value, defaultValue, direction, variant, disabled, invalid, id, className, onChange, ...aria }: RadioGroupProps): import("react").JSX.Element;

package/dist/components/choice-controls/Switch.d.ts

@@ -0,0 +1,25 @@
+import './ui-choice-controls.css';
+/** 开关的属性。 */
+export interface SwitchProps {
+    /** 左侧文字，同时作为可访问名称。 */
+    label: string;
+    /** 受控的开启状态。 */
+    checked?: boolean;
+    /** 非受控时的初始状态。 */
+    defaultChecked?: boolean;
+    /** 禁用。 */
+    disabled?: boolean;
+    /** 校验失败。 */
+    invalid?: boolean;
+    /** 开关按钮的 id。 */
+    id?: string;
+    /** 追加到行元素的类名。 */
+    className?: string;
+    /** 开启状态变化时回调。 */
+    onChange?: (checked: boolean) => void;
+}
+/**
+ * 开关。
+ * @param props 属性。
+ */
+export declare function Switch({ label, checked, defaultChecked, disabled, invalid, id, className, onChange }: SwitchProps): import("react").JSX.Element;