@ gravity-ui/ 组件

一组复杂的反应组件建在顶部 @gravity-ui/uikit部分内容 重力UI( 重力UI) 设计系统.
安装
npm install @gravity-ui/components
使用量
@gravity-ui/uikit 需要8和18/19反应。 安装当前 UIKit 8 预放 npm install @gravity-ui/uikit@beta。 。 。 .
@gravity-ui/uikit 是一个对等依赖: 安装它, 在应用程序入口处导入它的样式, 然后将应用程序包入 Provider。该软件包中的组件不设此设置就变成无样式.
import {Provider, TextInput} from '@gravity-ui/uikit';
import {FormRow} from '@gravity-ui/components';
import '@gravity-ui/uikit/styles/fonts.css';
import '@gravity-ui/uikit/styles/styles.css';
export function App() {
return (
<Provider theme="light">
<FormRow label="Name" fieldId="name">
<TextInput id="name" name="name" />
</FormRow>
</Provider>
);
}
迁移到 UIKit 8
- 替换应用程序级别
ThemeProvider与Provider。 。 。 . - 使用
onOpenChange改为onClose内ConfirmDialog财务报告和审定财务报表ChangelogDialog。 。 。 .ConfirmDialog接受新的对话框道具,包括maxWidth财务报告和审定财务报表fullWidth改为size。 。 。 . - 删除
disableHeightTransition从ChangelogDialog和 cookie 同意弹出设置; UIKit 不再动画内容高度 . Stories财务报告和审定财务报表StoriesGroup保留onClose,带有可选事件/理由和UIKit 8 理由(escape-key, (中文(简体) ),outside-press, (中文(简体) ),click) (中文(简体) ).- 将本地 HTML 属性直接传递到按钮/ 链接道具, 包括
StoreBadge,改为extraProps。在自定义故事动作中使用 UIKit 8 按钮视图.
见 UIKit 8 迁移指南 用于基本的 API 变化。 这个软件包使用新的列表,菜单,以及没有后遗症切入点的波波弗API.
确认对话框
import {ConfirmDialog} from '@gravity-ui/components';
<ConfirmDialog
open={open}
title="Delete the project?"
message="This cannot be undone."
textButtonApply="Delete"
textButtonCancel="Cancel"
onClickButtonApply={handleDelete}
onClickButtonCancel={() => setOpen(false)}
onOpenChange={setOpen}
/>;
更多实例
每个组件在源头旁边有一个有道具和实例的README——见: src/components/<Component>/README.md。现场演示: 故事书。 。 。 .
发展
git clone [email protected]:gravity-ui/components.git
cd components
npm ci
npm run start # launches Storybook at http://localhost:7009
其他有用的命令 :
npm test # run unit tests
npm run lint # lint JS and SCSS
npm run typecheck # TypeScript type-check
捐款
欢迎捐款! 请阅读 捐款额 在提交拉动请求之前.
许可证
根据麻省理工学院的许可证分发。 见 自由主义 详细情况.
对于人工智能特工
Gravity UI的复合组件层——现成形式行、确认对话框、通知、故事、画廊和类似产品级部件组装自 @gravity-ui/uikit 原始人,所以你不会用手重建他们.
何时使用
- 窗体布局 :
FormRow(label + field + discription)代替手制标签/输入包装. - 确认流量 :
ConfirmDialog而不是编译Dialog还有两个按钮. - 产品部件 :
Notifications, (中文(简体) ),Stories编号 :StoriesGroup, (中文(简体) ),ChangelogDialog, (中文(简体) ),OnboardingMenu, (中文(简体) ),PromoSheet, (中文(简体) ),CookieConsent, (中文(简体) ),Reactions, (中文(简体) ),SharePopover, (中文(简体) ),StoreBadge。 。 。 . - 数据助手 :
InfiniteScroll, (中文(简体) ),ItemSelector, (中文(简体) ),DelayedTextInput, (中文(简体) ),TokenizedInput, (中文(简体) ),Gallery。 。 。 .
不使用时
- 基本控制、覆盖、布局和主题——使用
@gravity-ui/uikit直接;这个包只在其上方添加复合材料. - 数据网格——使用
@gravity-ui/table; 这里没有桌子. - 取日期者和日历——使用
@gravity-ui/date-components。 。 。 . - 应用程序导航弹壳(页眉、页脚)——使用
@gravity-ui/navigation。 。 。 . - Schema 驱动的表格——使用
@gravity-ui/dynamic-forms· ;FormRow只是一个布局行.
常见陷阱
- 没有 wiikit 的设置,什么也没有风格. 安装
@gravity-ui/uikit导入@gravity-ui/uikit/styles/styles.css(单位:千美元)fonts.css一次,然后将应用程序包入Provider——这个包船没有自己的全球风格. FormRow不提供输入. 通过控件为children并将其与fieldId匹配控件id; 数据label道具是标签文本,不是<label>键.ConfirmDialog没有onConfirm编号 :onCancel。 。 。 . 处理者是onClickButtonApply财务报告和审定财务报表onClickButtonCancel,以及textButtonApply编号 :textButtonCancel需要这样做.- 迷幻进口. 从软件包根导出所有 :
import {FormRow} from '@gravity-ui/components'没有子路径导入像@gravity-ui/components/FormRow。 。 。 .
AI代理的文件
安装版本的可代理读取文档位于 node_modules/@gravity-ui/components/build/docs/INDEX.md。 。 。 .