https://github.com/denull/vue-chrome-tabs
A Vue component for Chrome-like tabs (based on adamschwartz/chrome-tabs)
https://github.com/denull/vue-chrome-tabs
Last synced: over 1 year ago
JSON representation
A Vue component for Chrome-like tabs (based on adamschwartz/chrome-tabs)
- Host: GitHub
- URL: https://github.com/denull/vue-chrome-tabs
- Owner: denull
- Created: 2018-02-08T12:07:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-20T13:10:37.000Z (about 3 years ago)
- Last Synced: 2025-02-17T15:16:28.031Z (over 1 year ago)
- Language: Vue
- Size: 380 KB
- Stars: 8
- Watchers: 4
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vue-chrome-tabs
[ ](https://www.npmjs.com/package/vue-chrome-tabs)
[](https://vuejs.org/)
A Vue component for Chrome-like tabs (based on [chrome-tabs library](https://github.com/adamschwartz/chrome-tabs)).
[Demo](https://denull.github.io/vue-chrome-tabs/demo.html).
## Table of contents
- [Installation](#installation)
- [Usage](#usage)
- [Example](#example)
# Installation
```
npm install --save vue-chrome-tabs
```
## Default import
Install all the components:
```javascript
import Vue from 'vue'
import VueChromeTabs from 'vue-chrome-tabs'
Vue.use(VueChromeTabs)
```
Use specific components:
```javascript
import Vue from 'vue'
import { ChromeTabs } from 'vue-chrome-tabs'
Vue.component('chrome-tabs', ChromeTabs)
```
**⚠️ A css file is included when importing the package. You may have to setup your bundler to embed the css in your page.**
## Distribution import
Install all the components:
```javascript
import 'vue-chrome-tabs/dist/vue-chrome-tabs.css'
import VueChromeTabs from 'vue-chrome-tabs/dist/vue-chrome-tabs.common'
Vue.use(VueChromeTabs)
```
Use specific components:
```javascript
import 'vue-chrome-tabs/dist/vue-chrome-tabs.css'
import { ChromeTabs } from 'vue-chrome-tabs/dist/vue-chrome-tabs.common'
Vue.component('chrome-tabs', ChromeTabs)
```
**⚠️ You may have to setup your bundler to embed the css file in your page.**
## Browser
```html
```
The plugin should be auto-installed. If not, you can install it manually with the instructions below.
Install all the components:
```javascript
Vue.use(VueChromeTabs)
```
Use specific components:
```javascript
Vue.component('chrome-tabs', VueChromeTabs.ChromeTabs)
```
## Source import
Install all the components:
```javascript
import Vue from 'vue'
import VueChromeTabs from 'vue-chrome-tabs/src'
Vue.use(VueChromeTabs)
```
Use specific components:
```javascript
import Vue from 'vue'
import { ChromeTabs } from 'vue-chrome-tabs/src'
Vue.component('chrome-tabs', ChromeTabs)
```
**⚠️ You need to configure your bundler to compile `.vue` files.** More info [in the official documentation](https://vuejs.org/v2/guide/single-file-components.html).
# Usage
> TODO
# Example
> TODO
---
# Plugin Development
## Installation
The first time you create or clone your plugin, you need to install the default dependencies:
```
npm install
```
## Watch and compile
This will run webpack in watching mode and output the compiled files in the `dist` folder.
```
npm run dev
```
## Use it in another project
While developping, you can follow the install instructions of your plugin and link it into the project that uses it.
In the plugin folder:
```
npm link
```
In the other project folder:
```
npm link vue-chrome-tabs
```
This will install it in the dependencies as a symlink, so that it gets any modifications made to the plugin.
## Publish to npm
You may have to login to npm before, with `npm adduser`. The plugin will be built in production mode before getting published on npm.
```
npm publish
```
## Manual build
This will build the plugin into the `dist` folder in production mode.
```
npm run build
```
---
## License
[MIT](http://opensource.org/licenses/MIT)