Buttons Interface

class epyk.interfaces.components.CompButtons.Buttons(ui)

Buttons Interface.

absolute(text: str, size_notch=None, icon: str = '', top: Optional[Union[tuple, int, str]] = (50, '%'), left: Optional[Union[tuple, int, str]] = (50, '%'), bottom=None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → Button

Display a button on the page regardless the current layout of components. By default, the button will be center on the page.

Tags:

Categories:

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Usage:

page.ui.buttons.absolute("Test")

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py

Parameters:

• text – Optional. The value to be displayed to the button

• size_notch – Optional. A value to be added to the number font size

• bottom – Optional. The position of the component

• icon – Optional. A string with the value of the icon to display from font-awesome

• top – Optional. A tuple with the integer for the component’s distance to the top of the page

• left – Optional. A tuple with the integer for the component’s distance to the left of the page

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• options – Optional. Specific Python options available for this component

• profile – Optional. A flag to set the component performance storage

button(text: str = '', icon: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[Union[bool, dict]] = None) → Button

Standard button

Tags:

Categories:

Usage:

page.ui.button("Test")

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Related Pages:

https://www.w3schools.com/tags/tag_button.asp http://www.kodingmadesimple.com/2015/04/custom-twitter-bootstrap-buttons-icons-images.html

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py https://github.com/epykure/epyk-templates/blob/master/locals/components/alerts.py https://github.com/epykure/epyk-templates/blob/master/locals/components/button_link.py https://github.com/epykure/epyk-templates/blob/master/locals/components/checkbox.py

Parameters:

• text – Optional. The value to be displayed to the button

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• icon – Optional. A string with the value of the icon to display from font-awesome

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

cancel(text: str = 'Cancel', width: Union[tuple, int] = (None, '%'), height: Union[tuple, int] = (None, 'px'), html_code: Optional[str] = None, align: str = 'left', tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None) → Button

Button with cross icon to cancellation actions.

Tags:

Categories:

Usage:

page.ui.buttons.cancel("Cancel")

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Related Pages:

https://www.w3schools.com/tags/tag_button.asp http://www.kodingmadesimple.com/2015/04/custom-twitter-bootstrap-buttons-icons-images.html

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py

Parameters:

• text – Optional. The value to be displayed to the button

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• align – Optional. The text-align property within this component

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

check(flag: bool = False, tooltip: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = (20, 'px'), label: Optional[str] = None, icon: Optional[str] = None, html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[Union[bool, dict]] = None) → CheckButton

Wrapper to the checkbox button object.

Tags:

Categories:

Usage:

page.ui.buttons.check(label="Label")
page.ui.buttons.check(True, label="Label")
page.ui.buttons.check(True, label="Label", icon="fas fa-align-center")

Underlying HTML Objects:

• epyk.core.html.HtmlButton.CheckButton

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py https://github.com/epykure/epyk-templates/blob/master/locals/components/checkbox.py

Parameters:

• flag – Optional. The value of the checkbox. Default False

• tooltip – Optional. A string with the value of the tooltip

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• label – Optional. The component label content

• icon – Optional. The icon to be used in the check component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

checkboxes(record=None, color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: str = '', options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None)

Python wrapper to the HTML checkbox elements.

Tips: record data should be in the format expected by the component. If needed a data helper can be used. from the data package in the component property, the various functions available for the checkboxes will help.

Tags:

Categories:

Usage:

page.ui.buttons.checkboxes(data)

cb2 = page.ui.buttons.checkboxes(data, color="red", width=(100, "px"))
cb2.style.configs.shadow()
cb2.click([page.js.console.log(cb2.dom.current)])

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Checkbox

Related Pages:

https://www.w3schools.com/howto/howto_css_custom_checkbox.asp

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button_checkboxes.py

Parameters:

• record – Optional. The list of dictionaries with the data

• color – Optional. The color code

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. The text-align property within this component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• options – Optional. Specific Python options available for this component

• profile – Optional. A flag to set the component performance storage

clear(text: str = '', icon: str = 'fas fa-eraser', color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[Union[bool, dict]] = None) → Button

Standard clear button with a font-awesome icon.

Usage:

page.ui.buttons.clear("Clear")

Tags:

Categories:

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Related Pages:

https://www.w3schools.com/tags/tag_button.asp http://www.kodingmadesimple.com/2015/04/custom-twitter-bootstrap-buttons-icons-images.html

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py https://github.com/epykure/epyk-templates/blob/master/locals/components/alerts.py https://github.com/epykure/epyk-templates/blob/master/locals/components/button_link.py https://github.com/epykure/epyk-templates/blob/master/locals/components/checkbox.py

Parameters:

• text – Optional. The value to be displayed to the button

• color – Optional. The font color in the component. Default inherit

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• icon – Optional. A string with the value of the icon to display from font-awesome

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

colored(text: str = '', icon: Optional[str] = None, color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[Union[bool, dict]] = None) → Button

Standard colored button.

Tags:

Categories:

Usage:

page.ui.buttons.colored("Test")

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Related Pages:

https://www.w3schools.com/tags/tag_button.asp http://www.kodingmadesimple.com/2015/04/custom-twitter-bootstrap-buttons-icons-images.html

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py https://github.com/epykure/epyk-templates/blob/master/locals/components/alerts.py https://github.com/epykure/epyk-templates/blob/master/locals/components/button_link.py https://github.com/epykure/epyk-templates/blob/master/locals/components/checkbox.py

Parameters:

• text – Optional. The value to be displayed to the button

• icon – Optional. A string with the value of the icon to display from font-awesome

• color – Optional. The font color in the component. Default inherit

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

data(filename, text: str = '', icon: Optional[Union[str, bool]] = None, width: Union[tuple, int] = (None, '%'), height: Union[tuple, int] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None)

Standard refresh button with a font-awesome icon.

Tags:

Categories:

Usage:

page.ui.buttons.refresh("Refresh")

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Related Pages:

https://www.w3schools.com/tags/tag_button.asp http://www.kodingmadesimple.com/2015/04/custom-twitter-bootstrap-buttons-icons-images.html

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py https://github.com/epykure/epyk-templates/blob/master/locals/components/alerts.py https://github.com/epykure/epyk-templates/blob/master/locals/components/button_link.py https://github.com/epykure/epyk-templates/blob/master/locals/components/checkbox.py

Parameters:

• filename – Optional. The filename

• text – Optional. The value to be displayed to the button

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• icon – Optional. A string with the value of the icon to display from font-awesome

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

filter(text: str = '', is_number: bool = False, width: Union[tuple, int] = ('auto', ''), height: Union[tuple, int] = (None, 'px'), html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None)

Tags:

Categories:

Usage:

:param text: Optional. The filter value
:param is_number: Optional. The filter property type
:param width: Optional. A tuple with the integer for the component width and its unit
:param height: Optional. A tuple with the integer for the component height and its unit
:param html_code: Optional. An identifier for this component (on both Python and Javascript side)
:param tooltip: Optional. A string with the value of the tooltip
:param profile: Optional. A flag to set the component performance storage
:param options: Optional. Specific Python options available for this component

important(text: str = '', icon: Optional[str] = None, width: Union[tuple, int] = (None, '%'), height: Union[tuple, int] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None) → Button

Same as Standard button but used to attract user attention.

Tags:

Categories:

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Usage:

page.ui.buttons.important("Important")

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Related Pages:

https://www.w3schools.com/tags/tag_button.asp http://www.kodingmadesimple.com/2015/04/custom-twitter-bootstrap-buttons-icons-images.html

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py

Parameters:

• text – Optional. The value to be displayed to the button

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• icon – Optional. A string with the value of the icon to display from font-awesome

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

large(text: str = '', icon: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[Union[bool, dict]] = None) → Button

Large button.

Usage:

page.ui.buttons.large("Test")

Tags:

Categories:

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Related Pages:

https://www.w3schools.com/tags/tag_button.asp http://www.kodingmadesimple.com/2015/04/custom-twitter-bootstrap-buttons-icons-images.html

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py https://github.com/epykure/epyk-templates/blob/master/locals/components/alerts.py https://github.com/epykure/epyk-templates/blob/master/locals/components/button_link.py https://github.com/epykure/epyk-templates/blob/master/locals/components/checkbox.py

Parameters:

• text – Optional. The value to be displayed to the button

• width – Optional. The integer for the component width and its unit

• height – Optional. The integer for the component height and its unit

• align – Optional. The horizontal position of the component

• icon – Optional. The value of the icon to display from font-awesome

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. The value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

live(time: int, js_funcs: Union[List[Union[str, JsDataModel]], str], icon: Optional[Union[str, bool]] = 'fas fa-circle', width: Optional[Union[tuple, int, str]] = ('auto', 'px'), height: Optional[Union[tuple, int, str]] = ('auto', 'px'), align: str = 'left', html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[Union[bool, dict]] = None)

Live component which will trigger event every x second. This will then allow other components to be refreshed in the page.

Tags:

Categories:

Usage:

b7 = page.ui.buttons.live(3, page.js.console.log("Click"), options={"started": False})
b8 = page.ui.buttons.live(2, page.js.console.log("refresh data"), profile=True)

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button_icon.py

Parameters:

• time – Interval time in second

• js_funcs – The Javascript functions

• icon – Optional. The font awesome icon reference

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

mail(text: str = '', width: Union[tuple, int] = (None, '%'), height: Union[tuple, int] = (None, 'px'), html_code: Optional[str] = None, align: str = 'left', tooltip=None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None) → Button

Add a mail button with a predefined icon from font-awesome.

Tags:

Categories:

Usage:

page.ui.buttons.mail()

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Related Pages:

https://www.w3schools.com/tags/tag_button.asp http://www.kodingmadesimple.com/2015/04/custom-twitter-bootstrap-buttons-icons-images.html

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py

Parameters:

• text – Optional. The value to be displayed to the button

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

menu(record: Optional[list] = None, text: str = '', icon: Optional[Union[str, bool]] = None, width: Optional[Union[tuple, int, str]] = (None, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[Union[bool, dict]] = None) → ButtonMenu

Button with underlying items menu.

Tags:

Categories:

Usage:

tree5 = page.ui.buttons.menu(["A", "B", "C"], 'Menu')

Underlying HTML Objects:

• epyk.core.html.HtmlButton.ButtonMenu

Related Pages:

https://www.w3schools.com/howto/tryit.asp?filename=tryhow_css_js_dropdown_hover

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py https://github.com/epykure/epyk-templates/blob/master/locals/components/tree.py

Parameters:

• record – Optional. The list of dictionaries with the data

• text – Optional. The value to be displayed to the button

• icon – Optional. The icon to be used in the check component

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

more(items, text: str = 'More', width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[Union[bool, dict]] = None) → ButtonMore

Tags:

Categories:

Usage:

b = page.ui.buttons.more([
  {"text": "Add", "target": "_blank", "icon": "fab fa-500px",
   "url": "https://stackoverflow.com/questions/5884066/hashing-a-dictionary"},
  {"text": "Delete", "target": "_blank", "icon": "fab fa-500px",
   "url": "https://stackoverflow.com/questions/5884066/hashing-a-dictionary"},
])
b.click([page.js.console.log("Click event")])

Templates:

Related Pages:

Parameters:

• items – List of items to be added to the menu

• text – Optional. The text visible in the button

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

normal(text: str = '', icon: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[Union[bool, dict]] = None) → Button

Standard button with a standard layout.

Tags:

Categories:

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Usage:

page.ui.buttons.normal("Standard button")

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py

Parameters:

• text – Optional. The value to be displayed to the button

• icon – Optional. A string with the value of the icon to display from font-awesome

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

phone(text: str = '', width: Union[tuple, int] = (None, '%'), height: Union[tuple, int] = (None, 'px'), html_code: Optional[str] = None, align: str = 'left', tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None) → Button

Add a phone button with a predefined icon from font-awesome.

Tags:

Categories:

Usage:

page.ui.buttons.phone()

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Related Pages:

https://www.w3schools.com/tags/tag_button.asp http://www.kodingmadesimple.com/2015/04/custom-twitter-bootstrap-buttons-icons-images.html

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py

Parameters:

• text – Optional. The value to be displayed to the button

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

pill(text: str, value=None, group: Optional[str] = None, width: Union[tuple, int] = ('auto', ''), height: Union[tuple, int] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None)

Add a pill button.

Tags:

Categories:

Usage:

Templates:

Parameters:

• text – Optional. The text to be displayed to the button

• value – Optional. The value to be displayed in the pill

• group – Optional. The group value fot the pill

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

radio(record: Optional[List[dict]] = None, html_code: Optional[str] = None, group_name: Optional[str] = None, width: Union[tuple, int] = (100, '%'), height: Union[tuple, int] = (None, 'px'), align: str = 'left', options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None) → Radio

Creates a radio HTML component.

Tips: record data should be in the format expected by the component. If needed a data helper can be used. from the data package in the component property, the various functions available for the radio will help.

Tags:

Categories:

Usage:

page.ui.buttons.radio(df, dfColumn="A", htmlCode="test")

Underlying HTML Objects:

• epyk.core.html.HtmlRadio.Radio

Related Pages:

https://www.w3schools.com/bootstrap/bootstrap_forms_inputs.asp

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py

Parameters:

• record – Optional. The Python list of dictionaries

• group_name – Optional. Group name for multi radio buttons

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

refresh(text: str = 'Refresh', icon: Optional[Union[str, bool]] = 'fas fa-sync-alt', width: Union[tuple, int] = (None, '%'), height: Union[tuple, int] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None)

Standard refresh button with a font-awesome icon.

Tags:

Categories:

Usage:

page.ui.buttons.refresh("Refresh")

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Related Pages:

https://www.w3schools.com/tags/tag_button.asp http://www.kodingmadesimple.com/2015/04/custom-twitter-bootstrap-buttons-icons-images.html

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py https://github.com/epykure/epyk-templates/blob/master/locals/components/alerts.py https://github.com/epykure/epyk-templates/blob/master/locals/components/button_link.py https://github.com/epykure/epyk-templates/blob/master/locals/components/checkbox.py

Parameters:

• text – Optional. The value to be displayed to the button

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• icon – Optional. A string with the value of the icon to display from font-awesome

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

remove(text: str = '', width: Union[tuple, int] = (None, '%'), height: Union[tuple, int] = (None, 'px'), html_code: Optional[str] = None, align: str = 'left', tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None) → Button

Button with cross icon.

Tags:

Categories:

Usage:

page.ui.buttons.remove("Remove")

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Related Pages:

https://www.w3schools.com/tags/tag_button.asp http://www.kodingmadesimple.com/2015/04/custom-twitter-bootstrap-buttons-icons-images.html

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py

Parameters:

• text – Optional. The value to be displayed to the button

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

run(text: str = '', width: Union[tuple, int] = (None, '%'), height: Union[tuple, int] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None) → Button

Add a run button with a predefined icon from font awesome.

Tags:

Categories:

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Usage:

page.ui.buttons.run("Run")

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Related Pages:

https://www.w3schools.com/tags/tag_button.asp http://www.kodingmadesimple.com/2015/04/custom-twitter-bootstrap-buttons-icons-images.html

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py

Parameters:

• text – Optional. The value to be displayed to the button

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. The text-align property within this component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

small(text: str = '', icon: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[Union[bool, dict]] = None) → Button

Standard button with a small layout.

Tags:

Categories:

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Usage:

page.ui.buttons.small("Small button")

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py

Parameters:

• text – Optional. The value to be displayed to the button

• icon – Optional. A string with the value of the icon to display from font-awesome

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

store(image, url, width: Optional[Union[tuple, int, str]] = (7.375, 'rem'), height: Optional[Union[tuple, int, str]] = (2.375, 'rem'), html_code: Optional[str] = None, align: str = 'left', options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None)

Button for a badge which point to the various application stores (Google and Apple). The badge must be issued from the Google Play Store.

Tags:

Categories:

Usage:

Underlying HTML Objects:

• epyk.core.html.HtmlImage.Image

Related Pages:

https://play.google.com/intl/en_us/badges/

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py

Parameters:

• image – The url of the image

• url – The link to the app in the store

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• align – Optional. The text-align property within this component

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

text(text: str, icon: Optional[Union[str, bool]] = None, width: Union[tuple, int] = ('auto', ''), tooltip: Optional[str] = None, height: Union[tuple, int] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None)

Add a text button.

Tags:

Categories:

Usage:

Templates:

Parameters:

• text – Optional. The value to be displayed to the button

• icon – Optional. A string with the value of the icon to display from font-awesome

• tooltip – Optional. A string with the value of the tooltip

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

thumbs_down(width: Union[tuple, int] = ('auto', ''), height: Union[tuple, int] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None)

Button with the font awesome icon far fa-thumbs-down.

Tags:

Categories:

Usage:

Templates:

Parameters:

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

thumbs_up(width: Union[tuple, int] = ('auto', ''), height: Union[tuple, int] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None)

Button with the font awesome icon far fa-thumbs-up.

Tags:

Categories:

Usage:

b6 = page.ui.buttons.thumbs_up(tooltip="Like")

Templates:

Parameters:

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component

toggle(record: Optional[dict] = None, label: Optional[str] = None, color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), align: str = 'left', html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → Div

Add a toggle component.

Component Structure:

component.input: :class:`html.HtmlRadio.Switch`
component.label: :class:`html.HtmlText.Label`

Tags:

Categories:

Usage:

page.ui.buttons.toggle({'on': "true", 'off': 'false'})

Underlying HTML Objects:

• epyk.core.html.HtmlRadio.Switch

Related Pages:

http://thecodeplayer.com/walkthrough/pure-css-on-off-toggle-switch https://codepen.io/mburnette/pen/LxNxNg

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py https://github.com/epykure/epyk-templates/blob/master/locals/components/switch.py

Parameters:

• record – Optional. component data

• label – Optional. The toggle static label displayed

• color – Optional. String. Optional. The font color in the component. Default inherit

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• align – Optional. A string with the horizontal position of the component

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• options – Optional. Specific Python options available for this component

• profile – Optional. A flag to set the component performance storage

validate(text: str = '', width: Union[tuple, int] = (None, '%'), height: Union[tuple, int] = (None, 'px'), html_code: Optional[str] = None, align: str = 'left', tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None) → Button

Add a validate button with a predefined icon from font awesome.

Tags:

Categories:

Usage:

page.ui.buttons.validate("Validate")

Underlying HTML Objects:

• epyk.core.html.HtmlButton.Button

Related Pages:

https://www.w3schools.com/tags/tag_button.asp http://www.kodingmadesimple.com/2015/04/custom-twitter-bootstrap-buttons-icons-images.html

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/button.py

Parameters:

• text – Optional. The value to be displayed to the button

• width – Optional. A tuple with the integer for the component width and its unit

• height – Optional. A tuple with the integer for the component height and its unit

• html_code – Optional. An identifier for this component (on both Python and Javascript side)

• align – Optional. The text-align property within this component

• tooltip – Optional. A string with the value of the tooltip

• profile – Optional. A flag to set the component performance storage

• options – Optional. Specific Python options available for this component