Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steven5538/vue-button
Button component for Vue.js v2.0.1+.
https://github.com/steven5538/vue-button
Last synced: 3 months ago
JSON representation
Button component for Vue.js v2.0.1+.
- Host: GitHub
- URL: https://github.com/steven5538/vue-button
- Owner: steven5538
- License: mit
- Created: 2016-11-20T12:32:17.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-11-22T03:36:07.000Z (about 8 years ago)
- Last Synced: 2024-10-26T03:21:34.808Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 91.8 KB
- Stars: 18
- Watchers: 2
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vue - vue-button - button?style=social) - Vue按钮组件 (UI组件)
- awesome-github-vue - vue-button - Vue按钮组件 (UI组件)
- awesome-github-vue - vue-button - Vue按钮组件 (UI组件)
- awesome - vue-button - Vue按钮组件 (UI组件)
README
# vue-button [![Build Status](https://travis-ci.org/steven5538/vue-button.svg?branch=master)](https://travis-ci.org/steven5538/vue-button) [![Dependency Status](https://gemnasium.com/badges/github.com/steven5538/vue-button.svg)](https://gemnasium.com/github.com/steven5538/vue-button) ![MIT License](https://img.shields.io/github/license/steven5538/vue-button.svg)
> Button component for Vue.js v2.0.1+.
![vue-button](http://i.imgur.com/YLEH5Ko.png)
## Installation
### NPM (Recommended)
``` bash
$ npm install vue-button
```
### manual
Download `dist/vue-button.js` and include it in your HTML file:
```html```
or you can include from [unpkg](https://unpkg.com).
```html```
## Usage
```htmlButton
Button
Button
Button
Button
```
## ES Modules with NPM & vue-loader (Recommended)
```js
import Vue from 'Vue'
import VueButton from 'vue-button'// register component to use
Vue.component('v-button', VueButton)
```
## Parameters
```js
/**
* Equivalent to the `id` attribute on an ``.
* @type {String}
*/
id: {
type: String,
default: null
},/**
* Attach your custom class on the compontent.
* That means you can change the style if you want.
* @type {String}
*/
customClass: {
type: String,
default: null
},/**
* Equivalent to the `name` attribute on an ``.
* @type {String}
*/
name: {
type: String,
default: null
},/**
* Equivalent to the `disabled` attribute on an ``.
* @type {Boolean}
*/
disabled: {
type: Boolean,
default: false
},/**
* If set enable button font size will be large.
* @type {Boolean}
*/
large: {
type: Boolean,
default: false
},/**
* Markup button.
* The value can be `default`, `primary`, `success`, `warning`, `error`.
* @type {String}
*/
markup: {
type: String,
default: 'default'
},/**
* Set the click event on ``.
*/
@click {
type: Object,
defalut: null
}
```