README
Shapla Button
A simple button, in different colors, sizes, and states
Table of contents
Installation
npm install --save shapla-button
Usage
Styles
with SCSS:
import 'shapla-button/src/index.scss';
with CSS:
import 'shapla-button/dist/style.css';
Javascript Instantiation
import shaplaButton from 'shapla-button';
export default {
name: 'Hello',
components: {
shaplaButton
},
methods: {
handleClick() {
// Handle click event
}
}
}
<shapla-button @click="handleClick"></shapla-button>
Props
Property | Type | Required | Default | Description |
---|---|---|---|---|
theme |
String | no | default |
Value can be default or primary or secondary or success or warning or error |
size |
String | no | normal |
Value can be normal or small or medium or large |
fullwidth |
Boolean | no | false |
If set true , button will take full width. |
disabled |
Boolean | no | false |
If set true , disabled attribute will be added. |
outline |
Boolean | no | false |
If set true , outline style will be used. |
rounded |
Boolean | no | false |
If set true , rounded style will be used |
fab |
Boolean | no | false |
If set true , circle style will be used. |
shadow |
Boolean | no | false |
If set true , box-shadow will be added around button. |
Listeners
The button component fires the following events:
click
: When button is clicked, it fires the event.
<!-- template -->
<shapla-button @click="handleClick"></shapla-button>
<!-- method -->
methods: {
handleClick(){
// Handle click event
}
}