@beisen-phoenix/button-pgb

@beisen-phoenix/button-pgb

Usage no npm install needed!

<script type="module">
  import beisenPhoenixButtonPgb from 'https://cdn.skypack.dev/@beisen-phoenix/button-pgb';
</script>

README

按钮

@beisen-phoenix/button-pgb

概述

对button组件进行封装,导出一种类型的button

Button API

参数 说明 类型 默认值 是否必传
buttonType 按钮功能类型,可选 'button','buttonGroup','iconButton','iconButtonGroup','textButton' string 'button'
size 按钮的大小 可选值包括 super、big、middle、small small
type 按钮的类型 可选值包括 primary、secondary、normal primary
disable 是否禁用 boolean false
extraCls 扩展的class名称,一般用于样式扩展 string --
preIcon 前置icon JSX.Element --
suffixIcon 后置icon JSX.Element --
loading 是否处于loading状态(loading图标为内置图标,不可替换) boolean false
onClick 点击按钮的回调函数 function (e) => void

IconButton API

参数 说明 类型 默认值 是否必传
buttonType 按钮功能类型,可选 'button','buttonGroup','iconButton','iconButtonGroup','textButton' string 'button'
type 按钮类型 primary、secondary primary
disable 是否禁用 boolean false
tipInfo 按钮hover时显示的提示信息 string --
children 子组件,是一个Icon的组件 React.ReactNode --
loading 是否处于loading状态(loading图标为内置图标,不可替换) boolean false
hasBorder 是否显示边框 boolean false
radius 边框的的圆角 string
ref 用来获取button的dom实例的引用 (dom) => --
onClick 点击按钮的回调函数 function (e) => void

TextButton API

参数 说明 类型 默认值 是否必传
buttonType 按钮功能类型,可选 'button','buttonGroup','iconButton','iconButtonGroup','textButton' string 'button'
maxWidth 按钮的最大宽度 string --
margin 按钮的外边距,需要按照css margin 规范来赋值 string --
type 按钮类型 primary、secondary primary
size 按钮的大小 可选值包括 big、small big
disable 是否禁用 boolean false
loading 是否处于loading状态(loading图标为内置图标,不可替换) boolean false
text 按钮的显示文字 string --
icon 自定义的icon JSX.Element --
onClick 点击按钮的回调函数 function (e) => void

ButtonGroup API

参数 说明 类型 默认值 是否必传
buttonType 按钮功能类型,可选 'button','buttonGroup','iconButton','iconButtonGroup','textButton' string 'button'
type 按钮类型 primary、secondary primary
size 按钮的大小 可选值包括 big、small big
initialIndex 默认激活第几个 number 0
items 按钮组的数据 object {disable?: boolean, text: string} []
onClick 点击按钮的回调函数 function (item,e) => void

IconButtonGroup API

参数 说明 类型 默认值 是否必传
buttonType 按钮功能类型,可选 'button','buttonGroup','iconButton','iconButtonGroup','textButton' string 'button'
icons 按钮组的自定义icon [{ icon?: JSX.Element, tipInfo?: string, direct?: string, disable?: boolean }] []
onClick 点击按钮的回调函数 function (index,item,e) => void