@shuaninfo/vue-chrome-tabs NPM

vue-chrome-tabs

A Vue2 component for Chrome-like tabs. Drag-and-drop support provided by Draggabilly by @desandro.

If you are using Vue3, please see here. https://github.com/shuaninfo/vue3-tabs-chrome

Live Demo

https://shuaninfo.github.io/vue-chrome-tabs/

Code Sandbox Example

https://codesandbox.io/s/kind-wave-00ipv?file=/src/App.vue

CDN

https://codepen.io/shuaninfo/pen/GRmKaZZ

Install

npm i vue-chrome-tabs -S

Usage

<template>
  <vue-chrome-tabs v-model="tab" :tabs="tabs" />
</template>
<script>
  import Vue from 'vue'
  import VueChromeTabs from 'vue-chrome-tabs'

  export default {
    components: {
      VueChromeTabs
    },
    data() {
      return {
        tab: 'google',
        tabs: [
          {
            label: 'google',
            key: 'google',
            closable: false,
            favicon: require('./assets/google.jpg')
          },
          {
            label: 'facebook',
            key: 'facebook',
            favicon: require('./assets/fb.jpg')
          },
          {
            label: 'New Tab',
            key: 'any-string-key',
            favicon: (h, { tab, index }) => {
              return h('span', tab.label)
            }
          }
        ]
      }
    }
  }
</script>

Attributes

Attributes	Description	Type	Default
tabs	tabs configuration. Details are mentioned below.	Array	[]
value / v-model	binding value	String	-
props	configuration options, Details are mentioned below.
insert-to-after	Insert to tag's after	Boolean	false
is-mousedown-active	set tab is active when mousedown	Boolean	true
render-label	render label	Function(tab, index)	-
auto-hidden-close-icon-width	auto hidden close tab width. if tabWidth < 120, close icon can not show. If you don’t want this feature, you can set the value to 0.	Number	120
on-close	when tab close btn click. if return false, it cannot be closed.	Function(tab, key, index)	-
tab-close-width	tab close icon width.	Number	16

Tabs Attributes

Attributes	Description	Type	Default
label	tab label	String	-
key	tab key	String	-
class	tab class	String	-
closable	tab closable	Boolean	true
dragable	tab tragable	Boolean	true
swappable	tab swappable	Boolean	true
favicon	tab favicon. Custom favicon renderer. It uses Vue's render function. It accepts two arguments: the first is h, the second is an object. including tab and index	Function, required image	-

Props Attributes

Attributes	Description	Type	Default
label	specify which key of tab object is used as the tab's label	String	'label'
key	specify which key of tab object is used as the tab's key	String	'key'

Methods

Method	Description	Parameters
addTab	add tab	(tab1, , ...tab, ...tabN)
removeTab	remove tab	(tabKey or index)
getTabs	get tabs	-

Events

Event Name	Description	Parameters
click	Triggered when the user's pointer is pressed and unpressed and has not moved enough to start dragging.	(event, tab, index)
swap	Swap tab	(tab, targetTab)
remove	Remove tab	(tab, index)
contextmenu	Contextmenu event	(event, tab, index)
dragstart	Tab dragstart event	(event, tab, index)
dragging	Tab dragstart event	(event, tab, index)
dragend	Tab dragend event	(event, tab)

Slots

Attributes	Description
after	Tab after slot
close-icon	Close icon

Change log

0.10.0

feat: Add Custom Close Button.

v0.9.2

fix: 'v0.9.1' doesn't work

v0.9.1

fix: 'dragable' needs to respond to the 'click' event.

v0.9.0

feat: tab can set dragable.
feat: tab can set swappable.
feat: can be introduced with "Vue.components" instead of "Vue.use".
feat: new example UI.
feat: new 'Chrome UI' example.
feat: new 'swap & drag' example.
remove: remove 'Save to Localstorage' example.

2020/9/21

fix: tabkey => tabthis.tabKey

2020/9/21

feat: add after slots feat: add drag events

2020/9/7

fix: closable not work feat: auto hidden close tab width

2020/8/19

add new feature: tab close event listener & tab custom class

2020/2/10

add new feature: tab closable

License

MIT

draggabilly

@infinitebrahmanuniverse/nolb-_shu @everything-registry/sub-chunk-833 @zalastax/nolb-_shu

0.11.0

3 years ago

0.10.1

3 years ago