Icons Interface

class epyk.interfaces.components.CompIcons.Icons(ui)
avatar(img: str = '', name: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (30, 'px'), height: Optional[Union[tuple, int, str]] = (None, ''), options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None)

Display an avatar component.

Usage:

:param img: The image full path
:param name: Optional.The tooltip name
: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 options: Optional. Specific Python options available for this component
:param profile: Optional. A flag to set the component performance storage
awesome(icon: str, text: Optional[str] = None, tooltip: Optional[str] = None, position: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (25, 'px'), height: Optional[Union[tuple, int, str]] = (25, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None, align: str = 'left', size: Optional[Union[tuple, int, str]] = (None, 'px')) → IconEdit

Generic function to create icon components. Default icon library used is font awesome but this might change depending on the web framework used.

Usage:

page.ui.icons.awesome(icon="fas fa-align-center")

Underlying HTML Objects:

Templates:

Parameters:

  • icon – Optional. The font awesome icon reference

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

badge(text: str = '', icon: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (25, 'px'), height: Optional[Union[tuple, int, str]] = (25, 'px'), background_color: Optional[str] = None, color: Optional[str] = None, url: Optional[str] = None, tooltip: Optional[str] = None, options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → Badge

Display a badge component using Bootstrap

Usage:

page.ui.images.badge("Test badge", "Label", icon="fas fa-align-center")
page.ui.images.badge("This is a badge", background_color="red", color="white")
page.ui.images.badge(12, icon="far fa-bell", options={"badge_position": 'right'})

b = rptObj.ui.images.badge(
  7688, icon="fab fa-python", options={'badge_css': {'color': 'white', "background": 'red'}})
b.options.badge_css = {"background": 'green'}

Underlying HTML Objects:

Related Pages:

Parameters:

  • text – Optional. The content of the badge

  • icon – Optional. A String with the icon to display from font-awesome

  • background_color – Optional. The background color of the badge

  • color – Optional. The text color of the badge

  • 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

  • url – Optional

  • tooltip – Optional. The text to display in the tooltip

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

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

bar(records=None, color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (70, 'px'), height: Optional[Union[tuple, int, str]] = (None, 'px'), options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None)

Add a bespoke options / actions bar with icons

Usage:

Related Pages:

Templates:

Parameters:

  • records –

  • 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

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

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

capture(text=None, position=None, tooltip='Save to clipboard', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.capture()

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

clear(text=None, position=None, tooltip='', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Same as epyk.interfaces.components.CompIcons.Icons.awesome() with a fas fa-times-circle icon

Usage:

page.ui.icons.clear()

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • align –

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

clock(text: Optional[str] = None, position: Optional[str] = None, tooltip: str = 'Last Updated Time', width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options=None, profile: Optional[Union[bool, dict]] = None, align: str = 'left', size: Optional[Union[tuple, int, str]] = (None, 'px')) → IconEdit

Usage:

page.ui.icons.clock()
page.ui.icons.clock().color("red")

Underlying HTML Objects:

templates:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

danger(text=None, position=None, tooltip='', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

:param text: Optional. The text to be displayed to this component. Default None
:param position: Optional. The position of the icon in the line (left, right, center)
:param tooltip: Optional. A string with the value of the tooltip
: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 options: Optional. Specific Python options available for this component
:param profile: Optional. A flag to set the component performance storage
:param align: Optional. A string with the horizontal position of the component
:param size: Optional. A tuple with the integer for the component size and its unit
date(value: Optional[str] = None, label: Optional[str] = None, icon: str = 'calendar', color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[Union[bool, dict]] = None, helper: Optional[str] = None) → DatePicker

This component is based on the Jquery Date Picker object.

Usage:

page.ui.fields.date('2020-04-08', label="Date").included_dates(["2020-04-08", "2019-09-06"])

Underlying HTML Objects:

Related Pages:

Parameters:

  • value – Optional. The value to be displayed to the time component. Default now

  • label – Optional. The text of label to be added to the component

  • icon – Optional. The component icon content from font-awesome references

  • 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

  • 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

  • helper – Optional. A tooltip helper

delete(text=None, position=None, tooltip='Delete Component on the page', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.delete()

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

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

  • align – Optional. The text-align property within this 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)

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

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

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

download(text=None, position=None, tooltip='Download', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.download()

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

edit(text: Optional[str] = None, position: Optional[str] = None, tooltip: str = 'Edit', width: Optional[Union[tuple, int, str]] = (None, 'px'), 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, align: str = 'left', size: Optional[Union[tuple, int, str]] = (None, 'px')) → IconEdit

Usage:

page.ui.icons.edit()
page.ui.icons.edit().color("red")

Underlying HTML Objects:

Templates:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

epyk(align: str = 'center', size: Optional[Union[tuple, int, str]] = (32, 'px'))

Add the Epyk Icon.

Usage:

page.ui.icons.epyk()

Underlying HTML Objects:

Templates:

Parameters:

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

  • size – Optional.

error(text=None, position=None, tooltip='', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

:param text: Optional. The text to be displayed to this component. Default None
:param position: Optional. The position of the icon in the line (left, right, center)
:param tooltip: Optional. A string with the value of the tooltip
: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 options: Optional. Specific Python options available for this component
:param profile: Optional. A flag to set the component performance storage
:param align: Optional. A string with the horizontal position of the component
:param size: Optional. A tuple with the integer for the component size and its unit
excel(text=None, position=None, tooltip='Convert to Excel', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.excel()

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center…)

  • 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

  • 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

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

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

facebook(text=None, url='https://en-gb.facebook.com/', position=None, tooltip='Facebook', width=(25, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.facebook()

Underlying HTML Objects:

Parameters:

  • text –

  • url –

  • position –

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

  • width – Optional. A tuple with the integer for the component width 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

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

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

fixed(icon: Optional[str] = None, family: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, height: Optional[Union[tuple, int, str]] = (None, 'px'), color: Optional[str] = None, tooltip: Optional[str] = None, align: str = 'left', options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → IconEdit
Parameters:

  • icon – Optional. The icon value

  • family – Optional. The icon family

  • 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)

  • color – Optional.

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

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

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

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

fluent(icon: str, text: Optional[str] = None, tooltip: Optional[str] = None, position: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (25, 'px'), height: Optional[Union[tuple, int, str]] = (25, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → IconEdit

Usage:

page.ui.icons.awesome(icon="fas fa-align-center")

Underlying HTML Objects:

ms-Icon ms-Icon–AdminDLogoInverse32

Parameters:

  • icon – Optional. The FluentUI icon reference

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

gallery(icons=None, columns=6, width=(None, '%'), height=('auto', ''), options=None, profile=None)

Mosaic of pictures.

Tags:

Categories:

Usage:

Related Pages:

Underlying HTML Objects:

Templates:

Parameters:

  • icons – List. Optional. The list with the pictures

  • columns – Integer. Optional. The number of column for the mosaic component

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

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

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

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

github(text=None, url='https://github.com/epykure/epyk-ui', position=None, tooltip='Go the the Github project', width=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Link to a GitHub repository.

By default this icon button will redirect to the Epyk UI repository.

Usage:

page.ui.icons.github()

Underlying HTML Objects:

Parameters:

  • text – optional. The text on the icon

  • url – Optional. The url link

  • position –

  • tooltip –

  • width – Optional. A tuple with the integer for the component width 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

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

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

hamburger(width=(15, 'px'), height=(2, 'px'), color=None, options=None, profile=None)

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

Parameters:

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

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

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

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

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

info(text=None, position=None, tooltip='', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

:param text: Optional. The text to be displayed to this component. Default None
:param position: Optional. The position of the icon in the line (left, right, center)
:param tooltip: Optional. A string with the value of the tooltip
: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 options: Optional. Specific Python options available for this component
:param profile: Optional. A flag to set the component performance storage
:param align: Optional. A string with the horizontal position of the component
:param size: Optional. A tuple with the integer for the component size and its unit
instagram(text=None, url='https://www.instagram.com/?hl=en', position=None, tooltip='Twitter', width=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.twitter()

Underlying HTML Objects:

Parameters:

  • text –

  • url –

  • position –

  • tooltip –

  • width – Optional. A tuple with the integer for the component width 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

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

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

large(icon=None, family=None, width=(None, 'px'), height=(None, 'px'), html_code=None, color=None, tooltip=None, align='left', options=None, profile=None)

Usage:

:param icon:
:param family:
:param width: Tuple. Optional. A tuple with the integer for the component width and its unit
:param height: Tuple. Optional. A tuple with the integer for the component height and its unit
:param html_code: String. Optional. An identifier for this component (on both Python and Javascript side)
:param color:
:param tooltip:
:param align: String. Optional. The text-align property within this component
:param options: Dictionary. Optional. Specific Python options available for this component
:param profile: Boolean | Dictionary. Optional. A flag to set the component performance storage
linkedIn(text=None, url='https://www.linkedin.com/in/epykure-python-58278a1b8/', position=None, tooltip='', width=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Create a LinkedIn icon button which will by default point to the Epykure account. Epykure account is the official account for the development of this framework.

Usage:

page.ui.icons.linkedIn()

Underlying HTML Objects:

Parameters:

  • text – Optional. The text for the Icon

  • url – Optional. The url when clicked

  • position –

  • tooltip – Optional. The tooltip when the mouse is hover

  • width – Optional. A tuple with the integer for the component width 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 – Boolean | Dictionary. Optional. A flag to set the component performance storage

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

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

mail(text=None, url='', position=None, tooltip='Share by mail', width=(25, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Same as epyk.interfaces.components.CompIcons.Icons.awesome() with a fab fa-stack-overflow icon

Usage:

page.ui.icons.mail()

Underlying HTML Objects:

Parameters:

  • text –

  • url –

  • position –

  • tooltip –

  • width – Optional. A tuple with the integer for the component width 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

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

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

menu(data, width=(100, '%'), height=(None, 'px'), options=None, profile=False, align: str = 'left', size=(None, 'px'))

Add a menu bar with multiple icons.

Usage:

menu = page.ui.icons.menu([
  {"icon": "fab fa-github-square", "tooltip": "Github path", 'url': 'test'},
  {"icon": "far fa-eye"},
  {"icon": "fas fa-file-code"}
])
Parameters:

  • data – List. The icons definition.

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

  • size – Tuple. Optional. A tuple with the integer for the icon size and its unit

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

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

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

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

messenger(text=None, url='https://en-gb.facebook.com/', position=None, tooltip='Facebook', width=(25, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.facebook()

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • url –

  • position –

  • tooltip –

  • width – Optional. A tuple with the integer for the component width 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

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

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

next(text=None, position=None, tooltip='', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

:param text: Optional. The text to be displayed to this component. Default None
:param position: Optional. The position of the icon in the line (left, right, center)
:param tooltip: Optional. A string with the value of the tooltip
: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 options: Optional. Specific Python options available for this component
:param profile: Optional. A flag to set the component performance storage
:param align: Optional. A string with the horizontal position of the component
:param size: Optional. A tuple with the integer for the component size and its unit
pdf(text=None, position=None, tooltip='Convert to PDF', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.pdf(tooltip="helper")

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

play(text=None, position=None, tooltip='', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Shortcut to the play icon.

Usage:

page.ui.icons.play()
Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

plus(text=None, position=None, tooltip='Add line', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.plus()

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

previous(text=None, position=None, tooltip='', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

:param text: Optional. The text to be displayed to this component. Default None
:param position: Optional. The position of the icon in the line (left, right, center)
:param tooltip: Optional. A string with the value of the tooltip
: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 options: Optional. Specific Python options available for this component
:param profile: Optional. A flag to set the component performance storage
:param align: Optional. A string with the horizontal position of the component
:param size: Optional. A tuple with the integer for the component size and its unit
python(text=None, url='https://pypi.org/', position=None, tooltip='', width=(25, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.python()

Underlying HTML Objects:

Parameters:

  • text –

  • url –

  • position –

  • tooltip –

  • width – Optional. A tuple with the integer for the component width 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

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

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

refresh(text=None, position=None, tooltip='Refresh Component', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.refresh()
page.ui.icons.refresh().color("red")

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

remove(text=None, position=None, tooltip='Remove Item', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.remove()

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

rss(text='RSS', position=None, tooltip='', width=('auto', ''), height=(25, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.rss()

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

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

  • align – Optional. A string with the horizontal position of the 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 – String. 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

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

save(text=None, position=None, tooltip='', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

:param text: Optional. The text to be displayed to this component. Default None
:param position: Optional. The position of the icon in the line (left, right, center)
:param tooltip: Optional. A string with the value of the tooltip
: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 options: Optional. Specific Python options available for this component
:param profile: Optional. A flag to set the component performance storage
:param align: Optional. A string with the horizontal position of the component
:param size: Optional. A tuple with the integer for the component size and its unit
signin(text: str, width: Optional[Union[tuple, int, str]] = (40, 'px'), icon: Optional[str] = None, colored: bool = True)

Usage:

page.ui.icons.signin("test")

Underlying HTML Objects:

  • :class:`epyk.core.html.HtmlEvent.SignIn

Templates:

Parameters:

  • text –

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

  • icon – Optional. The component icon content from font-awesome references

  • colored – Optional.

stackoverflow(text=None, url='https://stackoverflow.com/', position=None, tooltip='Share your comments', width=(25, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.stackoverflow()

Underlying HTML Objects:

Parameters:

  • text –

  • url –

  • position –

  • tooltip –

  • width – Optional. A tuple with the integer for the component width 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

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

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

stop(text=None, position=None, tooltip='', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Shortcut to the stop icon.

Usage:

page.ui.icons.stop()
Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

success(text=None, position=None, tooltip='', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

:param text: Optional. The text to be displayed to this component. Default None
:param position: Optional. The position of the icon in the line (left, right, center)
:param tooltip: Optional. A string with the value of the tooltip
: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 options: Optional. Specific Python options available for this component
:param profile: Optional. A flag to set the component performance storage
:param align: Optional. A string with the horizontal position of the component
:param size: Optional. A tuple with the integer for the component size and its unit
table(text=None, position=None, tooltip='Convert to Table', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.table(tooltip="helper")

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

tick(flag=True, text=None, icons=('fa fa-check', 'fa fa-times'), position=None, tooltip='', width=(None, 'px'), html_code=None, options=None, profile=None) → Tick

Display a tick box component

Usage:

page.ui.icons.tick()

Underlying HTML Objects:

Parameters:

  • flag – Optional. The state for the tick component

  • text – optional. The text for this component. Default none

  • icons – Optional. The two icons to use for the component state

  • position – Optional. A string with the vertical position of the component

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

  • width – Optional. A tuple with the integer for the component width 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

timer(time, js_funcs, icon='clock', width=(15, 'px'), height=(15, 'px'), options=None, profile=None, align: str = 'left', size=(None, 'px'))

Usage:

:param time: Integer. Interval time in second
:param js_funcs: String | List. The Javascript functions
:param icon: String. The font awesome icon reference
:param width: Tuple. Optional. A tuple with the integer for the component width and its unit
:param size: Tuple. Optional. A tuple with the integer for the icon size and its unit
:param height: Tuple. Optional. A tuple with the integer for the component height and its unit
:param options: Dictionary. Optional. Specific Python options available for this component
:param profile: Boolean | Dictionary. Optional. A flag to set the component performance storage
:param align: A string with the horizontal position of the component
property toggles

More custom toggles icons.

twitch(text=None, url='https://www.twitch.tv/epykure1', position=None, tooltip='', width=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.twitter()

Underlying HTML Objects:

Parameters:

  • text –

  • url –

  • position –

  • tooltip –

  • width – Optional. A tuple with the integer for the component width 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

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

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

twitter(text=None, url='https://twitter.com/Epykure1', position=None, tooltip='', width=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.twitter()

Underlying HTML Objects:

Parameters:

  • text –

  • url –

  • position –

  • tooltip –

  • width – Optional. A tuple with the integer for the component width 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

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

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

warning(text=None, position=None, tooltip='', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

:param text: Optional. The text to be displayed to this component. Default None
:param position: Optional. The position of the icon in the line (left, right, center)
:param tooltip: Optional. A string with the value of the tooltip
: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 options: Optional. Specific Python options available for this component
:param profile: Optional. A flag to set the component performance storage
:param align: Optional. A string with the horizontal position of the component
:param size: Optional. A tuple with the integer for the component size and its unit
wrench(text=None, position=None, tooltip='Processing Time', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.wrench()

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

youtube(text=None, url='https://www.youtube.com/', position=None, tooltip='Follow us on Youtube', width=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.youtube()

Underlying HTML Objects:

Parameters:

  • text –

  • url –

  • position –

  • tooltip –

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

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

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

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

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

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

zoom(text=None, position=None, tooltip='Zoom on Component', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

page.ui.icons.zoom()

Underlying HTML Objects:

Parameters:

  • text – Optional. The text to be displayed to this component. Default None

  • position – Optional. The position of the icon in the line (left, right, center)

  • 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

  • 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

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

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

zoom_in(text=None, position=None, tooltip='', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

:param text: Optional. The text to be displayed to this component. Default None
:param position: Optional. The position of the icon in the line (left, right, center)
:param tooltip: Optional. A string with the value of the tooltip
: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 options: Optional. Specific Python options available for this component
:param profile: Optional. A flag to set the component performance storage
:param align: Optional. A string with the horizontal position of the component
:param size: Optional. A tuple with the integer for the component size and its unit
zoom_out(text=None, position=None, tooltip='', width=(None, 'px'), height=(None, 'px'), html_code=None, options=None, profile=None, align: str = 'left', size=(None, 'px')) → IconEdit

Usage:

:param text: Optional. The text to be displayed to this component. Default None
:param position: Optional. The position of the icon in the line (left, right, center)
:param tooltip: Optional. A string with the value of the tooltip
: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 options: Optional. Specific Python options available for this component
:param profile: Optional. A flag to set the component performance storage
:param align: Optional. A string with the horizontal position of the component
:param size: Optional. A tuple with the integer for the component size and its unit