• Badge 徽标数

    图标右上角的圆形徽标数字。

    何时使用

    一般出现在通知图标或头像的右上角,用于显示需要处理的消息条数,通过醒目视觉形式吸引用户处理。

    代码演示

    简单的徽章展示,当 count0 时,默认不显示,但是可以使用 showZero 修改为显示。
    expand code expand code
    import { Badge } from 'choerodon-ui';
    
    ReactDOM.render(
      <div>
        <Badge count={5}>
          <a href="#" className="head-example" />
        </Badge>
        <Badge count={0} showZero>
          <a href="#" className="head-example" />
        </Badge>
      </div>,
      mountNode);
    
    超过 overflowCount 的会显示为 ${overflowCount}+,默认的 overflowCount99
    expand code expand code
    import { Badge } from 'choerodon-ui';
    
    ReactDOM.render(
      <div>
        <Badge count={99}>
          <a href="#" className="head-example" />
        </Badge>
        <Badge count={100}>
          <a href="#" className="head-example" />
        </Badge>
        <Badge count={99} overflowCount={10}>
          <a href="#" className="head-example" />
        </Badge>
        <Badge count={1000} overflowCount={999}>
          <a href="#" className="head-example" />
        </Badge>
      </div>,
      mountNode);
    
    用 a 标签进行包裹即可。
    expand code expand code
    import { Badge } from 'choerodon-ui';
    
    ReactDOM.render(
      <a href="#">
        <Badge count={5}>
          <span className="head-example" />
        </Badge>
      </a>,
      mountNode);
    
    用于表示状态的小圆点。
    expand code expand code
    import { Badge } from 'choerodon-ui';
    
    ReactDOM.render(
      <div>
        <Badge status="success" />
        <Badge status="error" />
        <Badge status="default" />
        <Badge status="processing" />
        <Badge status="warning" />
        <br />
        <Badge status="success" text="Success" />
        <br />
        <Badge status="error" text="Error" />
        <br />
        <Badge status="default" text="Default" />
        <br />
        <Badge status="processing" text="Processing" />
        <br />
        <Badge status="warning" text="Warning" />
      </div>,
      mountNode);
    
    不包裹任何元素即是独立使用,可自定样式展现。
    expand code expand code
    import { Badge } from 'choerodon-ui';
    
    ReactDOM.render(
      <div>
        <Badge count={25} />
        <Badge count={4} style={{ backgroundColor: '#fff', color: '#999', boxShadow: '0 0 0 1px #d9d9d9 inset' }} />
        <Badge count={109} style={{ backgroundColor: '#52c41a' }} />
      </div>,
      mountNode);
    
    没有具体的数字。
    expand code expand code
    import { Badge, Icon } from 'choerodon-ui';
    
    ReactDOM.render(
      <div>
        <Badge dot>
          <Icon type="notification" />
        </Badge>
        <Badge count={0} dot>
          <Icon type="notification" />
        </Badge>
        <Badge dot>
          <a href="#">Link something</a>
        </Badge>
      </div>,
      mountNode);
    
    展示动态变化的效果。
    expand code expand code
    import { Badge, Button, Icon, Switch } from 'choerodon-ui';
    const ButtonGroup = Button.Group;
    
    class Demo extends React.Component {
      state = {
        count: 5,
        show: true,
      }
    
      increase = () => {
        const count = this.state.count + 1;
        this.setState({ count });
      }
    
      decline = () => {
        let count = this.state.count - 1;
        if (count < 0) {
          count = 0;
        }
        this.setState({ count });
      }
    
      onChange = (show) => {
        this.setState({ show });
      }
    
      render() {
        return (
          <div>
            <div>
              <Badge count={this.state.count}>
                <a href="#" className="head-example" />
              </Badge>
              <ButtonGroup>
                <Button onClick={this.decline}>
                  <Icon type="minus" />
                </Button>
                <Button onClick={this.increase}>
                  <Icon type="plus" />
                </Button>
              </ButtonGroup>
            </div>
            <div style={{ marginTop: 10 }}>
              <Badge dot={this.state.show}>
                <a href="#" className="head-example" />
              </Badge>
              <Switch onChange={this.onChange} checked={this.state.show} />
            </div>
          </div>
        );
      }
    }
    
    ReactDOM.render(<Demo />, mountNode);
    

    API

    <Badge count={5}>
      <a href="#" className="head-example" />
    </Badge>
    
    <Badge count={5} />
    
    参数说明类型默认值
    count展示的数字,大于 overflowCount 时显示为 ${overflowCount}+,为 0 时隐藏number|ReactNode
    dot不展示数字,只有一个小红点booleanfalse
    offset设置状态点的位置偏移,格式为 [x, y][number, number]-
    overflowCount展示封顶的数字值number99
    showZero当数值为 0 时,是否展示 Badgebooleanfalse
    status设置 Badge 为状态点Enum{ ‘success’, ‘processing, ‘default’, ‘error’, ‘warning’ }
    text在设置了 status 的前提下有效,设置状态点的文本string