Fields Interface

class epyk.interfaces.components.CompFields.Fields(ui)

autocomplete(value: str = '', label: Optional[str] = None, placeholder: str = '', icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldAutocomplete

Tags:
Categories:

Usage:

page.ui.fields.autocomplete("", label="Range Example", icon="fas fa-unlock-alt")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldAutocomplete

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component. Default empty string
label – Optional. The text of label to be added to the component
placeholder – Optional. The text to be displayed when the input is empty
icon – Optional. The component icon content from font-awesome references
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
profile – Optional. A flag to set the component performance storage
options – Optional. Specific Python options available for this component

checkbox(value: bool = False, label: Optional[str] = None, icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldCheckBox

Tags:
Categories:

Usage:

page.ui.fields.checkbox(True, label="Check")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldCheckBox

Related Pages:

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

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component. Default empty string
label – Optional. The text of label to be added to the component
icon – Optional. The component icon content from font-awesome references
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

cob(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.

Tags:
Categories:

Usage:

page.ui.fields.cob(label="COB Date")

Underlying HTML Objects:

epyk.core.html.HtmlDates.DatePicker

Related Pages:

https://jqueryui.com/datepicker/

Templates:

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

Parameters:

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

column_date(label, value: str = 'T', align: str = 'left', width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → Div

Tags:
Categories:

Usage:

:param label: Optional. The text of label to be added to the component
:param value: Optional. The value to be displayed to this component. Default T
:param align: Optional. The text-align property within this component
: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

column_text(label, text: str = '', align: str = 'left', width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → Div

Tags:
Categories:

Usage:

:param label: Optional. The text of label to be added to the component
:param text: Optional. The string value to be displayed in the component
:param align: Optional. The text-align property within this component
: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

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.

Tags:
Categories:

Usage:

dt = page.ui.fields.date('2020-04-08', label="Date").included_dates(["2020-04-08", "2019-09-06"])
dt.select([page.js.alert(dt.dom.content)])

Underlying HTML Objects:

epyk.core.html.HtmlDates.DatePicker

Related Pages:

https://jqueryui.com/datepicker/

Templates:

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

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

days(value=None, label: Optional[str] = None, icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldSelect

Tags:
Categories:

Usage:

page.ui.fields.select(["a", "b"], label="Check")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldSelect

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component
label – Optional. The text of label to be added to the component
icon – Optional. The component icon content from font-awesome references
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

file(value: str = '', label: Optional[str] = None, placeholder: str = '', icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldFile

Tags:
Categories:

Usage:

page.ui.fields.integer(label="test")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldFile

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component. Default empty string
label – Optional. The text of label to be added to the component
placeholder – Optional. The text to be displayed when the input is empty
icon – Optional. The component icon content from font-awesome references
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

filters(items=None, button=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[Union[bool, dict]] = None, autocomplete: bool = False, kind: str = 'select', profile: Optional[Union[bool, dict]] = None)

Parameters:

items –
button –
width –
height –
html_code –
helper –
options –
autocomplete –
kind –
profile –

hidden(value: str = '', label: Optional[str] = None, placeholder: str = '', icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldInput

Create a hidden HTML component. This is used to store values which are not visible on the page.

Tags:
Categories:

Usage:

page.ui.fields.hidden(label="readonly field")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldInput

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component. Default empty string
label – Optional. The text of label to be added to the component
placeholder – Optional. The text to be displayed when the input is empty
icon – Optional. The component icon content from font-awesome references
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
profile – Optional. A flag to set the component performance storage
options – Optional. Specific Python options available for this component

input(value: str = '', label: Optional[str] = None, placeholder: str = '', icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldInput

Tags:
Categories:

Usage:

page.ui.fields.input("", label="Range Example", icon="fas fa-unlock-alt")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldInput

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component. Default empty string
label – Optional. The text of label to be added to the component
placeholder – Optional. The text to be displayed when the input is empty
icon – Optional. The component icon content from font-awesome references
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
profile – Optional. A flag to set the component performance storage
options – Optional. Specific Python options available for this component

integer(value: str = '', label: Optional[str] = None, placeholder: str = '', icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldInteger

Tags:
Categories:

Usage:

page.ui.fields.integer(label="test")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldInteger

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component. Default empty string
label – Optional. The text of label to be added to the component
placeholder – Optional. The text to be displayed when the input is empty
icon – Optional. The component icon content from font-awesome references
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
profile – Optional. A flag to set the component performance storage
options – Optional. Specific Python options available for this component

months(value=None, label: Optional[str] = None, icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldSelect

Tags:
Categories:

Usage:

page.ui.fields.select(["a", "b"], label="Check")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldSelect

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component
label – Optional. The text of label to be added to the component
icon – Optional. The component icon content from font-awesome references
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

now(deltatime: int = 0, label: Optional[str] = None, icon: str = 'clock', color: Optional[str] = None, html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[Union[bool, dict]] = None, helper: Optional[str] = None) → TimePicker

This component is based on the Jquery Time Picker object.

Tags:
Categories:

Usage:

page.ui.fields.now(label="timestamp", color="red", helper="This is the report timestamp")
page.ui.fields.now(label="Time field")

Underlying HTML Objects:

epyk.core.html.HtmlDates.TimePicker

Related Pages:

https://github.com/jonthornton/jquery-timepicker

Templates:

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

Parameters:

deltatime – Optional
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
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

number(value: str = '', label: Optional[str] = None, placeholder: str = '', icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldInput

Tags:
Categories:

Usage:

page.ui.fields.input("", label="Range Example", icon="fas fa-unlock-alt")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldInput

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component. Default empty string
label – Optional. The text of label to be added to the component
placeholder – Optional. The text to be displayed when the input is empty
icon – Optional. The component icon content from font-awesome references
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
profile – Optional. A flag to set the component performance storage
options – Optional. Specific Python options available for this component

password(value: str = '', label: Optional[str] = None, placeholder: str = '', icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldPassword

Tags:
Categories:

Usage:

page.ui.fields.password(label="password")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldPassword

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component. Default empty string
label – Optional. The text of label to be added to the component
placeholder – Optional. The text to be displayed when the input is empty
icon – Optional. The component icon content from font-awesome references
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

radio(value: bool = False, label: str = '', group_name: Optional[str] = None, icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → Radio

The <input type=”radio”> defines a radio button. Radio buttons are normally presented in radio groups (a collection of radio buttons describing a set of related options). Only one radio button in a group can be selected at the same time.

Tags:
Categories:

Usage:

page.ui.inputs.radio(False, label="radio")

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/fields.py

Parameters:

value – Optional. The value to be displayed to this component. Default False
label – Optional. The text of label to be added to the component
group_name – Optional. Group different radio together to only have 1 value selected
icon – Optional. The component icon content from font-awesome references
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

range(value: str = '', min: int = 0, max: int = 100, step: int = 1, label: Optional[str] = None, placeholder: str = '', icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldRange

The <input type=”range”> defines a control for entering a number whose exact value is not important. Default range is 0 to 100. However, you can set restrictions on what numbers are accepted with the attributes below. - max - specifies the maximum value allowed - min - specifies the minimum value allowed - step - specifies the legal number intervals - value - Specifies the default value

Tags:
Categories:

Usage:

page.ui.fields.range(54, min=20, label="Range Example", icon="fas fa-unlock-alt")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldRange

Related Pages:

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

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component. Default empty string
min –
max –
step –
label – Optional. The text of label to be added to the component
placeholder –
icon – Optional. The component icon content from font-awesome references
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(value: Optional[list] = None, label: Optional[str] = None, icon: Optional[str] = None, selected: Optional[bool] = 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[Union[bool, dict]] = None, multiple: bool = False, profile: Optional[Union[bool, dict]] = None) → FieldSelect

Tags:
Categories:

Usage:

page.ui.fields.select(["a", "b"], label="Check")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldSelect

Templates:

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

Parameters:

value – Optional. The value to be displayed to the component. Default False
label – Optional. The text of label to be added to the component
icon – Optional. The component icon content from font-awesome references
selected – Optional. The selected value
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
multiple – Optional. Flag to specify the number of items to be selectable
profile – Optional. A flag to set the component performance storage

slider(value: float = 0, min: float = 0, max: float = 10, step: float = 1, orientation: str = 'horizontal', label: 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, range: bool = False, profile: Optional[Union[bool, dict]] = None) → Div

Parameters:

value – Optional. The value to be displayed to this component. Default 0
min – Optional.
max – Optional.
step – Optional.
orientation – Optional.
label – Optional. The toggle static label displayed
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
range – Optional.
profile – Optional. A flag to set the component performance storage

static(value: str = '', label: Optional[str] = None, placeholder: str = '', icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None, input_tag: bool = False) → FieldInput

Tags:
Categories:

Usage:

page.ui.fields.static(label="readonly field")

page.ui.fields.static('''
  Value Formatter €
  A Value Formatter is...
  ''', label="toto", options={"html_encode": True, "multiline": True})

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldInput

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component. Default empty string
label – Optional. The text of label to be added to the component
placeholder – Optional. The text to be displayed when the input is empty
icon – Optional. The component icon content from font-awesome references
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
profile – Optional. A flag to set the component performance storage
options – Optional. Specific Python options available for this component
input_tag – Optional. Use an input field

text(text: str = '', label: Optional[str] = None, color: Optional[str] = None, align: str = 'left', width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = (None, 'px'), html_code: Optional[str] = None, tooltip: Optional[str] = None, options: Optional[Union[bool, dict]] = None, helper: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → Text

Add the HTML text component to the page.

Tags:
Categories:

Usage:

page.ui.text("this is a test")

Underlying HTML Objects:

epyk.core.html.HtmlText.Text

Related Pages:

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

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/banners.py https://github.com/epykure/epyk-templates/blob/master/locals/components/contextmenu.py https://github.com/epykure/epyk-templates/blob/master/locals/components/image.py https://github.com/epykure/epyk-templates/blob/master/locals/components/markdown.py https://github.com/epykure/epyk-templates/blob/master/locals/components/postit.py

Parameters:

text – Optional. The string value to be displayed in the component
label – Optional. The text of label to be added to the component
color – Optional. The color of the text
align – Optional. The position of the icon in the line (left, right, center)
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)
tooltip – Optional. A string with the value of the tooltip
options – Optional. Specific Python options available for this component
helper – Optional. A tooltip helper
profile – Optional. A flag to set the component performance storage

textarea(value: str = '', label: Optional[str] = None, placeholder: str = '', icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldTextArea

Tags:
Categories:

Usage:

page.ui.fields.textarea(label="Date")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldTextArea

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component. Default empty string
label – Optional. The text of label to be added to the component
placeholder – Optional. The text to be displayed when the input is empty
icon – Optional. The component icon content from font-awesome references
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

time(value: Optional[str] = None, label: Optional[str] = None, icon: str = 'clock', color: Optional[str] = None, html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, options: Optional[Union[bool, dict]] = None, helper: Optional[str] = None) → TimePicker

This component is based on the Jquery Time Picker object.

Tags:
Categories:

Usage:

page.ui.fields.time(label="timestamp", color="red", helper="This is the report timestamp")
page.ui.fields.time(label="Time field")

Underlying HTML Objects:

epyk.core.html.HtmlDates.TimePicker

Related Pages:

https://github.com/jonthornton/jquery-timepicker

Templates:

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

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

today(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.

Tags:
Categories:

Usage:

page.ui.fields.today(label="Date").included_dates(["2019-09-01", "2019-09-06"])
page.ui.fields.today()

Underlying HTML Objects:

epyk.core.html.HtmlDates.DatePicker

Related Pages:

https://jqueryui.com/datepicker/

Templates:

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

Categories:

Inputs,Texts

Tags:

Dates

Parameters:

label – Optional. The text of label to be added to the component
icon – Optional. The component icon content from font-awesome references
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
color – Optional. The font color in the component. Default inherit
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

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

Add a toggle component.

Tags:
Categories:

Usage:

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

Underlying HTML Objects:

epyk.core.html.HtmlRadio.Switch

Related Pages:

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

Templates:

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

Parameters:

record – Optional. The list of dictionaries with the data
label – Optional. The toggle static label displayed
is_on – Optional.
color – Optional. String. Optional. The font color in the component. Default inherit
width – Optional. A tuple with the integer for the component width and its unit
height – Optional. A tuple with the integer for the component height and its unit
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

weeks(value=None, label: Optional[str] = None, icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldSelect

Tags:
Categories:

Usage:

page.ui.fields.select(["a", "b"], label="Check")

Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldSelect

Templates:

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

Parameters:

value – Optional. The value to be displayed to this component
label – Optional. The text of label to be added to the component
icon – Optional. The component icon content from font-awesome references
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

years(value=None, label: Optional[str] = None, icon: Optional[str] = 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[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → FieldSelect

tags:

categories:

Usage:
page.ui.fields.select(["a", "b"], label="Check")
Underlying HTML Objects:

epyk.core.html.HtmlInput.FieldSelect

Templates:

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

param value:

Optional. The value to be displayed to this component

param label:

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

param icon:

Optional. The component icon content from font-awesome references

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 helper:

Optional. A tooltip helper

param options:

Optional. Specific Python options available for this component

param profile:

Optional. A flag to set the component performance storage