Tabs

A flexible modern tabs js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/tabs

NPM

npm i @pluginjs/tabs

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/tabs/dist/tabs.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/tabs/dist/tabs.css">

Production:

<script src="https://unpkg.com/@pluginjs/tabs/dist/tabs.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/tabs/dist/tabs.min.css">

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import Tabs from "@pluginjs/tabs"
import "@pluginjs/tabs/dist/tabs.css"

Tabs.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/tabs/dist/tabs.css")
const Tabs = require("@pluginjs/tabs")

Tabs.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/tabs/dist/tabs.css">
<script src="https://unpkg.com/@pluginjs/tabs/dist/tabs.js"></script>
<script>
  Pj.tabs('.element', options)
</script>

API

Options

Options are called on tabs instances through the tabs options itself. You can also save the instances to variable for further use.

Name | Description | Default --|--|-- "theme" | Add plugin theme option | null "navSelector" | Set nav dom selector | null "contentSelector" | Set content dom selector | + "navPosition" | Set nav position | null "initialIndex" | Setup index of tab list | 0 "ajax" | Set is enabled ajax to loading data | false "cached" | Set ajax data could be cached or not | false "history" | Set history | false "historyAttr" | Set history attribute | id "keyboard" | Set keyboard | false "effect" | Set effect | fadeIn "duration" | Set duration | 300 "event" | Set action of event handle | click "breakWidth" | Set break width value | null "navLabelSelector" | Set nav label dom selector | null "navWrapSelector" | Set nav wrap selector | null "navLabelTpl" | Set nav label html | <a href="javascript:void(0)"><i class='icon-char icon-chevron-down'></i>tab1</a> "navWrapTpl" | Set nav wrap html | <div></div> "resizeReference" | Set resize reference | window "responsiveMode" | Set responsive mode | drop "onInit" | Set initial callback | null "onReady" | Set ready callback | null

Events

Events are called on tabs instances through the tabs events itself. You can also save the instances to variable for further use.

Name | Description --|-- "active" | Get fired when plugin has actived "update" | Gets fired when plugin has destroy "ready" | Gets fired when plugin has ready "resize" | Get fired when plugin has resize "enable" | Gets fired when plugin has enabled "disable" | Gets fired when plugin has disabled "destroy" | Gets fired when plugin has destroy

Methods

Methods are called on tabs instances through the tabs method itself. You can also save the instances to variable for further use.

Name | Description --|-- "update" | Refresh plugin by new options "enable" | Enabled plugin if plugin is disabled "disable" | Disable plugin "destroy" | Destroy plugin "getTabs" | Get tabs jquery element "getPanes" | Get panes jquery element "getCurrentPane" | Get current pane jquery element "getCurrentTab" | Get current tab jquery element "getIndex" | Get current index "getSize" | Get current size "next" | Go next tab "prev" | Go prev tab "add" | Add a tab by label, content, and index "remove" | Remove a tab by index "append" | Append a tab by label and content

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-tabs "THEME" | Declare plugin theme | {namespace}-{theme} "ELEMENT" | Declare tabs element | {namespace} "RESPONSIVE" | Declare responsive node | {namespace}-{responsiveMode} "NAVLABEL" | Declare nav label | {namespace}-nav-label "NAVWRAP" | Declare nav wrap | {namespace}-nav-wrap "DROPOPEN" | Announce drop open | {namespace}-drop-open "ACTIVE" | Announce plugin is actived | {namespace}-active "DISABLED" | Announce plugin is disabled | {namespace}-disabled "NAV" | Declare nav dom node | {namespace}-nav "CONTENT" | Declare content node | {namespace}-content "LOADING" | Announce plugin is loading | {namespace}-loading

Browser support

Tested on all major browsers.

| IE / Edge | Firefox | Chrome | Safari | Opera | | --------- | --------- | --------- | --------- | --------- | | IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions|

License

@pluginjs/tabs is Licensed under the GPL-v3 license.

If you want to use @pluginjs/tabs project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [email protected].

Copyright

Copyright (C) 2022 Creation Studio Limited.