Lists Interface

class epyk.interfaces.components.CompLists.Lists(ui)

alpha(data=None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None, helper: Optional[str] = None)

Usage:

page.ui.lists

Underlying HTML Objects:

epyk.core.html.HtmlList.List

Parameters:

data –
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)
helper – Optional. A tooltip helper
options – Optional. Specific Python options available for this component
profile – Optional. A flag to set the component performance storage

badges(data=None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)

Usage:

page.ui.lists.badges([{'label': 'Python', 'value': 12}, {'label': 'R', 'value': 3}])

i = page.ui.lists.badges([
  {"text": 'text', 'icon': 'fas fa-times', 'checked': True, 'value': 8},
  {"text": 'text', 'icon': 'fas fa-times', 'checked': True, 'value': 5},
], options={"badge": {"background": 'green'}})
i.click([page.js.console.log(i.dom.content)])

Underlying HTML Objects:

epyk.core.html.HtmlList.Badges

Related Pages:

https://www.w3schools.com/bootstrap/bootstrap_list_groups.asp https://v4-alpha.getbootstrap.com/components/list-group/

Templates:

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

Parameters:

data –
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)
helper – Optional. A tooltip helper
options – Optional. Specific Python options available for this component
profile – Optional. A flag to set the component performance storage

box(records: Optional[list] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, '%'), options: Optional[dict] = None, html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, helper: Optional[str] = None)

Special list configuration for a list of box with a title with a text and a list of icons

Usage:

page.ui.lists

Templates:

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

Parameters:

records –
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
html_code – Optional. An identifier for this component (on both Python and Javascript side)
profile – Optional. A flag to set the component performance storage
helper – Optional. A tooltip helper

brackets(records=None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (550, 'px'), options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)

Usage:

minimalData = {
  "teams": [
    ["Team 1", "Team 2"],
    ["Team 3", "Team 4"]
],
  "results": [
    [[1, 2], [3, 4]],
    [[4, 6], [2, 1]]]
}

bt = page.ui.lists.brackets(minimalData)

Parameters:

records –
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

checks(data=None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)

Add a list component with checkbox items.

Usage:

data = [{"label": "python", "value": False}, {"label": "Java", "value": 5}]
checks = page.ui.lists.checklist(data)

ts = page.ui.lists.items(["menu %s" % i for i in range(10)])
its.options.checked_key = "selected"
#its.options.max_selected = 2
its.options.items_type = "check"
its.options.checked_key = "selected"
its.options.text_click = True

Underlying HTML Objects:

epyk.core.html.HtmlList.Checks

Templates:

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

Parameters:

data –
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)
helper – Optional. A tooltip helper
options – Optional. Specific Python options available for this component
profile – Optional. A flag to set the component performance storage

chips(items=None, category: str = 'group', placeholder: str = '', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (60, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)

Add a chip (filter) html component

Usage:

chips = page.ui.chips([])
chips2 = page.ui.chips(["example", {"value": 'test', 'name': 'group 2'}], options={"visible": True})

Underlying HTML Objects:

epyk.core.html.HtmlEvent.Filters

Related Pages:

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

Templates:

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

Parameters:

items – Selected items
category – Optional. The group of the items.
placeholder – Optional. The input field placeholder
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)
helper – Optional. A tooltip helper
options – Optional. Specific Python options available for this component
profile – Optional. A flag to set the component performance storage

disc(data=None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)

Usage:

page.ui.lists

Underlying HTML Objects:

epyk.core.html.HtmlList.List

Related Pages:

https://www.w3schools.com/cssref/pr_list-style-type.asp

Templates:

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

Parameters:

data –
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)
helper – Optional. A tooltip helper
options – Optional. Specific Python options available for this component
profile – Optional. A flag to set the component performance storage

drop(data=None, color=None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)

Usage:

cols_keys = page.ui.lists.drop(html_code="cols_agg_keys")
cols_keys.style.css.min_height = 20
cols_keys.items_style(style_type="bullets")
cols_keys.drop()

Parameters:

data –
color –
width –
height –
html_code –
helper –
options –
profile –

dropdown(records=None, text: str = '', width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)

Create a dropdown item.

Underlying HTML Objects:

epyk.core.html.HtmlTrees.DropDown

Related Pages:

http://getbootstrap.com/docs/4.0/components/dropdowns/ https://www.w3schools.com/bootstrap/tryit.asp?filename=trybs_ref_js_dropdown_multilevel_css&stacked=h https://codepen.io/svnt/pen/beEgre

Templates:

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

Parameters:

records – Optional. The list of dictionaries with the input data.
text – Optional. The value to be displayed to 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 – Optional. An identifier for this component (on both Python and Javascript side)
helper – Optional. A tooltip helper
options – Optional. Specific Python options available for this component
profile – Optional. A flag to set the component performance storage

groups(data=None, categories=None, color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)

Usage:

l = page.ui.lists.groups(["AWW", "B"])
l.add_list(["D", "E"], category="Test")

Underlying HTML Objects:

epyk.core.html.HtmlList.Groups

Related Pages:

http://designbump.com/create-a-vertical-accordion-menu-using-css3-tutorial/ http://thecodeplayer.com/walkthrough/vertical-accordion-menu-using-jquery-css3

Parameters:

data –
categories –
color –
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)
helper – Optional. A tooltip helper
options – Optional. Specific Python options available for this component
profile – Optional. A flag to set the component performance storage

icons(data=None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)

Usage:

page.ui.lists.badges([{'label': 'Python', 'value': 12}, {'label': 'R', 'value': 3}])

Underlying HTML Objects:

epyk.core.html.HtmlList.Badges

Related Pages:

https://www.w3schools.com/bootstrap/bootstrap_list_groups.asp https://v4-alpha.getbootstrap.com/components/list-group/

Parameters:

data –
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)
helper – Optional. A tooltip helper
options – Optional. Specific Python options available for this component
profile – Optional. A flag to set the component performance storage

item(text: Optional[str] = None, tag: Optional[str] = None, options: Optional[dict] = None) → Li

Add a dynamic and configurable list component.

Usage:

l = page.ui.lists.list(["A", "B"])

Underlying HTML Objects:

epyk.core.html.HtmlList.List

Related Pages:

https://www.w3schools.com/bootstrap/bootstrap_list_groups.asp http://astronautweb.co/snippet/font-awesome/

Parameters:

text –
tag –
options –

items(records: Optional[list] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = ('auto', ''), options: Optional[dict] = None, html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, helper: Optional[str] = None) → Items

Add a JavaScript based list component.

Usage:

c = page.ui.lists.items([
  {"text": 'value 1', 'icon': 'fas fa-times', 'checked': True, 'value': 8000},
  {"text": 'value 1', 'icon': 'fas fa-times', 'checked': True, 'value': 50000},
], options={"style": {"background": 'green', 'color': 'white'}})

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/list.py https://github.com/epykure/epyk-templates/blob/master/locals/components/list_custom.py https://github.com/epykure/epyk-templates/blob/master/locals/components/list_filter.py

Parameters:

records – Optional. The list of dictionaries with the input data.
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
html_code – Optional. An identifier for this component (on both Python and Javascript side)
profile – Optional. A flag to set the component performance storage
helper – Optional. A tooltip helper

list(data=None, color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)

Add a static list component.

Usage:

l = page.ui.lists.list(["A", "B"])

Underlying HTML Objects:

epyk.core.html.HtmlList.List

Related Pages:

https://www.w3schools.com/bootstrap/bootstrap_list_groups.asp http://astronautweb.co/snippet/font-awesome/

Templates:

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

Parameters:

data – List. Optional. The list items.
color – String. Optional. The font color in the component. Default inherit.
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.
html_code – String. Optional. An identifier for this component (on both Python and Javascript side).
helper – String. Optional. A tooltip helper.
options – Dictionary. Optional. Specific Python options available for this component.
profile – Boolean | Dictionary. Optional. A flag to set the component performance storage.

lookup(lookup=None, html_code: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, '%'), profile: Optional[Union[bool, dict]] = None, multiple: bool = False, options: Optional[dict] = None) → Lookup

HTML Select component.

Usage:

select1 = page.ui.select([
  {"value": "value 1", "text": "value 1"},
  {"value": "value 2", "text": "value 2"},
])
lookupData = {"value 1": [
  {"value": "A", 'text': "Example 1"},
  {"value": "B", 'text': "Example 2"}
]}
select2 = page.ui.lookup(lookupData)
select1.change([
  select2.build(select1.dom.content)
])

Underlying HTML Objects:

epyk.core.html.HtmlSelect.Lookup

Related Pages:

https://silviomoreto.github.io/bootstrap-select/examples/ https://www.npmjs.com/package/bootstrap-select-v4 https://www.jqueryscript.net/form/Bootstrap-4-Dropdown-Select-Plugin-jQuery.html

Parameters:

lookup – Dictionary. Optional. The mapping to the list of recs to be loaded.
html_code – Optional. The component identifier code (for bot
width – Tuple. Optional. Integer for the component width
height – Tuple. Optional. Integer for the component height
profile – Optional. A flag to set the component performance storage
multiple – Boolean. To set if the component can handle multiple selections
options – The select options as defined https://developer.snapappointments.com/bootstrap-select/options/

numbers(data=None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None, helper: Optional[str] = None)

Usage:

page.ui.lists.numbers(["A", "B"])

Underlying HTML Objects:

epyk.core.html.HtmlList.List

Related Pages:

https://www.w3schools.com/html/html_lists.asp https://www.w3.org/wiki/CSS/Properties/list-style-type

Parameters:

data –
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
html_code – Optional. An identifier for this component (on both Python and Javascript side)
profile – Optional. A flag to set the component performance storage
helper – Optional. A tooltip helper

pills(records=None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, '%'), options: Optional[dict] = None, html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, helper: Optional[str] = None)

Usage:

page.ui.lists

Parameters:

records –
width –
height –
options –
html_code –
profile –
helper –

points(data=None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), align: Optional[str] = None, html_code: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None, helper: Optional[str] = None)

Usage:

page.ui.lists

Underlying HTML Objects:

epyk.core.html.HtmlList.List

Related Pages:

https://www.w3schools.com/html/html_lists.asp

Parameters:

data –
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 –
html_code – Optional. An identifier for this component (on both Python and Javascript side)
helper – Optional. A tooltip helper
options – Optional. Specific Python options available for this component
profile – Optional. A flag to set the component performance storage

radios(data=None, group_name: str = 'group', width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)

Usage:

page.ui.lists

Underlying HTML Objects:

epyk.core.html.HtmlContainer.Div

epyk.core.html.HtmlInput.Radio

Parameters:

data –
group_name –
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
html_code – String. Optional. An identifier for this component (on both Python and Javascript side)
helper – String. Optional. A tooltip helper
options – Dictionary. Optional. Specific Python options available for this component
profile – Boolean or Dictionary. Optional. A flag to set the component performance storage

roman(data=None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, helper: Optional[str] = None)

Underlying HTML Objects:

epyk.core.html.HtmlList.List

Usage:

page.ui.lists

Parameters:

data –
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)
helper – Optional. A tooltip helper
options – Optional. Specific Python options available for this component
profile – Optional. A flag to set the component performance storage

select(records=None, html_code: Optional[str] = None, selected: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, '%'), profile: Optional[Union[bool, dict]] = None, multiple: bool = False, options: Optional[dict] = None) → Select

HTML Select component.

Usage:

records = [
  {"text": 'Text 1', "value": "text 1"},
  {"text": 'Text 2', "value": "text 2"},
  {"text": 'Text 3', "value": "text 3"},
]

select = page.ui.select(records)

Underlying HTML Objects:

epyk.core.html.HtmlSelect.Select

Related Pages:

https://silviomoreto.github.io/bootstrap-select/examples/ https://www.npmjs.com/package/bootstrap-select-v4 https://www.jqueryscript.net/form/Bootstrap-4-Dropdown-Select-Plugin-jQuery.html

Parameters:

records – Optional. The list of dictionaries with the input data.
html_code – Optional. An identifier for this component (on both Python and Javascript side).
selected – Optional. The selected value or values.
width – Optional. Integer for the component width.
height – Optional. Integer for the component height.
profile – Optional. A flag to set the component performance storage.
multiple – Optional. To set if the component can handle multiple selections.
options – The select options as defined https://developer.snapappointments.com/bootstrap-select/options/

squares(data=None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)

Usage:

page.ui.lists.squares(["A", "B"])

Underlying HTML Objects:

epyk.core.html.HtmlList.List

Related Pages:

https://www.w3schools.com/cssref/pr_list-style-type.asp

Parameters:

data –
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)
helper – Optional. A tooltip helper
options – Optional. Specific Python options available for this component
profile – Optional. A flag to set the component performance storage

tree(data=None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None) → Tree

Usage:

data = [{"label": 'test', 'items': [{"label": 'child 1', 'color': 'red'}]}]
page.ui.lists.tree(data)

Underlying HTML Objects:

epyk.core.html.HtmlTrees.Tree

Parameters:

data –
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)
helper – Optional. A tooltip helper
options – Optional. Specific Python options available for this component
profile – Optional. A flag to set the component performance storage