按钮 Button

按钮,被点击时触发一个即时操作。

基本使用

按钮根据 强调程度 不同,有三种变种,分别为 填充按钮边框按钮文本按钮,默认为文本按钮。

<Button variant="contained">填充按钮</Button>
<Button variant="outlined">边框按钮</Button>
<Button variant="text">文本按钮</Button>

色彩调性

按钮可以使用 tone 属性选择 Theme 中的色彩,例如 主色 primary辅色 secondary中性色 neutral

<Button variant="outlined" color="primary">主色</Button>
<Button variant="outlined" color="secondary">辅色</Button>
<Button variant="outlined" color="neutral">中性色</Button>

形状和尺寸

按钮的形状有 3 种:圆角 circle方圆角 round方角 square,默认为方圆角; 按钮的大小也有 3 种:小 small中 medium大 large,默认为中。

<Button variant="contained">填充按钮</Button>
<Button variant="outlined">边框按钮</Button>
<Button variant="text">文本按钮</Button>

其他状态

除了默认状态外,按钮有 加载 loading禁用 diabled 两种状态。

<Button loading>加载中</Button>
<Button disabled>禁用状态</Button>

图标

使用 前缀图标 startIcon后缀图标 endIcon 为按钮添加图标。

<Button variant="contained" startIcon={<IconPlayArrowRounded />}>开始</Button>
<Button variant="contained" shape="circle" startIcon={<IconArrowCircleRight />}>下一步</Button>
<Button variant="contained" iconOnly shape="circle" color="secondary">
  <IconPlayArrowRounded />
</Button>

API

Button API

  • Name
    variant
    Type
    "contained" | "outlined" | "text"
    Description

    按钮类型,可选值 "contained" | "outlined" | "text",默认为 "outlined"。

  • Name
    tone
    Type
    "primary" | "secondary" | keyof Theme.palette
    Description

    按钮颜色,可选值 "primary" | "secondary" | 其他任何在 Theme.palette 中定义的颜色,默认为 "primary"。

  • Name
    shape
    Type
    "circle" | "round"
    Description

    按钮形状 ,可选值 "circle" | "round",默认为 "round"。

  • Name
    size
    Type
    "small" | "medium" | "large"
    Description

    按钮尺寸,可选值 "small" | "medium" | "large",默认为 "medium"。

  • Name
    loading
    Type
    bool
    Description

    是否为加载状态,默认为 false。

  • Name
    disabled
    Type
    bool
    Description

    是否为禁用状态,默认为 false。

  • Name
    startIcon
    Type
    Icon
    Description

    按钮的前缀图标,接受一个 Icon 组件 作为参数。

  • Name
    endtIcon
    Type
    Icon
    Description

    按钮的后缀图标,接受一个 Icon 组件 作为参数。

  • Name
    onClick
    Type
    (e: MouseEvent | TouchEvent) => void
    Description

    点击按钮时触发的回调函数,默认参数会使用当前语言默认的点击事件类型。


API

IconButton API

这篇文档有帮助吗?