coffeescript-ui
Version:
Coffeescript User Interface System
52 lines (46 loc) • 4.42 kB
Markdown
```div-parameter
## Parameter Button
| Parameter | Format | Default | Mandatory | Description |
| --- | --- | :---: | :---: | --- |
| size | <dt><String> = <dd>"auto" | "mini" | "normal" | "big" | "bigger" | `auto` | yes | Describes the button's size.<dt>`auto`<dd>The button is automatically formatted. e.g. when a button is in the lower right corner of a ConfirmationDialog it shown as big button.<dt>`mini`<dd>Small button.<dt>`normal`<dd>Medium sized button.<dt>`big`<dd>Big sized button.<dt>`bigger`<dd>Even bigger sized button. |
| appearance | <dt><String> = <dd>"auto" | "link" | "flat" | "normal" | "important" | `auto` | yes | Describes the button's visual appearance.<dt>`auto`<dd>The button is automatically formatted.<dt>`link`<dd>Standard button without border and a underlined text.<dt>`flat`<dd>Button has no border and inherits its background color from its parent div.<dt>`normal`<dd>Standard button with border and its own background color.<dt>`important`<dd>emphasized button to show the user that the button is important. |
| primary | <dt><Boolean> | `false` | yes | <dt>true<dd><dt>false<dd> |
| click_type | <dt><String> = <dd>"click" | "mouseup" | "dbclick" | "touchstart" | "touched" | `click` | yes | Required user's action to call *onclick*-function<dt>`click`<dd>Normal single click<dt>`mouseup`<dt>`dblclick`<dd>Doubleclick<dt>`touchstart`<dt>`touchend` |
| tabindex | <dt><Integer><dt><Boolean> | `0` | no | <dt>`false`<dt>`1`<dt>`2`<dt>`...` |
| role | <dt><String> | button | no | |
| confirm_on_click | <dt><String> | - | no | |
| text | <dt><String> | - | no | |
| tooltip | <dt>PlainObject` | - | no | |
| disabled | <dt><Boolean><dt>function() | `false` | no | <dt>true<dd><dt>false<dd> |
| active_css_class | <dt><String> | - | no | |
| left | <dt>true<dt><Object> = CUI-Element<dt><String> | - | no | <dt>true<dt>Element<dt>String <br>*Must not be one of the following elements: `icon`, `icon_left`, `icon_active`, `icon_inactive`* |
| right | <dt>true<dt>Content | - | no | <dt>true<dt>Content <br>*Must not be one of the following elements: `icon_right`* |
| center | <dt>`Element`<dt>`String` | - | no | |
| icon | <dt><Object> = Icon<dt><String> | - | no | <dt>Icon-Element<dd><dt>Name of Icon as String<dd> |
| icon_left | <dt><Object> = Icon<dt><String> | - | no | <dt>Icon-Element<dd><dt>Name of Icon as String<dd> |
| icon_right | <dt><Object> = Icon<dt><String><dt><Boolean> | - | no | <dt>Icon-Element<dd><dt>Name of Icon as String<dd><dt><true><dd><dt><false><dd> |
| icon_active | <dt><Object> = Icon<dt><String> | - | no | <dt>Icon-Element<dd><dt>Name of Icon as String<dd> |
| icon_inactive | <dt><Object> = Icon<dt><String> | - | no | <dt>Icon-Element<dd><dt>Name of Icon as String<dd> |
| text_active | <dt><String> | - | no | |
| text_inactive | <dt><String> | - | no | |
| attr | <dt>PlainObject | {} | no | |
| name | <dt><String> | - | no | |
| hidden | <dt><Boolean><dt>function() | - | no | <dt>true<dd><dt>false<dd> |
| menu | <dt>PlainObject | - | no | |
| menu_on_hover | <dt><Boolean> | - | no | <dt>true<dd><dt>false<dd> |
| menu_parent | ? Menu | - | no | |
| menu | <dt>PlainObject | - | no | |
| radio | <dt><String><dt><Boolean> | - | no | <dt>true<dd><dt>false<dd> |
| radio_allow_null | <dt><Boolean> | - | no | <dt>true<dd><dt>false<dd> |
| switch | <dt><Boolean> | - | no | <dt>true<dd><dt>false<dd> |
| active | <dt><Boolean> | - | no | <dt>true<dd><dt>false<dd> |
| activate_initial | <dt><Boolean> | true | no | <dt>true<dd><dt>false<dd> |
| group | <dt><String> | - | no | |
## Callbacks Button
| Callback | Format | Default | Mandatory | Description |
| --- | --- | :---: | :---: | --- |
| onClick | <dt>function() | - | no | Functional description of the button's response to the user's click. |
| onActivate | <dt>function() | - | no | |
| onDeactivate | <dt>function() | - | no | |
```
@@include(../../core/dom/dom_p.md)