@ cleartrip/ct-design- 组件
Cleartrip 设计系统的核心组件收藏
概览
@cleartrip/ct-design-components 是Cleartrip Design系统中的一款基础软件包,为React和React Independent应用程序提供基本的UI组件并有跨平台支持. 这个软件包侧重于核心布局和容器组件,具有诸如随机反馈支持等高级特性.
安装
# npm
npm install @cleartrip/ct-design-components
# yarn
yarn add @cleartrip/ct-design-components
# pnpm
pnpm add @cleartrip/ct-design-components
构成部分
集装箱
具有多功能的集装箱部分,作为基础布局要素,支持随机反馈、事件处理和灵活造型.
特征
- 跨平台: 在回放和回放上无缝工作
- 快速反馈: 以自定义的强度构建随机反馈支持
- 弹性渲染: 支持多种 HTML 语义元素(
main, (中文(简体) ),section, (中文(简体) ),article, (中文(简体) ),div, (中文(简体) ),p(中文(简体) ) - 事件处理: 鼠标事件、点击处理器和布局更改调用
- 无障碍: 重点管理和衡量能力
- 样式: 自定义样式配置及设计系统集成
基本用途
import { Container } from '@cleartrip/ct-design-components';
function App() {
return (
<Container
as="main"
onClick={(event) => console.log('Container clicked')}
styleConfig={{
root: [{ padding: '16px', backgroundColor: '#f5f5f5' }]
}}
>
<h1>Welcome to Cleartrip</h1>
<p>Your content goes here...</p>
</Container>
);
}
快速反馈
<Container
hapticEnabled={true}
hapticVariant="subtle"
hapticRepeat={false}
onClick={() => console.log('Haptic feedback triggered')}
>
Interactive content with haptic feedback
</Container>
高级使用参考文献
import { Container, ContainerRef } from '@cleartrip/ct-design-components';
import { useRef } from 'react';
function MyComponent() {
const containerRef = useRef<ContainerRef>(null);
const handleFocus = () => {
containerRef.current?.focus();
};
const measureContainer = () => {
containerRef.current?.measure((x, y, width, height, pageX, pageY) => {
console.log('Container dimensions:', { x, y, width, height, pageX, pageY });
});
};
return (
<Container
ref={containerRef}
onLayout={(event) => console.log('Layout changed:', event.layout)}
onMouseEnter={() => console.log('Mouse entered')}
onMouseLeave={() => console.log('Mouse left')}
>
Content with measurement and event handling
</Container>
);
}
API 参考
集装箱道具
| Prop | 类型 | 默认 | 说明 |
|---|---|---|---|
id | string | - 说吧 | HTML id 属性 |
children | React.ReactNode | - 说吧 | 儿童要素 |
as | 'main' | 'section' | 'article' | 'div' | 'p' | 'div' | 要渲染的 HTML 元素类型 |
showScrollIndicator | boolean | - 说吧 | 显示滚动指标( 反应原生) |
onClick | (event: unknown) => void | - 说吧 | 单击事件处理器 |
onLayout | (event: LayoutEvent) => void | - 说吧 | 版式更改处理器( React Introduction) |
onMouseEnter | MouseEventHandler<HTMLElement> | - 说吧 | 鼠标输入处理器 |
onMouseLeave | MouseEventHandler<HTMLElement> | - 说吧 | 鼠标离开处理器 |
onTransitionEnd | () => void | - 说吧 | 过渡端处理器 |
styleConfig | { root?: Styles[] } | - 说吧 | 自定义样式配置 |
hapticEnabled | boolean | false | 启用随机反馈 |
hapticVariant | 'subtle' | 'loud' | 'subtle' | 快速反馈强度 |
hapticRepeat | boolean | false | 重复随机反馈 |
集装箱参考方法
| 方法 | 说明 |
|---|---|
focus() | 聚焦容器元素 |
getBoundingRectWithCallback(callback?) | 用回调连接到矩形 |
measure(callback) | 测量容器尺寸和位置 |
getElementRef() | 获取基本元素参考 |
相关软件包
Cleartrip设计系统包括60+专用组件包:
核心组成部分
@cleartrip/ct-design-button- 按钮组件@cleartrip/ct-design-typography- 文字和打字@cleartrip/ct-design-card- 卡片布局@cleartrip/ct-design-box- 布局容器
窗体组件
@cleartrip/ct-design-field- 表格字段@cleartrip/ct-design-checkbox- 复选框@cleartrip/ct-design-radio- 无线电按钮@cleartrip/ct-design-dropdown- 下放菜单
导航
@cleartrip/ct-design-nav-tabs- 导航标签@cleartrip/ct-design-breadcrumb- 面包屑导航
反馈
@cleartrip/ct-design-toast- 敬酒通知@cleartrip/ct-design-modal- 模块对话框@cleartrip/ct-design-tooltip- 工具提示@cleartrip/ct-design-spinner- 装入指标
数据显示
@cleartrip/ct-design-accordion- 可折叠的内容@cleartrip/ct-design-carousel- 内容旋转木马@cleartrip/ct-design-rating- 明星收视率@cleartrip/ct-design-badge- 身份证
浏览器支持
- 反应: 16.8.0或以上
- 反应 DOM: 16.8.0或以上
- 原生反应: 0.68.0或更高(可选择的同伴依赖)
模块格式
此软件包支持多个模块格式 :
- ES 模块数字 :
dist/ct-design-components.esm.js - 常见JS数字 :
dist/ct-design-components.cjs.js - 浏览器: 优化浏览器构建可用
- 类型脚本: 包含全部类型脚本定义
发展
# Build the package
pnpm build-package
# Watch for changes during development
pnpm watch-package
# Clean build
pnpm build-package:clean
捐款
这个包是Cleartrip设计系统的一部分. 关于捐款准则,请参见主要储存库文件.
许可证
公务员制度委员会
更改日志
见 变动情况 用于版本历史和更新.