11.12.0 • Published 2 years ago

@easyv/tabs v11.12.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

rc-tabs


React Tabs component.

NPM version dumi build status Test coverage npm download bundle size

Screenshot

Example

http://localhost:8000/examples

online example: https://tabs.react-component.now.sh/

install

rc-tabs

Feature

Keyboard

  • left and up: tabs to previous tab
  • right and down: tabs to next tab

Usage

import Tabs, { TabPane } from 'rc-tabs';

var callback = function(key) {};

React.render(
  <Tabs defaultActiveKey="2" onChange={callback}>
    <TabPane tab="tab 1" key="1">
      first
    </TabPane>
    <TabPane tab="tab 2" key="2">
      second
    </TabPane>
    <TabPane tab="tab 3" key="3">
      third
    </TabPane>
  </Tabs>,
  document.getElementById('t2'),
);

API

Tabs

nametypedefaultdescription
activeKeystring-current active tabPanel's key
animatedboolean | { inkBar: boolean, tabPane: boolean }{ inkBar: true, tabPane: false }config animation
defaultActiveKeystring-initial active tabPanel's key if activeKey is absent
destroyInactiveTabPanebooleanfalsewhether destroy inactive TabPane when change tab
direction'ltr' | 'rlt''ltr'Layout direction of tabs component
editable{ onEdit(type: 'add''remove', info: { key, event }), showAdd: boolean, removeIcon: ReactNode, addIcon: ReactNode }-config tab editable
locale{ dropdownAriaLabel: string, removeAriaLabel: string, addAriaLabel: string }-Accessibility locale help text
moreIconReactNode-collapse icon
tabBarGutternumber0config tab bar gutter
tabBarPosition'left' | 'right' | 'top' | 'bottom''top'tab nav 's position
tabBarStylestyle-tab nav style
tabBarExtraContentReactNode | { left: ReactNode, right: ReactNode }-config extra content
renderTabBar(props, TabBarComponent) => ReactElement-How to render tab bar
prefixClsstring'rc-tabs'prefix class name, use to custom style
onChange(key) => void-called when tabPanel is changed
onTabClick(key) => void-called when tab click
onTabScroll({ direction }) => void-called when tab scroll

TabPane

nametypedefaultdescription
keystring-corresponding to activeKey, should be unique
forceRenderbooleanfalseforced render of content in tabs, not lazy render after clicking on tabs
tabReactNode-current tab's title corresponding to current tabPane
closeIconReactNode-Config close icon

Development

npm install
npm start

Test Case

npm test
npm run chrome-test

Coverage

npm run coverage

open coverage/ dir

License

rc-tabs is released under the MIT license.

FAQ

Resposive Tabs

There are 3 cases when handling resposive tabs: image

We get hidden tabs through useVisibleRange.ts. If enconter the third case, in order to make tabs responsive, some tabs should be hidden. So we minus addSize when calculating basicSize manully, even though there's no addNode in container. In this way, case 3 turns to case 2, tabs become stable again.