react-tabs-system
v1.6.0
Published
A very simple panes-and-tabs system for React.
Downloads
2
Maintainers
Readme
react-tabs-system
A super easy-to-use tabs-and-panes system for React >= 16.14.0
Usage:
import
TabSystemProvider
, TabView
and useTabFunctions
from 'react-panes'
.
Wrap your <TabView />
and any usages of useTabFunctions()
in the TabSystemProvider
. Provide TabSystemProvider
with initialTabs
, formatted as following:
initialTabs={ [ { title: "Tab Title", content: <AnyComponent /> }, ... ] }
(Currently you can only supply initial tabs for one pane. This will change in the future.)
Use const {...} = useTabFunctions()
from anywhere within the TabSystemProvider
to get access to control functions. The available controls are addTab(component, title)
, addTabAndFocus(component, title)
, and addTabToNewPane(component, title)
. There will be more coming.
You can drag and drop tabs to reorder them. Tabs will keep their state with the exception of moving them across a pane; the tab that transferred panes will lose state. I am working on solving this.
Styling:
The TabView and all of the panes/tabs come pre-styled, but if you'd like to change the styling, the CSS class layout looks like this:
div.tabView
- >div.pane
- - >div.topBar
- - - >div.tabButtons
- - - - >div.tabButton
- - - - - >span.title
- - - - - >div.closeButton
- - - - >div.paneControls
- - - - - >div
- - >div.tabContent (has the class 'visible' if it is active)