https://github.com/STUkh/vue-promise-btn

Vue.js plugin that handles buttons async lock state. Demo: https://stukh.github.io/vue-promise-btn/
https://github.com/STUkh/vue-promise-btn

promise-btn spinner vue vue-promise-btn

Last synced: about 11 hours ago
JSON representation

Vue.js plugin that handles buttons async lock state. Demo: https://stukh.github.io/vue-promise-btn/

• Host: GitHub
• URL: https://github.com/STUkh/vue-promise-btn
• Owner: STUkh
• License: mit
• Created: 2018-03-16T14:29:28.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-29T10:38:25.000Z (almost 2 years ago)
• Last Synced: 2024-10-17T11:46:09.850Z (27 days ago)
• Topics: promise-btn, spinner, vue, vue-promise-btn
• Language: JavaScript
• Homepage:
• Size: 3.93 MB
• Stars: 173
• Watchers: 7
• Forks: 14
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# vue-promise-btn

[![NPM Version](http://img.shields.io/npm/v/vue-promise-btn.svg?style=flat-square)](https://www.npmjs.com/package/vue-promise-btn)

[![Download Month](http://img.shields.io/npm/dm/vue-promise-btn.svg?style=flat-square)](https://www.npmjs.com/package/vue-promise-btn)

## Example and Documentation

https://STUkh.github.io/vue-promise-btn/



    



## Features

- Easy-to-use API

- Flexible Usage

- Works with any tag and even forms

- In Extended Mode - compatible with 3rd party components

- Packaged with optional built-in spinner

- Only 1.5KB minified and gzipped

- ESM, CommonJS, UMD versions

### Installation

```

npm install --save vue-promise-btn

```

#### Quick Start:

- Import and "handshake" plugin with vue

```javascript

import Vue from 'vue'

import VuePromiseBtn from 'vue-promise-btn'

// not required. Styles for built-in spinner

import 'vue-promise-btn/dist/vue-promise-btn.css'

Vue.use(VuePromiseBtn) // or with global options Vue.use(VuePromiseBtn, {})

```

- Simple usage:

``` Get Data ```

- Extended usage: ``` Get Data ```

#### If you face any issue with simple mode, just try out extended, it's more reliable way.

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Important Notice

Always return Promise from expression. Especially in simple mode.

Don't use semicolon in event expressions. It may break promise return in template-compiler: 


Good: `@click="handler($event)"` 


Bad: `@click="handler($event);"`

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.

## Credits

- [Alex Stepchenkov](https://github.com/STUkh)

- [All Contributors](https://github.com/STUkh/vue-promise-btn/graphs/contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

© [STUkh](https://github.com/STUkh)