Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/r3l4x3/vue-nouislider
⚠️ WIP ⚠️ A Vue.js wrapper for noUiSlider
https://github.com/r3l4x3/vue-nouislider
Last synced: about 2 months ago
JSON representation
⚠️ WIP ⚠️ A Vue.js wrapper for noUiSlider
- Host: GitHub
- URL: https://github.com/r3l4x3/vue-nouislider
- Owner: R3l4x3
- Created: 2017-04-06T12:35:51.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-04-07T13:38:48.000Z (over 7 years ago)
- Last Synced: 2024-10-17T06:20:11.079Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 134 KB
- Stars: 11
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vue-nouislider
>A [Vue.js](https://vuejs.org/) wrapper for [noUiSlider](https://refreshless.com/nouislider/)
## Table of contents
- [Installation](#installation)
- [Usage](#usage)
- [Example](#example)
# Installation
```
npm install --save vue-nouislider
```
## Default import
Install all the components:
```javascript
import Vue from 'vue'
import VueNouislider from 'vue-nouislider'
Vue.use(VueNouislider)
```
Use specific components:
```javascript
import Vue from 'vue'
import { Test } from 'vue-nouislider'
Vue.component('test', Test)
```
**⚠️ 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-nouislider/dist/vue-nouislider.css'
import VueNouislider from 'vue-nouislider/dist/vue-nouislider.common'
Vue.use(VueNouislider)
```
Use specific components:
```javascript
import 'vue-nouislider/dist/vue-nouislider.css'
import { Test } from 'vue-nouislider/dist/vue-nouislider.common'
Vue.component('test', Test)
```
**⚠️ 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(VueNouislider)
```
Use specific components:
```javascript
Vue.component('test', VueNouislider.Test)
```
## Source import
Install all the components:
```javascript
import Vue from 'vue'
import VueNouislider from 'vue-nouislider/src'
Vue.use(VueNouislider)
```
Use specific components:
```javascript
import Vue from 'vue'
import { Test } from 'vue-nouislider/src'
Vue.component('test', Test)
```
**⚠️ 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-nouislider
```
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)