JSPM

  • Created
  • Published
  • Downloads 1278
  • Score
    100M100P100Q112282F
  • License MIT

Tab component for Ink

Package Exports

  • ink-tab

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ink-tab) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ink-tab

Tab component for Ink.

Demo

Demo

Installation

npm install ink-tab

or with yarn

yarn add ink-tab

Usage

import React, { Component } from 'react';
import { render, Color } from 'ink';
import { Tabs, Tab } from 'ink-tab';

class TabExample extends Component {
  constructor(props) {
    super(props);

    this.state = {
      activeTabName: null,
    };

    this.handleTabChange = this.handleTabChange.bind(this);
  }

  handleTabChange(name, activeTab) {
    this.setState({
      activeTabName: name,
    });
  }

  render() {
    return (
      <div>
        <div>
          {this.state.activeTab === 'foo' && 'Selected tab is "foo"'}
          {this.state.activeTab === 'bar' && 'Selected tab is "bar"'}
          {this.state.activeTab === 'baz' && 'Selected tab is "baz"'}
        </div>

        <Tabs onChange={this.handleTabChange}>
          <Tab name="foo">Foo</Tab>
          <Tab name="bar">Bar</Tab>
          <Tab name="baz">Baz</Tab>
        </Tabs>
      </div>
    );
  }
}

render(TabExample);

Props

Tabs component

childrens

Tabs must only containt Tab children

onChange

Type: Function

Parameters:

  • name: the name specified in the name prop
  • activeTab: the current active tab component

onChange function is called on component start and on every changes in tabs

Tab component

name

Type: string the name that will be returned in the onChange function

Who is using ink-tab ?

I created ink-tab at first to use in changelog-view, a small cli to help you read what did change in your dependencies since your current version, reading CHANGELOG.md, HISTORY.md, github releases, etc.

If you use it in a component, feel free to tell me, I will be pleased !

Hacking

Issues and pull requests are welcome.

You can run the demo script by running yarn demo or npm run demo