Have ideas to improve npm?Join in the discussion! »

@uiw/react-breadcrumb

4.7.5 • Public • Published

Breadcrumb 面包屑

显示当前页面的路径,快速返回之前的任意页面。

import { Breadcrumb } from 'uiw';
// or
import Breadcrumb from '@uiw/react-breadcrumb';

基础用法

适用广泛的基础用法,在 Breadcrumb 中使用 Breadcrumb.Item 标签表示从首页开始的每一级。

import { Breadcrumb } from 'uiw';

ReactDOM.render(
  <Breadcrumb>
    <Breadcrumb.Item>首页</Breadcrumb.Item>
    <Breadcrumb.Item separator=">">活动管理</Breadcrumb.Item>
    <Breadcrumb.Item>活动列表</Breadcrumb.Item>
    <Breadcrumb.Item active>活动详情</Breadcrumb.Item>
  </Breadcrumb>,
  _mount_
);

自定义分隔符

使用 separator=">" 可以自定义分隔符,分隔符也可以是图标。

import ReactDOM from 'react-dom';
import { Breadcrumb } from 'uiw';

ReactDOM.render(
  <div>
    <Breadcrumb>
      <Breadcrumb.Item><a href="#">Home</a></Breadcrumb.Item>
      <Breadcrumb.Item separator=">"><a href="#">Library</a></Breadcrumb.Item>
      <Breadcrumb.Item active>Data</Breadcrumb.Item>
    </Breadcrumb>
    <Divider />
    <Breadcrumb separator="#">
      <Breadcrumb.Item><a href="#">Home</a></Breadcrumb.Item>
      <Breadcrumb.Item separator={<span>+</span>}><a href="#">Home</a></Breadcrumb.Item>
      <Breadcrumb.Item separator={<Icon type="home" verticalAlign="baseline" />}><a href="#">Icon</a></Breadcrumb.Item>
      <Breadcrumb.Item separator=">"><a href="#">Library</a></Breadcrumb.Item>
      <Breadcrumb.Item active>Data</Breadcrumb.Item>
    </Breadcrumb>
  </div>,
  _mount_
);

带有图标和连接的

图标放在文字前面。注意文字要使用 span 包裹起来,图标 <Icon /> 需要跟 span 同级。Breadcrumb.Item 定义 href 参数的话,Item 上的参数就全部是超链原始属性。

import ReactDOM from 'react-dom';
import { Breadcrumb } from 'uiw';

const stylIcon = { marginRight: 3, top: 2, display: 'inline-flex' }

ReactDOM.render(
  <div>
    <Breadcrumb>
      <Breadcrumb.Item>
        <a href="#"><Icon style={stylIcon} type="home"/></a>
      </Breadcrumb.Item>
      <Breadcrumb.Item separator=">">
        <a href="#"><Icon style={stylIcon} type="apple"/>Library</a>
      </Breadcrumb.Item>
      <Breadcrumb.Item separator=">">
        <a href="#"><Icon style={stylIcon} type="pie-chart"/>Chart</a>
      </Breadcrumb.Item>
      <Breadcrumb.Item separator="">
        <a href="#"><Icon style={{...stylIcon, marginRight: 0}} type="star-on"/> Chart</a>
      </Breadcrumb.Item>
      <Breadcrumb.Item separator="" active>Data</Breadcrumb.Item>
    </Breadcrumb>
  </div>,
  _mount_
);

Breadcrumb

参数 说明 类型 默认值
style 样式 String -
className 样式名称 String w-breadcrumb
tagName 设置子节点标签名,默认 <a /> 标签,也可以指定路由 <Link /> String a
separator 分隔符自定义,定义所有子组件的分隔符。 String /

其它参数可根据 tagName 来设置,默认 <a /> 标签时,可设置 href="https://wwww.google.com" 或者 target="_blank" 等参数,你可以设置 react-router-dom 路由 <Link />,例如:

import { Breadcrumb } from 'uiw';
import { Link } from 'react-router-dom';

const Demo = () => {
  return (
    <Breadcrumb>
      <Breadcrumb.Item tagName={Link} to="/home">
        <Icon type="apple"/> Home
      </Breadcrumb.Item>
    </Breadcrumb>
  )
}

Breadcrumb.Item

参数 说明 类型 默认值
className 样式名称 String w-breadcrumb-itme
separator 分隔符自定义,子组件可以单独定义不同的分隔符。 String -
active 激活。 String -

Install

npm i @uiw/react-breadcrumb

DownloadsWeekly Downloads

221

Version

4.7.5

License

MIT

Unpacked Size

31.6 kB

Total Files

35

Last publish

Collaborators

  • avatar