Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mood-al/react-tabs-scrollable
a react scrollable tabs component with many additional features
https://github.com/mood-al/react-tabs-scrollable
nextjs react react-component react-component-library scrollable-tabs tabs
Last synced: 3 days ago
JSON representation
a react scrollable tabs component with many additional features
- Host: GitHub
- URL: https://github.com/mood-al/react-tabs-scrollable
- Owner: Mood-al
- License: mit
- Created: 2022-04-17T21:22:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T08:44:28.000Z (about 1 month ago)
- Last Synced: 2025-02-05T01:12:59.849Z (10 days ago)
- Topics: nextjs, react, react-component, react-component-library, scrollable-tabs, tabs
- Language: TypeScript
- Homepage: https://react-tabs-scrollable.vercel.app
- Size: 2.89 MB
- Stars: 36
- Watchers: 2
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-tabs-scrollable
> a simple react scrollable tabs with a lot of additional features and with fully supporting of RTL mode
[](https://www.npmjs.com/package/react-tabs-scrollable) [](https://standardjs.com)
## Install
```bash
npm install --save react-tabs-scrollable@latest
yarn add react-tabs-scrollable@latest
```
```bash
npm install --save [email protected]
yarn add [email protected]
```
## Demos
### Demos
## V1 docs
[V1 docs](https://github.com/Mood-al/react-tabs-scrollable/tree/v1)
## Features
- Typescript out of box
- Many modes to control the behaviour of the selected tab.
- Easy to start with it takes you less than minute to start it up!
- Many features and so easy to customize
- Fully support for RTL (actually the reason why I built this component is because RTL)
- Fully accessible
- You can control and have access to everything inside it.
- Small sized 9.6k (gzipped: 3.9k)
- Great to use in navigation, menus and lists or any proper use for tabs
- Easy to style, you have the css file so you can edit it as you would like, and there are style and className props to all the elements used inside the package.
- You have access to all refs.
- And much more ..
## What's new in V2?
- I rebuild the package from scratch with typescript to avoid the unnecessary bugs and to make it more elegant and easy to use with the typescript auto-complete.
> Note: this's my first time using typescript so expect many bugs with types since i was interfering a lot of types to any, and because I dont have the proper internet, I couldnt search well for them -\_-.
> But overall I think everything works fine!.
- I deleted the unnecessary code and made it more readable and clean.
- I deleted `selectedTabCoordinates` and replaced it with `getTabsBoundingClientRects` function that returns DOMRect object for the `tabsContainer` and `tab`, and it's way performant comparing to the old `selectedTabCoordinates`, it just runs when the scroll stops and when you switch to RTL.
- I renamed the two action `onRightBtnClick` and `onLeftBtnClick` to `onRightNavBtnClick` and `onLeftNavBtnClick`
- Instead of relying on state changes and useEffect to observe the tab click change, now I'm doing it directly via onClick.
- I made the API and the enternals of the component more exposed to the developers who wants to use it (Please see the API table below to see all the new props), since I added about 15 new props including refs to all the elements inside the pacakge, and I added custom styles to style it as you want.
- I added new features to make the component more compatible with my new package react-kfc-menu such as mode prop that controls the behavior of the selected tab scroll, now you can change the whole behavior of it with the new 4 modes I've added to it.
- I added `` component if you want to use tab panels with the tabs.
> I'm planning to add Swipeable component to make the TabScreens more interactive with drag and touch events on both, Desktop and mobile.
Please If you faced any bugs feel free to open an issue.
## Usage
### #Simple Tabs
```jsx
import React from "react";
import { Tabs, Tab } from "react-tabs-scrollable";
import "react-tabs-scrollable/dist/rts.css";
const SimpleTabs = () => {
// define state with initial value to let the tabs start with that value
const [activeTab, setActiveTab] = React.useState(1);
// define a onClick function to bind the value on tab click
const onTabClick = (e, index) => {
console.log(e);
setActiveTab(index);
};
return (
<>
{/* generating an array to loop through it */}
{[...Array(20).keys()].map((item) => (
Tab {item}
))}
>
);
};
export default SimpleTabs;
```
## #Tabs with TabScreen
```jsx
import React from "react";
import { Tabs, Tab } from "react-tabs-scrollable";
import "react-tabs-scrollable/dist/rts.css";
const SimpleTabs = () => {
// define state with initial value to let the tabs start with that value
const [activeTab, setActiveTab] = React.useState(1);
// define a onClick function to bind the value on tab click
const onTabClick = (e, index) => {
console.log(e);
setActiveTab(index);
};
const tabsArray = [...Array(20).keys()];
return (
<>
{/* generating an array to loop through it */}
{tabsArray.map((item) => (
Tab {item}
))}
{tabsArray.map((item) => (
TabScreen {item}
))}
>
);
};
export default SimpleTabs;
```
### #Full example with all features
```jsx
console.log(val)}
// this prop returns a group of events to control the tabs such as onLeftNavBtnClick , onRightNavBtnClick to control the tabs
// you should pass here a ref to get the required functionality
action={tabRef}
// sets if the direction of the page is RTL or not
// default false
isRTL={false}
// sets if the tabs reached the end point of the tab container
// function
didReachEnd={(val) => console.log(val)}
// sets if the tabs reached the start point container
// function
didReachStart={(val) => console.log(val)}
// sets how many tabs you want to scroll on every move
// default 3 tabs on each navigation button click
tabsScrollAmount={3}
// sets the general animation duration when you click on the navigation buttons and when you click out the tabs view
// this option will disable navBtnCLickAnimationDuration and selectedAnimationDuration
// default 300s
animationDuration={300}
// sets the animation of the scroll when you click on the navigation buttons
// note : this will overwirte the animationDuration value
// default 300s
navBtnCLickAnimationDuration={300}
// sets the animation of the scroll when you click on a tab that is out of the view
// note : this will overwirte the animationDuration value
// default 300s
selectedAnimationDuration={300}
// sets the right navitgation vutton icon
// default feather arrow-right svg icon
// you can pass jsx here or just a string
rightBtnIcon={">"}
// sets the left navitgation button icon
// default feather arrow-left svg icon
// you can pass jsx here or just a string
leftBtnIcon={"<"}
//hides the navigantion button
// default false
hideNavBtns={false}
// hides the navigation buttons on mobile devices
// default true
hideNavBtnsOnMobile={true}
// shows the scroll of the tabs
// default false
showTabsScroll={false}
// returns the DOMRect object of the selected tab and the tabs container
getTabsBoundingClientRects={(val) => console.log(val)}
// A react ref that can be used to control the tabs programmatically
// Check the API section to understand more
action={ref}
// You can change the behaviour of the selected tab scroll by changing the option of it, whether to move it to center, start, end or to center but if the selected tab is in the view.
// Check the API section to understand more or you can play with it to understand the idea
mode="scrollSelectedToCenterFromView"
// changes the underline HTML element
navBtnAs="div"
// These props sets the className of their elements
tabsContainerClassName=""
tabsUpperContainerClassName=""
tabsContainerClassName=""
leftNavBtnClassName=""
rightNavBtnClassName=""
navBtnClassName=""
navBtnContainerClassName=""
// Sets the style of these element
navBtnStyle={{}}
tabsContainerStyle={{}}
tabsUpperContainerStyle={{}}
// You can get the ref of these elements
tabsContainerRef={ref}
tabRef={ref}
leftNavBtnRef={ref}
rightNavBtnRef={ref}
>
item
{[...Array(20).keys()].map((tab) => (
Tab {tab}
))}
```
## API
Name
Default
Type
Description
activeTab*
-
integer
the selected tab value which must be passed to the commponent
onTabClick*
-
function
function(event, value) => void callback function fires on tab click. It has two props, the first on is the event object the second on is the selected tab value
mode
scrollSelectedToStart
string
it controls the behavoiur of the selected tab whether to move it to start | center | end | center if the tab is in the view.
it contains 3 modes:
-
scrollSelectedToCenter: scrolls the selected tab to the center of view. -
scrollSelectedToEnd: scrolls the selected tab to the end of view -
scrollSelectedToCenterFromView: scrolls the selected tab to the center of view but even if the selected tab was already in the view.
if you clicked on a tab in the center of view it wont scroll or move, but if you click on any tab on any side (right of the center or left of center tab) it will scroll to the left or right,depending on which side of the view you are clicking.
see the demos to understand more!!
I added this option just to make react-tabs-scrollable more compatible with react-kfc-menu
action
-
ref
react ref fires when the component mounts. It's useful if you want to control some functionalities programmatically. It supports 4 function :
onLeftNavBtnClick ,onRightNavBtnClick, goToStart, goToEndonLeftNavBtnClick : to control the left btn click and use your own navigation button. you can call it by so ref.current.onLeftNavBtnClick() onRightNavBtnClick : to control the right btn click and use your own navigation button. you can call it by so ref.current.onRightNavBtnClick()
goToStart : to control the tabs to go to the start of the tabs container. you can call it by so ref.current.goToStart() goToEnd : to control the tabs to go to the end of the tabs container. you can call it by so ref.current.goToEnd() isRTL
false
boolean
sets if the direction of the tabs is RTL or not
didReachEnd
-
function
sets if the tabs reached the end point of the container
didReachEnd={(val) => console.log(val)}
didReachStart
-
function
sets if the tabs reached the start point of the container
didReachStart={(val) => console.log(val)}
tabsScrollAmount
3
string | integer
sets how many tabs you want to scroll on every move
tabsScrollAmount={3}
animationDuration
300s
integer
sets the animation duration of the scroll when you click on the navigation buttons
note : this will overwirte the animationDuration value
animationDuration={300}
navBtnCLickAnimationDuration
300s
integer
sets the animation of the scroll when you click on the navigation buttons
note : this will overwirte the animationDuration value
navBtnCLickAnimationDuration={300}
selectedAnimationDuration
300s
integer
sets the animation of the scroll when you click on a tab that is out of the view
note : this will overwirte the animationDuration value
selectedAnimationDuration={300}
rightBtnIcon
feather arrow-right svg icon
string | jsx
sets the right navitgation button icon
rightBtnIcon={'>'}
leftBtnIcon
feather arrow-left svg icon
string | jsx
sets the left navitgation button icon
leftBtnIcon={'>'}
hideNavBtns
false
boolean
hides the navigantion button
hideNavBtns={false}
hideNavBtnsOnMobile
true
boolean
hides the navigation buttons on mobile devices
showTabsScroll
false
boolean
shows the scroll of the tabsn
getTabsBoundingClientRects
-
function
returns a callback with the DOMRects object of the selected tab and the tabsContainer.
tabsContainerRef
-
ref
the tabs container ref object
tabRef
-
ref
the tabs ref object and it returns an array of all the tab ref
leftNavBtnRef
-
ref
sets the left navigation btn's ref
rightNavBtnRef
-
ref
sets the right navigation btn's ref
navBtnStyle
-
object
sets the navigation btns' style object
tabsContainerStyle
-
object
Sets tabs container's style object
tabsUpperContainerStyle
-
object
Sets the tabs upper container's style object
leftNavBtnClassName
-
string
Sets the left navigation button's className
rightNavBtnClassName
-
string
Sets the right navigation button's className
navBtnClassName
-
string
Sets the navigation buttons' className
navBtnContainerClassName
-
string
Sets the navigation buttons' container className
tabsUpperContainerClassName
-
string
Sets the upper tabs container's className
tabsContainerClassName
-
string
Sets the tabs container's className
navBtnAs
button
string
Sets the HTML element of the navigation buttons
## Tab
Name
Default
Type
Description
tabAs
button
string
You can change the HTML element of the
Tab
style
-
object
sets Tab's style object
className
-
string
you can pass a custom className to the
Tab component
## TabScreen
Name
Default
Type
Description
activeTab*
-
integer
the selected tab value which must be passed to the commponent
index*
-
integer | string
the index of the tabscreen which must match the activeTab integer
as
dov
string
You can change the HTML element of the
TabScreen
style
-
object
sets Tab's style object
className
-
string
you can pass a custom className to the TabScreen component
> If you liked this project don't forget to see my other projects on NPM and github
## Contrubite
Show your support by giving a ⭐. Any feature requests are welcome!
Anyone is welcomed to contribute in this project.
## Financial Contributions
Buying me coffee will help me sustain the updates and work on new project for the open-source
## Organizations
Support this project with your organization / company or individual.