@karrotframe/tabs v0.4.3-alpha.5

Swipable Tab UI for React

• Setup
• Components
  • Tabs
• Hooks
  • useTabsController

Setup

$ yarn add @karrotframe/tabs

Should import the CSS of your app

import '@karrotframe/tabs/index.css'

import { ... } from '@karrotframe/tabs'

Components

Tabs

All the props is typed and commented in TypeScript

import { Tabs } from '@karrotframe/tabs'
import { useState } from 'react'

const App: React.FC = () => {
  const [activeTabKey, setActiveTabKey] = useState<string>('tab_1')

  return (
    <Tabs
      activeTabKey={activeTabKey}
      tabs={[
        {
          key: 'tab_1',
          buttonLabel: 'Tab 1',
          render: () => <div>Tab 1</div>,
        },
      ]}
      onTabChange={(key) => {
        setActiveTabKey(key)
      }}
    />
  )
}

export default App

Hooks

useTabsController

import { useTabsController } from '@karrotframe/tabs'

const Something: React.FC = () => {
  const { enableSwipe, disableSwipe } = useTabsController()

  const onTouchDown = () => {
    // disable swipe when other action needed
    disableSwipe()

    // ...
  }

  return (
    // ...
  )
}