https://github.com/justforuse/functional-button
⚙Functional button
https://github.com/justforuse/functional-button
button plugin vue vuejs
Last synced: 5 months ago
JSON representation
⚙Functional button
- Host: GitHub
- URL: https://github.com/justforuse/functional-button
- Owner: justforuse
- Created: 2019-05-11T11:38:42.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-28T18:00:36.000Z (almost 3 years ago)
- Last Synced: 2025-02-16T10:35:42.783Z (about 1 year ago)
- Topics: button, plugin, vue, vuejs
- Language: JavaScript
- Homepage: https://justforuse.github.io/functional-button/docs/
- Size: 1.88 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# functional-button
[ ](https://www.npmjs.com/package/functional-button)
[](https://vuejs.org/)
[](http://hits.dwyl.io/justforuse/functional-button)
Useful functional button for ElementUI
> Project is generated by https://github.com/justforuse/vue-share-components
## Table of contents
- [Installation](#installation)
- [Usage](#usage)
- [Example](#example)
# Installation
```
npm install --save functional-button
```
## Default import
Install all the components:
```javascript
import Vue from 'vue'
import FunctionalButton from 'functional-button'
Vue.use(FunctionalButton)
```
Use specific components:
```javascript
import Vue from 'vue'
import { Test } from 'functional-button'
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 'functional-button/dist/functional-button.css'
import FunctionalButton from 'functional-button/dist/functional-button.common'
Vue.use(FunctionalButton)
```
Use specific components:
```javascript
import 'functional-button/dist/functional-button.css'
import { DeferBtn } from 'functional-button/dist/functional-button.common'
Vue.component('DeferBtn', DeferBtn)
```
**⚠️ 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(FunctionalButton)
```
Use specific components:
```javascript
Vue.component('DeferBtn', FunctionalButton.DeferBtn)
```
## Source import
Install all the components:
```javascript
import Vue from 'vue'
import FunctionalButton from 'functional-button/src'
Vue.use(FunctionalButton)
```
Use specific components:
```javascript
import Vue from 'vue'
import { DeferBtn } from 'functional-button/src'
Vue.component('DeferBtn', DeferBtn)
```
**⚠️ 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
https://codesandbox.io/s/24jx3zz2ny
---
# 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 functional-button
```
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)