Inputs Interface

class epyk.interfaces.components.CompInputs.Inputs(ui)

autocomplete(text: str = '', placeholder: str = '', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → AutoComplete

Enables users to quickly find and select from a pre-populated list of values as they type, leveraging searching and filtering.

Usage:

page.ui.inputs.autocomplete("Test")

Underlying HTML Objects:

• epyk.core.html.HtmlInput.AutoComplete

Related Pages:

https://jqueryui.com/autocomplete/

Parameters:

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

• placeholder – Optional. Text visible when the input component is empty

• 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

• attrs – Optional. Specific HTML tags to be added to the component

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

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

cell(text: str = '', language: str = 'python', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (60, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → Cell

Usage:

page.ui.inputs.cell()

Underlying HTML Objects:

• epyk.core.html.HtmlTextEditor.Cell

Parameters:

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

• language –

• 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

checkbox(flag: bool, label: str = '', group_name: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, tooltip: str = '', profile: Optional[Union[bool, dict]] = None) → InputCheckbox

Usage:

page.ui.inputs.checkbox(False)

Underlying HTML Objects:

• epyk.core.html.HtmlInput.Checkbox

Templates:

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

Parameters:

• flag –

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

• group_name – Optional.

• 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

• attrs – Optional.

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

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

d_date(text: str, placeholder: str = '', width: Optional[Union[tuple, int, str]] = (140, 'px'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → InputDate

Usage:

date = page.ui.inputs.d_date()

Underlying HTML Objects:

• epyk.core.html.HtmlInput.InputDate

Parameters:

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

• placeholder – Optional. Text visible when the input component is empty

• 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

• attrs – Optional. Specific HTML tags to be added to the component

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

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

d_int(value: str = '', placeholder: str = '', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → InputInteger

Usage:

date = page.ui.inputs.d_int()

Underlying HTML Objects:

• epyk.core.html.HtmlInput.InputInteger

Parameters:

• value – Optional. The value of this input number field

• placeholder – Optional. Text visible when the input component is empty

• 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

• attrs – Optional. Specific HTML tags to be added to the component

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

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

d_radio(flag: bool = False, group_name: Optional[str] = None, placeholder: str = '', tooltip: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None) → InputRadio

Add a radio component.

Usage:

page.ui.inputs.d_radio()

Underlying HTML Objects:

• epyk.core.html.HtmlInput.InputRadio

Parameters:

• flag – Optional. The component init value

• group_name – Optional. The radio group name

• placeholder – Optional. Text visible when the input component is empty

• 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

• attrs – Optional. Specific HTML tags to be added to the component

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

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

d_range(value, min_val: float = 0, max_val: float = 100, step: float = 1, placeholder: str = '', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), tooltip: Optional[str] = None, html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None) → InputRange

Usage:

:param value: Optional. The value of the component
:param min_val: Optional. The minimum value
:param max_val: Optional. The maximum value
:param step: Optional. The step when the handle is moved
:param placeholder: Optional. Text visible when the input component is empty
: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 attrs: Optional. Specific HTML tags to be added to the component
:param tooltip: Optional. A string with the value of the tooltip
:param profile: Optional. A flag to set the component performance storage

d_search(text: str = '', placeholder: str = '', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → Input

One of the new types of inputs in HTML5 is search.

Usage:

page.ui.inputs.d_search("")

Underlying HTML Objects:

• epyk.core.html.HtmlInput.Input

Related Pages:

https://developer.mozilla.org/fr/docs/Web/HTML/Element/Input/search https://css-tricks.com/webkit-html5-search-inputs/

Parameters:

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

• placeholder – Optional. Text visible when the input component is empty

• 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

• attrs – Optional. Specific HTML tags to be added to the component

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

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

d_text(text: str = '', placeholder: str = '', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), tooltip: Optional[str] = None, html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None) → Input

Usage:

page.ui.inputs.d_text()

Underlying HTML Objects:

• epyk.core.html.HtmlInput.Input

Parameters:

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

• placeholder – Optional. Text visible when the input component is empty

• 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

• attrs – Optional. Specific HTML tags to be added to the component

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

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

d_time(text: str = '', placeholder: str = '', width: Optional[Union[tuple, int, str]] = (139, 'px'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → InputTime

A lightweight, customizable javascript timepicker plugin for jQuery inspired by Google Calendar.

Usage:

date = page.ui.inputs.d_time()

Underlying HTML Objects:

• epyk.core.html.HtmlInput.InputTime

Parameters:

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

• placeholder – Optional. Text visible when the input component is empty

• 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

• attrs – Optional. Specific HTML tags to be added to the component

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

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

editor(text: str = '', language: str = 'python', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (300, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → Editor

Usage:

page.ui.inputs.editor()

Underlying HTML Objects:

• epyk.core.html.HtmlTextEditor.Editor

Parameters:

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

• language –

• 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

file(text: str = '', placeholder: str = '', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → InputFile

Input field that will hide characters typed in

Usage:

page.ui.inputs.file()

Underlying HTML Objects:

• epyk.core.html.HtmlInput.InputFile

Parameters:

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

• placeholder – Optional. Text visible when the input component is empty

• 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

• attrs – Optional. Specific HTML tags to be added to the component

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

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

filters(items: Optional[List[Html]] = None, button: Optional[Html] = None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (60, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, autocomplete: bool = False, profile: Optional[Union[bool, dict]] = None) → Div

Parameters:

• items –

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

• helper –

• autocomplete –

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

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

hidden(text: str = '', placeholder: str = '', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → Input

Add a hidden input component to the page. This could be used to store data to then be passed to underlying services,

Usage:

rptObj.ui.inputs.hidden("Test")

Underlying HTML Objects:

• epyk.core.html.HtmlInput.Input

Parameters:

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

• placeholder – Optional. Text visible when the input component is empty

• 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

• attrs – Optional. Specific HTML tags to be added to the component

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

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

input(text: str = '', placeholder: str = '', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → Input

Add a standard input component.

Usage:

page.ui.inputs.input("Test")

Underlying HTML Objects:

• epyk.core.html.HtmlInput.Input

Templates:

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

Parameters:

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

• placeholder – Optional. Text visible when the input component is empty

• width – 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 – Optional. An identifier for this component (on both Python and Javascript side)

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

• attrs – Optional. Specific HTML tags to be added to the component

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

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

label(label: str, text: str = '', placeholder: str = '', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, tooltip: Optional[str] = None, options: Optional[dict] = None, attrs: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None) → Div

Add an input label component.

Usage:

page.ui.inputs.label()
page.ui.inputs.label("test")

Underlying HTML Objects:

• epyk.core.html.HtmlInput.Input

• epyk.core.html.HtmlText.Label

• epyk.core.html.HtmlContainer.Div

Templates:

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

Parameters:

• label –

• text –

• placeholder –

• width –

• height –

• html_code –

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

• options –

• profile –

• attrs –

left(text: str = '', placeholder: str = '', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → Input

Add a standard input component.

Usage:

page.ui.inputs.left("Test")

Underlying HTML Objects:

• epyk.core.html.HtmlInput.Input

Templates:

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

Parameters:

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

• placeholder – Optional. Text visible when the input component is empty

• 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

• attrs – Optional. Specific HTML tags to be added to the component

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

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

password(text: str = '', placeholder: str = '', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, attrs: Optional[dict] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → Input

Input field that will hide characters typed in.

Usage:

page.ui.inputs.password(placeholder="Password")

Underlying HTML Objects:

• epyk.core.html.HtmlInput.Input

Parameters:

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

• placeholder – Optional. Text visible when the input component is empty

• 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

• attrs – Optional. Specific HTML tags to be added to the component

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

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

radio(flag: bool, label: Optional[str] = None, group_name: Optional[str] = None, icon: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[Union[bool, dict]] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → Radio

Usage:

page.ui.radio(['Single', 'Multiple'], html_code="type")

Underlying HTML Objects:

• epyk.core.html.HtmlInput.Radio

Related Pages:

https://www.w3schools.com/tags/att_input_type_radio.asp

Templates:

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

Parameters:

• flag –

• label – Optional.

• group_name – Optional.

• icon – Optional.

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

• 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

search(text: str = '', placeholder: str = 'Search..', align: str = 'left', color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, tooltip: Optional[str] = None, extensible: bool = False, options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → Search

Add an input search component.

Usage:

page.ui.inputs.search()

Underlying HTML Objects:

• epyk.core.html.HtmlTextEditor.Cell

Related Pages:

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

Templates:

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

Parameters:

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

• placeholder –

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

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

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

• extensible –

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

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

textarea(text: str = '', width: Optional[Union[tuple, int, str]] = (100, '%'), rows: int = 5, placeholder: Optional[str] = None, background_color: Optional[str] = None, html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, tooltip: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → TextArea

Add textarea component.

Usage:

page.ui.inputs.textarea("Test")

Underlying HTML Objects:

• epyk.core.html.HtmlInput.TextArea

Related Pages:

https://www.w3schools.com/tags/tag_textarea.asp

Parameters:

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

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

• rows –

• placeholder – Optional. Text visible when the input component is empty

• background_color –

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

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

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

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