Skip to content
This repository has been archived by the owner on Jun 13, 2022. It is now read-only.

Commit

Permalink
docs: include background, color and class` in README
Browse files Browse the repository at this point in the history
  • Loading branch information
ericcornelissen committed Mar 12, 2020
1 parent 29c7ccd commit d29b902
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,13 @@ style: {
}
```

You can specify `color` and `background` directly as well.

```coffeescript
color: "red"
background: "green"
```

### Button hover

you can use CSS styles for button hover per button.
Expand All @@ -154,12 +161,12 @@ hover: {

### Button class

Using a comma separated list you can add your own class names to buttons.
Using an array you can add your own class names to buttons.
This is great if you want to take advantage of native styles like Font Awesome
or if you have your own styles you prefer to keep in a stylesheet.

```coffeescript
className: "fa-rotate-90, custom-class"
class: ["fa-rotate-90", "custom-class"]
```

### Multiple callback
Expand Down Expand Up @@ -305,7 +312,9 @@ This is same above.
type: "button"
icon: "sitemap"
iconset: "fa"
className: "fa-rotate-180"
class: "fa-rotate-180"
color: "red"
background: "green"
tooltip: "This is just an example it does nothing"
}
{
Expand Down Expand Up @@ -384,7 +393,9 @@ module.exports = [
type: "button"
icon: "sitemap"
iconset: "fa"
className: "fa-rotate-180"
class: "fa-rotate-180"
color: "red"
background: "green"
tooltip: "This is just an example it does nothing"
}
{
Expand Down

0 comments on commit d29b902

Please sign in to comment.