按钮
按钮组件是网络开发中用于创建交互元素的可再用用户界面元素,用户可以点击或点击来进行动作.
安装
npm install @cleartrip/ct-design-button
# or
pnpm add @cleartrip/ct-design-button
同伴依赖关系
# Required for all targets
npm install react
# Web only
npm install react-dom
# React Native only
npm install react-native
使用量
基础
import { Button, ButtonVariant, ButtonColor, ButtonSize } from '@cleartrip/ct-design-button';
function Example() {
return <Button onClick={() => console.log('clicked')}>Click me</Button>;
}
有变体
<Button variant={ButtonVariant.CONTAINED} color={ButtonColor.PRIMARY}>
Contained Button
</Button>
<Button variant={ButtonVariant.OUTLINE} color={ButtonColor.SECONDARY}>
Outline Button
</Button>
<Button variant={ButtonVariant.BARE}>
Bare Button
</Button>
带有大小
<Button size={ButtonSize.SMALL}>Small Button</Button>
<Button size={ButtonSize.MEDIUM}>Medium Button</Button>
<Button size={ButtonSize.LARGE}>Large Button</Button>
带有图标
<Button
showLeftIcon={true}
LeftIcon={<MyIcon />}
>
Button with left icon
</Button>
<Button
showRightIcon={true}
RightIcon={<MyIcon />}
>
Button with right icon
</Button>
装入状态
<Button loading={isLoading}>{isLoading ? 'Loading...' : 'Submit'}</Button>
道具
| Prop | 类型 | 默认 | 需求 | 说明 |
|---|---|---|---|---|
children | ReactNode | —— 说 | 对 | 按钮内容 |
onClick | () => void | —— 说 | 没有 | 单击处理器功能 |
variant | ButtonVariant | CONTAINED | 没有 | 按钮的视觉样式 |
size | ButtonSize | MEDIUM | 没有 | 按钮的大小 |
color | ButtonColor | PRIMARY | 没有 | 按钮的颜色方案 |
disabled | boolean | false | 没有 | 是否禁用按钮 |
loading | boolean | false | 没有 | 是否显示装入状态 |
isFullWidth | boolean | false | 没有 | 按钮是否取出全宽 |
minWidth | string | 50px | 没有 | 按钮最小宽度 |
showLeftIcon | boolean | false | 没有 | 是否显示左侧图标 |
LeftIcon | ReactElement | —— 说 | 没有 | 左侧图标元素 |
showRightIcon | boolean | false | 没有 | 是否显示正确的图标 |
RightIcon | ReactElement | —— 说 | 没有 | 右图标元素 |
备选案文
CONTAINED— 以背景颜色填充的按钮OUTLINE– 有边框的按钮, 无背景BARE— 仅文本按钮,没有背景或边框
大小
SMALL– 紧缺空间的压缩按钮MEDIUM—— 标准按钮大小( 默认)LARGE- 需要强调的大按钮
颜色
PRIMARY——主要品牌颜色SECONDARY二级配色方案TERTIARY- 三级颜色方案NEUTRAL中性/灰色颜色方案SUCCESS绿色,用于确认/核准行动DANGER红色,用于破坏/拒绝行动
无障碍
- 按钮包括适当的 ARIA 属性
- 已禁用按钮无法聚焦
- 正在装入按钮宣布屏幕阅读器状态
- 确保所有变体的色彩对比度
- 图标应有适当的备选案文或ARIA标签
移徙
如果从以前的版本迁移:
- import { Button } from 'yagami/core/components';
+ import { Button, ButtonVariant, ButtonColor, ButtonSize } from '@cleartrip/ct-design-button';