Button and Button Group¶

Last Updated: August 10, 2015

class tethys_sdk.gizmos.Button(display_text='', name='', style='', icon='', href='', submit=False, disabled=False, attributes={}, classes='')¶

display_text¶

str

Display text that appears on the button.

name¶

str

Name of the input element that will be used for form submission.

style¶

str

Name of the input element that will be used for form submission.

icon¶

str

Name of a valid Twitter Bootstrap icon class (see the Bootstrap glyphicon reference).

href¶

str

Link for anchor type buttons.

submit¶

bool

Set this to true to make the button a submit type button for forms.

disabled¶

bool

Set the disabled state.

attributes¶

dict

A dictionary representing additional HTML attributes to add to the primary element (e.g. {“onclick”: “run_me();”}).

classes¶

str

Additional classes to add to the primary HTML element (e.g. “example-class another-class”).

Example:

# CONTROLLER

from tethys_sdk.gizmos import Button

# Single Button
single_button = Button(display_text='Click Me',
                       name='click_me_name',
                       attributes={"onclick": "alert(this.name);"},
                       submit=True)

# TEMPLATE

{% gizmo button single_button %}

class tethys_sdk.gizmos.ButtonGroup(buttons, vertical=False, attributes='', classes='')¶

The button group gizmo can be used to generate a single button or a group of buttons. Groups of buttons can be stacked horizontally or vertically. For a single button, specify a button group with one button. This gizmo is a wrapper for Twitter Bootstrap buttons.

buttons¶

list, required

A list of dictionaries where each dictionary contains the options for a button.

vertical¶

bool

Set to true to have button group stack vertically.

attributes¶

str

A string representing additional HTML attributes to add to the primary element (e.g. “onclick=run_me();”).

classes¶

str

Additional classes to add to the primary HTML element (e.g. “example-class another-class”).

Example

# CONTROLLER

from tethys_sdk.gizmos import Button, ButtonGroup

# Horizontal Button Group
add_button = Button(display_text='Add',
                    icon='glyphicon glyphicon-plus',
                    style='success')
delete_button = Button(display_text='Delete',
                       icon='glyphicon glyphicon-trash',
                       disabled=True,
                       style='danger')
horizontal_buttons = ButtonGroup(buttons=[add_button, delete_button])

# Vertical Button Group
edit_button = Button(display_text='Edit',
                     icon='glyphicon glyphicon-wrench',
                     style='warning',
                     attributes='id=edit_button')
info_button = Button(display_text='Info',
                     icon='glyphicon glyphicon-question-sign',
                     style='info',
                     attributes='name=info')
apps_button = Button(display_text='Apps',
                     icon='glyphicon glyphicon-home',
                     href='/apps',
                     style='primary')
vertical_buttons = ButtonGroup(buttons=[edit_button, info_button, apps_button], vertical=True)

# TEMPLATE

{% gizmo button_group horizontal_buttons %}
{% gizmo button_group vertical_buttons %}