艾尔·迪亚勒·基特
AI DIAL UI Kit是一个已准备好的 React 组件库,旨在精简您的开发过程. 它的特点是收集一些基础组件,如按钮,输入,滴出等,以及更多——使您能够不费力地再利用元素,快速而容易地再利用.
目录
重点
- 🎨 统一用户体验: Ui Kit 的使用有助于整个 AI DIAL 应用程序的设计一致性
- ⚡ 现代堆栈: 以最新的React、 TypeScript、 Vite 和 Tailwind CSS 构建
- 🎨 高度定制: 具有CSS自定义属性的深度主题能力
- 🧪 测试合格: 与Vitest和React测试库进行综合测试覆盖(70%+)
- 📚 故事书准备:包括交互式文件和发展操场
- 🛠️ 开发者经验: 利用ESLint和Prettier来维护代码质量
- 📦 分发准备:作为国家防范机制一揽子计划部署,以方便融入
页:1
探索我们的组件及其在互动中的用途 故事书文档。 。 。 .
QQ 快速启动
先决条件
- 节点.js >= 22.2.0
- 时间:
安装
npm install @epam/ai-dial-ui-kit
基本用途
import { DialPrimaryButton } from '@epam/ai-dial-ui-kit';
import '@epam/ai-dial-ui-kit/styles.css';
function App() {
return (
<div>
<DialPrimaryButton onClick={() => alert('Hello AI DIAL!')} />
</div>
);
}
可选: Markdown 组件 CSS
如果你正在使用这个 MarkdownEditor (装入 LazyMarkdownEditor),您需要从全球导入应用程序中所需的 CSS 文件(例如,在您的根版式或主要入口):
import '@uiw/react-markdown-preview/markdown.css';
import '@uiw/react-md-editor/markdown-editor.css';
这样做可以确保每个应用程序装入CSS一次,而不是与每个组件实例捆绑,减少捆绑大小.
发展
控制下拉菜单
ButtonDropdown 接受控件 open 编号 : onOpenChange 或无控制
defaultOpen。 。 dropdownProps 转发搜索、放置和菜单大小
选项 Dropdown设置 iconAfter={null} 仅用于图标触发; 否则
默认切夫龙跟随有效的开放状态.
DropdownItem.subMenuOpen 财务报告和审定财务报表 onSubMenuOpenChange 让主机保留活动
整个演示文稿的子菜单变化。 关闭它们保存默认值
不受控制的行为。 已打开的子菜单恢复对挂载的焦点, 而
工具包拥有箭头导航、RTL布置、逃生和焦点返回. renderSubMenu
可以提供自定义内容而不包含占位符 children. 转发叶片
iconAfter 与现有残疾/危险状态并列.
先决条件
- 节点.js >= 22.2.0
- 时间:
- 图形
开发设置
-
清除还原
git clone https://github.com/epam/ai-dial-ui-kit.git cd ai-dial-ui-kit -
安装依赖关系
npm install -
启动开发环境
# Start Storybook for component development npm run storybook # Run tests in watch mode npm run test -- --watch # Start Vite dev server npm run dev
运行测试
# Run all tests with coverage
npm run test
项目结构
src/
├── components/ # React components
│ ├── Button/ # Example component
│ │ ├── Button.tsx
│ │ ├── Button.spec.tsx
│ │ └── Button.stories.tsx
│ └── ...
├── styles/ # Global styles and Tailwind configuration
│ ├── buttons.scss
│ ├── typography.scss
│ └── tailwind-entry.scss
├── types/ # TypeScript type definitions
└── index.ts # Main entry point
QQ 主题和自定义
库使用CSS自定义属性进行综合主题. 覆盖这些变量以匹配您的品牌 :
:root {
/* Background layers */
--bg-layer-0: #000000;
--bg-layer-1: #0C101D;
--bg-layer-2: #171B21;
/* Text colors */
--text-primary: ##EEF1F7;
--text-secondary: #9CA3AF;
--text-tertiary: #6B7280;
...
}
完整的变量列表可供使用 这里
2.0控件的角光度也是一样的。 每个默认 完全圆形的药丸 按钮的船,所以没有设置 保持库存 听着:
:root {
--radius-control: 12px; /* Button at standard and large size */
--radius-control-small: 8px; /* Button at ElementSize.Small */
--radius-control-icon: 9999px; /* IconButton, ToggleIconButton — any size */
}
绑定并只使用图标的按钮可按目的读取单独的变量:一种设计 想要平方动作按钮通常仍然想要其图标按钮圆形.
这些是默认的,而不是覆盖的: a rounded-* 函数传递给单个
通过控制 className 仍然赢,因为消费者的公用事业
在此软件包样式表之后发布 .
重叠堆叠
重叠在端端的门户中渲染 <body>,所以他们堆起对
主机自己的固定而粘糊糊的染色体——一个头,一个副工作表,一个嵌入式
重叠。 他们坐在一个由变数驱动的四步梯上:
| 层 | 工具 | z-index | 构成部分 |
|---|---|---|---|
| 弹出 | z-popup | var(--z-overlay, 52) | Popup 二代人的背景 |
| 浮动面板 | z-floating | --z-overlay +1 键 | Dropdown 财务报告和审定财务报表 Select 上面,子菜单, Calendar |
| 交互式小组讨论 | z-interactive-tooltip | --z-overlay +2 键 | InteractiveTooltip |
| 工具提示 | z-tooltip | --z-overlay + 3 个 | Tooltip,两代人 |
要将每个覆盖在主机层上方, 请设置一次底座 :
:root {
--z-overlay: 1000; /* popup 1000, dropdown 1001, interactive tooltip 1002, tooltip 1003 */
}
每层都是固定的台阶 所以升起底座
重新排序 : 弹出处上方仍会打开下拉和工具提示
上面的下行触发它。 设定变量打开 :root,或者在
类 a ThemeScope 重新应用到它的门户覆盖上——一个门户逃脱任何
其它的包装,所以只设置一个没有达到覆盖的值 .
单个重叠仍可自行移动:a z-* 已传递给 a
Dropdown是因为 listClassName页:1 Popup是因为 overlayClassName,一个
InteractiveTooltip是因为 contentClassName 或一个 Calendar是因为 panelClassName
代替地层本身的阶梯 而不是降落在地上,因为
mergeClasses 知道梯子公用事业是z指数.
公共类名称
一些主机需要重塑道具无法到达的部件的一部分——即:
隐藏菜单行列表、 行的半径、 图标的护身符
触发。 该工具包自己的班级是Tailwind公用事业公司和当地的散货舱,
因此,一个能到达他们的宿主, 最终在选择者 打破下一个
升级 : [class*='_selectedItem_'], (中文(简体) ), > div:nth-child(2) > button, (中文(简体) ),
[role='none'][aria-label='dropdown'] ——最后一个是无障碍
作为简单的英语字符串,它不是一个本地化的主机可以依赖的
无论是.
因此,每个设计系统2.0组件在元件上划出一个稳定的等级 这画它。 它们是作为记录出口的:
import { DIAL_KIT_CLASS } from '@epam/ai-dial-ui-kit';
DIAL_KIT_CLASS.menuItem; // 'dial-kit-menuitem'
.dial-kit-dropdown-list {
padding-block: 0;
}
.dial-kit-menuitem {
border-radius: 8px;
}
没有 dist/index.css 选择它们:它们没有申报它们
拥有并仅作为选择者存在,所以主机规则不需要 !important 它会
否则不需要。 重命名一个,或者移动到不同的元素,是一个
打破变化并经历迁移指南进程.
反馈和现状
| 密钥 | 类 | 元素 |
|---|---|---|
spinner | dial-kit-spinner | 这个 role="status" 一个根 Spinner |
progressBar | dial-kit-progress-bar | A的最外层元素 ProgressBar ——它的包装,或者没有标签或读出时的音轨 |
skeleton | dial-kit-skeleton | 一个的根 Skeleton |
notification | dial-kit-notification | 这个 Notification 表面,包括每个土司和分节信息包装 |
noDataContent | dial-kit-no-data-content | 空状态根 NoDataContent |
loginScreen | dial-kit-login-screen | 这个 section 一个根 LoginScreen |
stateScreen | dial-kit-state-screen | 这个 section 一个根 StateScreen |
liveRegion | dial-kit-live-region | 永远挂起的包 LiveRegion,或 announced. 国家 CaptionText 编号 : ErrorText |
transferQueue | dial-kit-transfer-queue | 这个 role="status" 专题小组讨论会 TransferQueue: 页眉、行和集合栏 |
文本
| 密钥 | 类 | 元素 |
|---|---|---|
highlight | dial-kit-highlight | A 的文本元素 Highlight |
captionText | dial-kit-caption-text | 字段下的标题行 |
errorText | dial-kit-error-text | 其错误变体中的说明,添加到 captionText |
label | dial-kit-label | 这个 Label 根,将它包起来 label 元素及其信息按钮 |
labelledText | dial-kit-labelled-text | 一个的根 LabelledText,将其标题和值包裹 |
集装箱
| 密钥 | 类 | 元素 |
|---|---|---|
steps | dial-kit-steps | 这个 ol 一个根 Steps |
cardShell | dial-kit-card-shell | 这个 article a 要素 CardShell |
analyticsCard | dial-kit-analytics-card | 一个的根 AnalyticsCard |
analyticsBar | dial-kit-analytics-bar | 一个的根 AnalyticsBar,叠叠或内置 |
analyticsBarGroup | dial-kit-analytics-bar-group | 一个的根 AnalyticsBarGroup它的手风琴 |
analyticsHistogram | dial-kit-analytics-histogram | 一个的根 AnalyticsHistogram |
collapsibleSidebar | dial-kit-collapsible-sidebar | 这个 aside a 要素 CollapsibleSidebar |
resizableContainer | dial-kit-resizable-container | A 内的内容框 ResizableContainer调整框架大小 |
resizeHandle | dial-kit-resize-handle | 这个 role="separator" a 要素 ResizeHandle |
popup | dial-kit-popup | 这个 role="dialog" 专题小组讨论会 Popup |
bottomSheet | dial-kit-bottom-sheet | 这个 role="dialog" 专题小组讨论会 BottomSheet |
bottomSheetOverlay | dial-kit-bottom-sheet-overlay | 一、背景 BottomSheet,它主持小组讨论 |
sideDrawer | dial-kit-side-drawer | 这个 role="dialog" 专题小组讨论会 SideDrawer,打开或关闭 |
confirmationPopup | dial-kit-confirmation-popup | A 类 ConfirmationPopup面板,添加剂 popup |
accordion | dial-kit-accordion | 一个的根 Accordion |
folderPath | dial-kit-folder-path | 面包屑的根部 一种 FolderPath |
breadcrumbs | dial-kit-breadcrumbs | 这个 nav a 要素 Breadcrumbs 线索 |
breadcrumbsItem | dial-kit-breadcrumbs-item | 其一段: 绘制标签的链接、 按钮或跨度 |
菜单和封面
| 密钥 | 类 | 元素 |
|---|---|---|
dropdown | dial-kit-dropdown | 扳机包装 a Dropdown |
dropdownList | dial-kit-dropdown-list | 这个 role="none" 子菜单列表。 两代人 |
dropdownSearch | dial-kit-dropdown-search | A 项列表上方的搜索行 searchable Dropdown |
menuItem | dial-kit-menuitem | 一个倒行:一个倒行项目,一个 Select 选项,子菜单触发器或子程序 |
menuItemCheck | dial-kit-menuitem-check | 选中的跟踪检查 MenuItemMark.Check 横行 |
tooltip | dial-kit-tooltip | 一个气泡 Tooltip |
interactiveTooltip | dial-kit-interactive-tooltip | 一个小组 InteractiveTooltip |
ellipsisTooltip | dial-kit-ellipsis-tooltip | A 的文本元素 EllipsisTooltip,这也是它的触发 |
字段
| 密钥 | 类 | 元素 |
|---|---|---|
search | dial-kit-search | 这个 Search 字段框,添加到 dial-kit-input |
passwordInput | dial-kit-password-input | 这个 PasswordInput 字段框,添加到 dial-kit-input |
numberInput | dial-kit-number-input | 这个 NumberInput 字段框,添加到 dial-kit-input |
tagInput | dial-kit-tag-input | 这个 TagInput 字段框,添加到 dial-kit-input |
autocompleteTagInput | dial-kit-autocomplete-tag-input | 这个 AutocompleteTagInput 字段框,添加到 dial-kit-input |
select | dial-kit-select | 一个的根 Select |
inlineSelect | dial-kit-inline-select | 一个的触发按钮 InlineSelect |
calendar | dial-kit-calendar | 一个的根 Calendar,在每个模式下 |
schemaRenderer | dial-kit-schema-renderer | 一个的根 SchemaRenderer |
schemaRendererSection | dial-kit-schema-renderer-section | 一个相撞 SchemaRenderer 区名片,任何深度 |
fileDropzone | dial-kit-file-dropzone | 降水面积 FileDropzone |
fileIcon | dial-kit-file-icon | 一个的根 FileIcon:glyph或spinner, 和共享徽章 |
fileName | dial-kit-file-name | 排队 FileName: 其类型图标、名称和任何细节 |
folderName | dial-kit-folder-name | 这个 FileName 单行 FolderName,添加剂 fileName |
sharedEntityIndicator | dial-kit-shared-entity-indicator | 一个徽章 SharedEntityIndicator,包括a FileIcon |
badge | dial-kit-badge | 一个的根 Badge:标签框,带有其图标 |
avatar | dial-kit-avatar | 一个的根 Avatar:图像,或替换它的首字母框 |
entityIdentity | dial-kit-entity-identity | 一个根行 EntityIdentity: 图标、类型标签、名称和版本 |
selectedEntityCard | dial-kit-selected-entity-card | 一个边框卡 SelectedEntityCard,而不是同样持有错误的包装 |
formSection | dial-kit-form-section | 这个 section 一个根 FormSection: 标题行、描述和内容 |
radioGroupPopupField | dial-kit-radio-group-popup-field | 一个的根 RadioGroupPopupField |
控件
| 密钥 | 类 | 元素 |
|---|---|---|
switch | dial-kit-switch | 排队 Switch: 控件及其标签 |
checkbox | dial-kit-checkbox | 排队 Checkbox |
checkboxBox | dial-kit-checkbox-box | 装饰盒 a CheckboxBox 绘图 |
radio | dial-kit-radio | 排队 Radio |
radioGroup | dial-kit-radio-group | 一个的根 RadioGroup |
segmentedControl | dial-kit-segmented-control | 这个 role="radiogroup" 轨道 a SegmentedControl |
segmentedControlItem | dial-kit-segmented-control-item | 其中一个部分 |
tabs | dial-kit-tabs | A的最外层元素 Tabs ——标题包,或没有标签时的标签列表 sectionLabel |
tabList | dial-kit-tab-list | 这个 role="tablist" 里面,无论是方向 |
tab | dial-kit-tab | 里面有一个标签 |
tabSelected | dial-kit-tab-selected | 选择的标签, 无论是方向 |
tabsSectionLabel | dial-kit-tabs-section-label | 这个 sectionLabel 标题a Tabs |
tag | dial-kit-tag | A 类 Tag 避孕药,包括 TagInput'行数 |
filterChips | dial-kit-filter-chips | 这个 role="group" 单行 FilterChips;其芯片携带 dial-kit-tag |
toggleIconButton | dial-kit-toggle-icon-button | A 类 ToggleIconButton,添加剂 dial-kit-base-icon-button |
toggleChip | dial-kit-toggle-chip | 这个 <button aria-pressed> 页:1 ToggleChip |
closeButton | dial-kit-close-button | A 类 CloseButton,添加剂 dial-kit-base-icon-button |
infoButton | dial-kit-info-button | 一个 InfoButton,添加剂 dial-kit-base-icon-button |
buttonDropdown | dial-kit-button-dropdown | 包装 a ButtonDropdown |
没有条目的部件,为什么
故意没有2.0个组件,因为主机会 目标已包含一个稳定的类别 :
| 构成部分 | 已经瞄准了 |
|---|---|
Button 及其6个可变包装 | dial-kit-base-button (加上每变种类,例如: dial-kit-primary-solid-button(中文(简体) ) |
IconButton 及其五个可变包装 | dial-kit-base-icon-button |
FabButton | dial-kit-fab-button |
Input | dial-kit-input |
Textarea | dial-kit-textarea |
Slider | dial-kit-slider |
MarkdownEditor | dial-kit-markdown-editor |
Grid | dial-kit-grid (以 GRID_ROOT_CLASS(中文(简体) ) |
5个没有自己的因素,通过什么解决
它们使: ThemeScope 联合国 display: contents 包装器, MultiSelectTags
(单位:千美元)Tags),(c), TooltipContainer 编号 : TooltipTrigger,以及 ErrorBoundary (数量)
LiveRegion 倒计时 StateScreen) (中文(简体) ).
取而代之的是两个相邻的元素通过道具得到,并继续是:
Dropdown浮动面板取出 listClassName,则a Popup背景情况
带 overlayClassName。 。 。 .
* 无障碍
只命名图标控件
DialFabButton, (中文(简体) ), DialIconButton,以及 IconButton 因此,他们需要
明确易取名称。 过 aria-label; 如果您只通过一个字符串
tooltipProps.tooltip,则用作标签。 不依赖工具提示
单独传送名称——工具提示 aria-describedby 在包装元素上着陆
而不是在控制, 和工具提示完全压制 在移动.
InfoButton 名称本身来自 caption 出于同样的原因。 传个短
aria-label 当标题是完整的句子时,该名称仍可扫描.
目标规模(WCAG 2.5.5,AA级)
标准大小的按钮在40×40时渲染,但显示 44x44指针目标 通过
dial-kit-enhanced-target 工具,以透明方式增加目标
伪相相. 可见控件不变,所以布局保持其已有
度量衡。 WCAG 2.5.5 测量接受指向动作的区域,而不是
可见的装饰.
44px 目标控制太小,无法清除邻国的使用
dial-kit-minimum-target 相反,它应用相同的伪元素在
AA级最低为24×24 (WCAG 2.5.8.
这些控制是 有记录的例外情况 并符合AA级(2.5.8、24×24),但 非自动取款机 :
| 控制权 | 大小 | 为什么它被排除在外 |
|---|---|---|
ElementSize.Small 变体 | 24x24 (中文(简体) ) | 44px 目标上架 10px 每边, 并会在密集工具栏中重叠相邻的控制 |
ButtonAppearance.Link | 内容 | 2.5.5规定的豁免 内入 例外; 扩展后将会与副本相重叠 |
DialCloseButton | 图标大小 | 渲染器 h-auto w-auto,因此其目标跟随呼叫者的图标大小 |
DialInfoButton, (中文(简体) ), InfoButton | 24x24 (中文(简体) ) | 固定的小额支付,与小变体相同的重叠制约 |
标准2.0字段( Y)Input, (中文(简体) ), Select, (中文(简体) ), RadioGroupPopupField(中文(简体) ) | 40px高个 | 指针目标横跨全字段宽度,但保持4px相差44个垂直;高度是共享形式设计符号,而不是每个控制选择. .dial-kit-input 剪接它的外溢,所以伪元素 也无法生长目标 |
Tag 删除按钮 | 已交付 16x16 | 达到24x24通过 dial-kit-minimum-target;44px目标将超过每侧14px并吞入相邻的标记 a TagInput 横行 |
可点击 Tag | 高32平方圆 | 一个44px目标将每边挂上6px并吞入过滤行相邻的芯片;标记已经比两个轴上24px宽 |
ToggleChip | 高32平方圆 | 与可点击的药片相同 Tag:44px目标会每边挂出6px并吞下相邻的切行芯片;芯片已经比两轴上24px宽 |
Radio 圆 | 已交付 20x20 | 达到24x24通过 dial-kit-minimum-target44px目标将覆盖每边12px,吞下相邻的标签。 点击标签会选择收音机, 因此实际目标范围更广 |
Checkbox 选项框 | 已交付 20x20 | 达到24x24通过 dial-kit-minimum-target44px目标将覆盖每边12px,吞下相邻的标签。 点击标签切换复选框, 因此实际目标更宽 |
Slider 音轨行 | 24px 高个 | 指针目标横跨整个轨道宽度,但只有24px高;一行44px会给滑动器所坐入的每一个形式增加20px的死地空间,拇指被拖取而未被取出 |
Breadcrumbs 段链接 | 内容 | 2.5.5规定的豁免 内入 例外——一段是一行案文中的文本链接,扩大段将与其相重叠 |
Breadcrumbs 溢出按钮 | 已交付 16x16 | 达到24x24通过 dial-kit-minimum-target;44px目标会超过每侧14px,并吞入其两侧的分块入入内径 |
SegmentedControl 部分 | 高32平方圆 | 从相邻的40px轨道中坐入4px,所以44px目标会将每侧6px挂上并吞入相邻的区段;区段已经比两轴上24px宽 |
ResizeHandle | 8px 宽指针条 | 手柄必须精确地坐到面板边界上,这样一个44px宽的条会吞下其两侧的内容——对控制至关重要. 这是一种焦点 separator,因此调整大小也可以从键盘中取出并带有箭头键 |
ResizableContainer 调整手柄大小 | 10px 宽指针条 | 手柄必须精确地坐到面板边界上,这样一个44px宽的条会吞下其两侧的内容——对控制至关重要. 这是一种焦点 separator,因此调整大小也可以从键盘中取出并带有箭头键 |
如果您需要达到, 请给周围空间至少20px 个小变量控制 特定布局中的AAA,或者取而代之使用标准大小.
· 故事本
故事书是一个方便的图书馆,用于记录和发展UI组件.
故事
要运行完全互动的故事手册 :
开发模式
npm run storybook
# Open http://localhost:6006
生产建设
npm run build-storybook
生产开始
npx http-server ./storybook-static
# Open http://127.0.0.1:8080/
文档
只运行文档 :
开发模式
npm run storybook-docs
# Open http://localhost:54800/
生产建设
npm run build-storybook-docs
生产开始
npx http-server ./storybook-static
# Open http://127.0.0.1:8080/
故事书规定:
- 交互式组件文档
- * 视觉测试操场
- * 无障碍测试工具
- 适应性设计测试
- * 组件隔离
项目使用量
Next.js 一体化
- 安装软件包 。 反应是唯一的同伴,你必须提供的一切 包里装的,它自己装的.
npm install @epam/ai-dial-ui-kit
npm install react react-dom
仅在使用 Markdown 编辑器的情况下添加编辑器包
(单位:千美元)LazyMarkdownEditor) (中文(简体) ). 这是一个可选的对等者,所以 npm install 保持安静
没有它,而工具箱只有在编辑器实际挂载时才到达:
npm install @uiw/react-md-editor
- 项目根版式中的导入样式 :
// app/layout.tsx
import "@epam/ai-dial-ui-kit/styles.css";
- 用法实例
// app/page.tsx
"use client";
import { DialPrimaryButton } from "@epam/ai-dial-ui-kit";
export default function Home() {
return (
<div className="w-full h-full flex flex-col gap-3 items-center justify-center">
<h1>Test library</h1>
<DialPrimaryButton onClick={() => alert('Hello AI DIAL!')} />
</div>
);
}
树摇
只导入所需的组件 :
// ✅ Good - Tree shakable imports
import { DialPrimaryButton, DialInput } from '@epam/ai-dial-ui-kit';
import '@epam/ai-dial-ui-kit/styles.css'; // Import styles separately
// ❌ Avoid - Imports entire library
import * as UIKit from '@epam/ai-dial-ui-kit';
QQ AI 代理 MCP 服务器
AI DIAL UI Kit包括一个内置的 MCP( 模式上下文协议) 服务器 使人工智能代理人能够按程序发现组件、类型、钩子和公用事业。 这使得AI助手可以在不产生幻觉的情况下生成准确,类型安全的组件代码.
构成部分成果排名 首先生成 2.0 ——当前设计系统,导出时无 Dial 前缀——和每个遗产 Dial* 元件在 2. 0 替换时点出,所以代理默认降落在正确的组件上.
关于设置、配置和详细资源,见 MCP 服务器指南。 。 。 .
捐款
我们欢迎捐款! 请看我们的 贡献指南 详细情况如下:
- 代码样式准则
- 测试要求
- 请求程序
• 警卫
如果你发现安全漏洞 请参考我们 安全政策。 。 。 .
许可证
Apache 2.0 (英语) - 看这个 自由主义 详细文件.
有关项目
- 大赦国际 - 所有AI拨号项目的入站点
由 Q 制作 EPAM 系统