Panels Interface

class epyk.interfaces.components.CompPanels.Panels(ui)

arrows_down(color: 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]] = False)

Python wrapper for a multi Tabs component.

Tags:

Categories:

Underlying HTML Objects:

• epyk.core.html.HtmlContainer.TabsArrowsDown

Related Pages:

https://getbootstrap.com/docs/4.0/components/navs/

Usage:

:param color: Optional. The font color in the component. Default inherit.
: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.

arrows_up(color: 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]] = False)

Python wrapper for a multi Tabs component.

Tags:

Categories:

Underlying HTML Objects:

• epyk.core.html.HtmlContainer.TabsArrowsUp

Related Pages:

https://getbootstrap.com/docs/4.0/components/navs/

Usage:

:param color: Optional. The font color in the component. Default inherit.
: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.

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

Python wrapper to the Bootstrap rectangle boxes interface.

Tags:

Categories:

Usage:

tab = page.ui.panels.boxes()
for i in range(5):
  tab.add_panel("Panel %s" % i, rptObj.ui.text("test %s" % i))

Underlying HTML Objects:

• epyk.core.html.HtmlContainer.Tabs

Related Pages:

https://getbootstrap.com/docs/4.0/components/navs/

Parameters:

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

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

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

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

• 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, category: str = 'group', 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)

Chip component with only the filtering section.

Tags:

Categories:

Usage:

filters = page.ui.panels.filters()

Underlying HTML Objects:

• epyk.core.html.HtmlEvent.Filters

Related Pages:

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

Parameters:

• items – Optional.

• category – 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 – Optional. A tooltip helper.

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

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

hamburger(components: Optional[List[Html]] = None, title: Union[str, dict] = '', color: Optional[str] = None, align: str = 'center', width=(100, '%'), height=(None, 'px'), html_code: Optional[str] = None, helper: Optional[str] = None, options: Optional[dict] = None, profile: Union[dict, bool] = False)

Add hamburger panel.

Tags:

Categories:

Usage:

Underlying HTML Objects:

• epyk.core.html.HtmlContainer.PanelSlide

Parameters:

• components – Optional. The different HTML objects to be added to the component.

• title – Optional. A panel title. This will be attached to the title property.

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

• align – Optional. The text-align property within this component (Default center).

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

menu(color: 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]] = False)

Python wrapper to the Bootstrap Pills interface.

Tags:

Categories:

Underlying HTML Objects:

• epyk.core.html.HtmlContainer.Tabs

Related Pages:

https://getbootstrap.com/docs/4.0/components/navs/

Usage:

:param color: Optional. The font color in the component. Default inherit.
: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.

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

Tags:

Categories:

Usage:

Templates:

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

Parameters:

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

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

• options – Optional. A dictionary with the components properties.

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

• helper – Optional. A tooltip helper.

panel(components: Optional[List[Html]] = None, title: Optional[str] = None, color: 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[dict] = None, profile: Optional[Union[bool, dict]] = False)

Add a simple div panel to the page.

Tags:

Categories:

Underlying HTML Objects:

• epyk.core.html.HtmlContainer.Panel

Usage:

:param components: Optional. The different HTML objects to be added to the component.
:param title: Optional. A panel title. This will be attached to the title property.
:param color: Optional. The font color in the component. Default inherit.
: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.

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

Python wrapper to the Bootstrap Pills interface.

Tags:

Categories:

Usage:

tab = page.ui.panels.pills()
for i in range(5):
  tab.add_panel("Panel %s" % i, rptObj.ui.text("test %s" % i))

Underlying HTML Objects:

• epyk.core.html.HtmlContainer.Tabs

Related Pages:

https://getbootstrap.com/docs/4.0/components/navs/

Parameters:

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

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

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

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

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

sliding(components, title, color: Optional[str] = None, align: str = 'center', 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]] = False) → PanelSlide

Add a sliding panel.

TODO: Animate the CSS to make a transition.

Tags:

Categories:

Usage:

text = page.ui.text("Test")
page.ui.panels.sliding([text], title="Panel title")

Underlying HTML Objects:

• epyk.core.html.HtmlContainer.PanelSlide

Parameters:

• components – Optional. The different HTML objects to be added to the component.

• title – Optional. A panel title. This will be attached to the title property.

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

• align – Optional. The text-align property within this component (Default center).

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

property slidings

More custom sliding panels.

split(left: Optional[Html] = None, right: Optional[Html] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (200, 'px'), left_width: Optional[Union[tuple, int, str]] = (160, 'px'), resizable: bool = True, helper: Optional[str] = None, options: Optional[Union[bool, dict]] = None, profile: Optional[Union[bool, dict]] = None) → PanelSplit

Tags:

Categories:

Usage:

number = page.ui.rich.number(500, "Test", height=(150, 'px'))
number_2 = page.ui.rich.number(500, "Test 2 ", options={"url": "http://www.google.fr"})
div = page.ui.layouts.panelsplit(left=number, right=number_2)

Underlying HTML Objects:

• epyk.core.html.HtmlContainer.PanelSlide

Related Pages:

https://codepen.io/rstrahl/pen/eJZQej

Parameters:

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

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

• left_width – Optional.

• left – Optional.

• right – Optional.

• resizable – Optional.

• helper – Optional. A tooltip helper.

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

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

tabs(color: 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]] = False)

Python wrapper for a multi Tabs component.

Tags:

Categories:

Usage:

tab = page.ui.panels.tabs()
for i in range(5):
  tab.add_panel("Panel %s" % i, rptObj.ui.text("test %s" % i))

Underlying HTML Objects:

• epyk.core.html.HtmlContainer.Tabs

Related Pages:

https://getbootstrap.com/docs/4.0/components/navs/

Parameters:

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

• helper – Optional. A tooltip helper.

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

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