react-draggable-tab

React-draggable-tab

Atom like draggable tab react component.

Demo

View Demo

Installation

npm install --save react-draggable-tab

API

Tab

Tab is just a case class to check props. props.children will rendered into content area.

Props

• key: unique key in TabList. React.PropTypes.string.isRequired

• beforeTitle: element to show in tab. eg icon. React.PropTypes.element

• title: string or element to show in tab. React.PropTypes.oneOfType([React.PropTypes.string, React.PropTypes.element]).isRequired

• afterTitle: element to show in tab. eg: notification badge React.PropTypes.element

• disableClose: If true, closeButton will not be appeared in tab. React.PropTypes.bool (Default false)

• beforeTitle:

Style (for each tab)

• tabClassNames: classNames which will be added to rendered elements.

• tab: base li element of tab (defult: rdTab)

• tabBefore: before element of li which emulate :Before selector (defult: rdTabBefore)

• tabAfter: after element of li which emulate :After selector (defult: rdTabAfter)

• tabTitle: span element of tab title (defult: rdTabTitle)

• tabBeforeTitle: span element of tab before title (defult: tabBeforeTitle)

• tabAfterTitle: span element of tab after title (defult: tabAfterTitle)

• tabCloseIcon: base span element of close icon (defult: rdCloseIcon)

• tabActive: selected tab's li, before, after (defult: rdTabActive)

• tabStyles: Inline styles which will be overwritten default and common-tabs inline styles.

• tab: base li element of tab

• tabBefore: before element of li which emulate :Before selector.

• tabAfter: after element of li which emulate :After selector.

• tabTitle: span element of tab title

• tabActive: selected tab's li

• tabBeforeActive: selected tab's li before

• tabAfterActive: selected tab's li after

• tabTitleActive: selected tab's title

• tabCloseIcon: base span element of close icon

• tabCloseIconOnHover: base span element of close icon when hover

Tabs

Tabs is container for tab. it will render tabBar and content of selected element.

Props

• tabs: Array of Tab elements. React.PropTypes.arrayOf(React.PropTypes.element)

• selectedTab: key for selectedTab. React.PropTypes.string default to first tab.

• tabAddButton: element for add button. React.PropTypes.element

Shortcut key binding

• shortCutKeys: Short cut key bindings as Mousetrap style.
• close: key binding to close current tab (onTabClose will be called)
• create: key binding to create tab (onTabAddButtonClick will be called)
• moveRight: key binding to move right (onTabSelect will be called)
• moveLeft: key binding to move left (onTabSelect will be called)

Style (All tabs will be apply these styles)

• tabsClassNames: classNames which will be added to rendered elements.

• tabBar: base ul element of tab bar (defult: rdTabBar)

• tabBarAfter: after span element of tab bar which emulate :After selector (defult: rdTabBarAfter)

• tab: base li element of tab (defult: rdTab)

• tabBefore: before element of li which emulate :Before selector (defult: rdTabBefore)

• tabAfter: after element of li which emulate :After selector (defult: rdTabAfter)

• tabTitle: span element of tab title (defult: rdTabTitle)

• tabBeforeTitle: span element of tab before title (defult: rdTabBeforeTitle)

• tabBeforeTitle: span element of tab after title (defult: rdTabAfterTitle)

• tabCloseIcon: base span element of close icon (defult: rdCloseIcon)

• tabActive: selected tab's li, before, after (defult: rdTabActive)

• tabsStyles: Inline styles which will be overwritten default inline styles.

• tabBar: base ul element of tab bar

• tabBarAfter: after span element of tab bar which emulate :After selector

• tab: base li element of tab

• tabBefore: before element of li which emulate :Before selector.

• tabAfter: after element of li which emulate :After selector.

• tabTitle: span element of tab title

• tabActive: selected tab's li

• tabBeforeActive: selected tab's li before

• tabAfterActive: selected tab's li after

• tabTitleActive: selected tab's title

• tabCloseIcon: base span element of close icon

• tabCloseIconOnHover: base span element of close icon when hover

Events

• onTabSelect(e, key, currentTabs): Called when tab of key was selected. currentTabs is array of tabs elements sorted with current order.

• onTabClose(e, key, currentTabs): Called when tab of key was closed. currentTabs is array of tabs elements sorted with current order.

• onTabPositionChange(e, key, currentTabs): Called when tab of key was moved. currentTabs is array of tabs elements sorted with current order.

• onTabAddButtonClick(e, currentTabs): Called when tab add button was clicked. currentTabs is array of tabs elements sorted with current order. Basically you will concat currentTabs with new empty tab.

  let newTabs = currentTabs.concat([newTab]);
  

• onTabDoubleClick(e, key): Called when title was double clicked.

Usage example

class App extends React.Component {
  constructor(props) {
    super(props);
    let icon = (<image src='icon.png' style={{height:'13px'}}/>);
    let fonticon = (<icon className='icon-html5'/>);
    let badge = (<DynamicTabBadge />);

    this.state = {
      tabs:[
        (<Tab key={'tab0'} title={'unclosable tab'} disableClose={true} >
          <div>
            <h1>This tab cannot close</h1>
          </div>
        </Tab>),
        (<Tab key={'tab1'} title={'1stTab'} beforeTitle={icon} >
          <div>
            <h1>This is tab1</h1>
          </div>
        </Tab>),
        (<Tab key={'tab2'} title={'2ndTab Too long Toooooooooooooooooo long'} beforeTitle={fonticon} >
          <div>
            <pre>Lorem ipsum dolor sit amet, consectetur adipisicing elit,
            </pre>
          </div>
        </Tab>),
        (<Tab key={'tab3'} title={'Dynamic tab'} afterTitle={badge}>
          <DynamicTabContent/>
        </Tab>)
      ],
      badgeCount: 0
    };
  }

  handleTabSelect(e, key, currentTabs) {
    console.log('handleTabSelect key:', key);
    this.setState({selectedTab: key, tabs: currentTabs});
  }

  handleTabClose(e, key, currentTabs) {
    console.log('tabClosed key:', key);
    this.setState({tabs: currentTabs});
  }

  handleTabPositionChange(e, key, currentTabs) {
    console.log('tabPositionChanged key:', key);
    this.setState({tabs: currentTabs});
  }

  handleTabAddButtonClick(e, currentTabs) {
    // key must be unique
    const key = 'newTab_' + Date.now();
    let newTab = (<Tab key={key} title='untitled'>
                    <div>
                      <h1>New Empty Tab</h1>
                    </div>
                  </Tab>);
    let newTabs = currentTabs.concat([newTab]);

    this.setState({
      tabs: newTabs,
      selectedTab: key
    });
  }

  render() {

    return (
      <Tabs
        tabsClassNames={tabsClassNames}
        tabsStyles={tabsStyles}
        selectedTab={this.state.selectedTab ? this.state.selectedTab : "tab2"}
        onTabSelect={this.handleTabSelect.bind(this)}
        onTabClose={this.handleTabClose.bind(this)}
        onTabAddButtonClick={this.handleTabAddButtonClick.bind(this)}
        onTabPositionChange={this.handleTabPositionChange.bind(this)}
        tabs={this.state.tabs}
        shortCutKeys={
          {
            'close': ['alt+command+w', 'alt+ctrl+w'],
            'create': ['alt+command+t', 'alt+ctrl+t'],
            'moveRight': ['alt+command+tab', 'alt+ctrl+tab'],
            'moveLeft': ['shift+alt+command+tab', 'shift+alt+ctrl+tab']
          }
        }
      />
    )
  }
};

See also example

npm install
npm run start:example

Tests

npm test

Contributors

• @linhlc888

Known Issue

• Dynamic tab content.

Tabs do not care any change in Tab content. content needs update by your application side. See 3rdTab in example.

• flex style should be define in CSS for safari. See https://github.com/facebook/react/issues/2020

In application, class rdTabBar or your custom class of TabBar needs display: -webkit-flex in CSS like below.

.myTabBar {
  display: -webkit-flex;
}

Changelog

Ver 0.3.2

• #27 Support keyboard shortcut