0.0.2 • Published 2 years ago
@xverse/components-button v0.0.2
API
| 参数名 | 类型 | 说明 | 默认值 | 是否必填 | 备注 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| text | string | 按钮文字 | - | false | - | ||||||
| color | 'primary' | 'success' | 'warning' | 'error' | 按钮状态色 | - | false | primary 为主题色 | success 为成功色 | warning 为警告色 | error 为错误色 |
| theme | 'light' | 'dark' | 默认/暗黑模式 | - | false | light 为默认主题，页面底色为类白色使用 | dark 为暗黑主题，页面底色为类黑色时使用 | ||||
| fill | 'solid' | 'outline' | 'none' | 按钮表现形式 | - | false | solid 为实心 | outline 为镂空，背景色为透明，边框有颜色 | none 为纯文字按钮 | ||
| triggerMode | 'debounce' | 'throttle' | 新增节流防抖模式选择 | - | false | - | |||||
| triggerTime | number | 节流防抖执行时间 | 500 | false | - | ||||||
| disabled | boolean | 是否禁止点击 | - | false | - | ||||||
| onClick | () => void | Promise | unknown | 点击事件 | - | false | - | ||||
| type | 'submit' | 'reset' | 'button' | form 表单按钮类型 | - | false | button 标签的原始属性，submit 为提交表单 | reset 为重置表单 | button 为普通按钮 | ||
| children | React.ReactNode & Pick<NativeButtonProps, 'onMouseDown' | 'onMouseUp' | 'onTouchStart' | 'onTouchEnd'> | - | false | - | ||||
| style | CSSPropertiesAndCSSVariables | - | false | - | |||||||
| icon | string | 图标 | - | false | 允许在按钮文字前放置图标 | ||||||
| iconStyle | CSSProperties | 图标样式 | - | false | 按钮文字前图标的样式 | ||||||
| className | string | css 类名 | - | false | - | ||||||
| activeEffect | 'default' | 'none' | 按钮的点击效果： default 为透明度降低 | none 为没有效果 | - | false | - | ||||
| effectBg | string | 按钮图片 | - | false | 填充整个按钮的图片 | ||||||
| effectBorder | string | 按钮光晕 | - | false | 围绕按钮周围无限循环的光晕效果 | ||||||
| effectLight | string | 按钮顶部光线 | - | false | 按钮顶部光线左右左循环往复的效果 | ||||||
| trackerId | string | 埋点上报 ID | - | false | 前缀后缀会在业务代码中添加，为避免重复应该是纯 id |