svelte-tabs-scrollable
v0.0.9
Published
a simple svelte scrollable tabs with a lot of additional features and with fully supporting of RTL mode
Downloads
57
Maintainers
Readme
svelte-tabs-scrollable
A simple svelte scrollable tabs with a lot of additional features and with fully supporting of RTL mode This package is the Svelte version of react-tabs-scrollable package!!
Install
npm install --save svelte-tabs-scrollable
yarn add svelte-tabs-scrollable
Demo
Demo
Features
- This package is the svelte version of react-tabs-scrollable package!!
- Easy to start with it takes you less than minute to start it up!
- It has many features and so easy to customize
- Fully support for RTL (actually the reason why I built this component is because RTL)
- You can control in literally everything inside it
- Great to use in navigation , menus and lists or any proper use for tabs
- And much more ..
Usage
<script>
import Tabs from 'svelte-tabs-scrollable/Tabs.svelte';
import Tab from 'svelte-tabs-scrollable/Tab.svelte';
// define the initail state of the active tab to start with
let activeTab = 10;
</script>
<Tabs {activeTab} >
{#each [...Array(33).keys()] as item}
<Tab>
tab {item}
</Tab>
{/each}
</Tabs>
Advanced example
<script>
// @ts-nocheck
import Tabs from 'svelte-tabs-scrollable/Tabs.svelte';
import Tab from 'svelte-tabs-scrollable/Tab.svelte';
let isRTL = false;
const onClick = () => {
isRTL = !isRTL;
};
let activeTab = 13;
const onTabClick = (e, index) => {
console.log(index);
};
$: {
if (typeof window !== 'undefined') {
const body = window.document.body;
isRTL ? (body.dir = 'rtl') : (body.dir = 'ltr');
}
}
let goToEnd;
let goToStart;
let showTabsScroll = false;
let hideNavBtns = false;
const didReachEnd = (val) => {
// sets if the tabs reached the end point of the tab's container
};
const didReachStart = (val) => {
// sets if the tabs reached the start point of the tab's container
};
</script>
<!-- I couldn't add comments between the <Tabs/>'s props -_- -->
<Tabs
{activeTab}
{onTabClick}
bind:goToEnd
bind:goToStart
{isRTL}
{didReachStart}
{didReachEnd}
scrollSelectedToCenterOfView={false}
scrollSelectedToEndOfView={false}
animationDuration={300}
hideNavBtnsOnMobile={true}
{showTabsScroll}
{hideNavBtns}
tabsClassName="ss"
tabsContainerClassName="ss"
>
{#each [...Array(33).keys()] as item}
<Tab
as="a"
asProps={{
href: '/#',
['data-item']: item
}}
tabClassName="custom-class">
tab {item}
</Tab>
{/each}
</Tabs>
<button on:click={() => goToEnd()}>go to end</button>
<button on:click={() => goToStart()}>go to start</button>
<button on:click={onClick}>{isRTL ? 'RTL' : 'LTR'}</button>
<div style="border : 1px solid #000; display: inline-block">
<input bind:checked={showTabsScroll} type="checkbox" id="showTabsScroll" />
<label for="showTabsScroll"> showTabsScroll : {showTabsScroll} </label>
</div>
<div style="border : 1px solid #000; display: inline-block">
<input bind:checked={hideNavBtns} type="checkbox" id="hideNavBtns" />
<label for="hideNavBtns"> hideNavBtns : {hideNavBtns}</label>
</div>
You can see the full examples in the demos's page
Tabs' API
Tab's API
Note : if u want to pass props or attribute to the html element u must use asProps prop
Note : this prop uses <svelte:element {...asProps} /> inisde so basically you can pass anything as prop to it!
Please let me see your reviews and if there're any features you want me to add them to the project!
Dont forget to star the project on GITHUB 0_0
License
MIT © Mohammed Aliwi