Banners Interface

class epyk.interfaces.components.CompNavigation.Banners(ui)
bottom(data: Union[str, list] = '', background=None, align='center', width=(100, '%'), height=(None, 'px'), options=None, profile=False)
Tags:

Categories:

Usage:

# Add a banner with HTML content
icon = page.ui.icon("fab fa-python")
text = page.ui.text("This is a text")

# Chang the option to have the content in one line
bottom = page.ui.banners.bottom([icon, text], options={"inline": True})

Underlying HTML Objects:

Templates:

Parameters:

  • data –

  • background – String. Optional. Background color code.

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

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

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

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

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

contact_us(title='Contact Us', background=None, width=(100, '%'), align='left', height=(None, 'px'), html_code='contactus', options=None, profile=False)
Tags:

Categories:

Usage:

:param title: String. Optional. A panel title. This will be attached to the title property.
:param background: String. Optional. Background color code.
:param align: String. Optional. A string with the horizontal position of the component.
:param width: Tuple. Optional. A tuple with the integer for the component width and its unit.
:param height: Tuple. Optional. A tuple with the integer for the component height and its unit.
:param html_code: String. Optional. An identifier for this component (on both Python and Javascript side).
:param options: Dictionary. Optional. Specific Python options available for this component.
:param profile: Boolean | Dictionary. Optional. A flag to set the component performance storage.
cookies(text, url, align='center', width=(100, '%'), height=(None, 'px'), options=None, profile=False)
Tags:

Categories:

Usage:

page.ui.banners.cookies("Test", "#")
Parameters:

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

  • url – String. The url link.

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

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

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

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

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

corner(data='', background=None, position='bottom', width=(180, 'px'), height=(None, 'px'), options=None, profile=False)
Tags:

Categories:

Usage:

# Add a banner on the bottom right corner
b = page.ui.banners.corner("bottom", 'red')
# Add click event on the banner
b.click([
  # hide the bonner on click
  b.dom.hide()
])

# Add a banner on the top right conner
corner = page.ui.banners.corner("top", 'red', position='top')
# Add interactivity on the banner style
corner.style.hover({"background": "white", 'color': 'red'})
# display the banner
corner.hover([b.dom.show()])

Underlying HTML Objects:

Templates:

Parameters:

  • data –

  • background – String. Optional. Background color code.

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

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

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

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

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

disclaimer(copyright=None, links=None, width=(100, '%'), height=('auto', ''), align='center', options=None, profile=False)
Tags:

Categories:

Usage:

:param copyright:
:param links:
:param align: String. Optional. A string with the horizontal position of the component.
:param width: Tuple. Optional. A tuple with the integer for the component width and its unit.
:param height: Tuple. Optional. A tuple with the integer for the component height and its unit.
:param options: Dictionary. Optional. Specific Python options available for this component.
:param profile: Boolean | Dictionary. Optional. A flag to set the component performance storage.
follow(text, width=(100, '%'), height=('auto', ''), align='left', options=None, profile=False, youtube=True, twitter=True, facebook=True, twitch=True, instagram=True, linkedIn=True)
Tags:

Categories:

Usage:

:param text: String. Optional. The value to be displayed to the component.
:param align: String. Optional. A string with the horizontal position of the component.
:param width: Tuple. Optional. A tuple with the integer for the component width and its unit.
:param height: Tuple. Optional. A tuple with the integer for the component height and its unit.
:param options: Dictionary. Optional. Specific Python options available for this component.
:param profile: Boolean | Dictionary. Optional. A flag to set the component performance storage.
:param youtube: Boolean. Optional. Add the icon to the follow bar. Default True.
:param twitter: Boolean. Optional. Add the icon to the follow bar. Default True.
:param facebook: Boolean. Optional. Add the icon to the follow bar. Default True.
:param twitch: Boolean. Optional. Add the icon to the follow bar. Default True.
:param instagram: Boolean. Optional. Add the icon to the follow bar. Default True.
:param linkedIn: Boolean. Optional. Add the icon to the follow bar. Default True.
info(data, icon='fas fa-info-circle', background=None, width=(100, '%'), height=(None, 'px'), options=None, profile=False)
Tags:

Categories:

Usage:

:param data:
:param icon: String. Optional. The component icon content from font-awesome references. Default fas fa-info-circle
:param background: String. Optional. Background color code.
:param width: Tuple. Optional. A tuple with the integer for the component width and its unit
:param height: Tuple. Optional. A tuple with the integer for the component height and its unit
:param options: Dictionary. Optional. Specific Python options available for this component
:param profile: Boolean | Dictionary. Optional. A flag to set the component performance storage
quote(content, author, avatar=None, background=None, size_notch=0, width=(100, '%'), align='center', height=(None, 'px'), options=None, profile=False)
Tags:

Categories:

Usage:

:param content: String. Optional. The value to be displayed to the component.
:param author:
:param avatar:
:param background: String. Optional. Background color code.
:param size_notch:
:param align: String. Optional. A string with the horizontal position of the component
:param width: Tuple. Optional. A tuple with the integer for the component width and its unit
:param height: Tuple. Optional. A tuple with the integer for the component height and its unit
:param options: Dictionary. Optional. Specific Python options available for this component
:param profile: Boolean | Dictionary. Optional. A flag to set the component performance storage
row(headers, links, size_notch=0, background=None, width=(100, '%'), align='left', height=(None, 'px'), options=None, profile=False)
Tags:

Categories:

Usage:

:param headers:
:param links:
:param size_notch:
:param background: String. Optional. Background color code.
:param align: String. Optional. A string with the horizontal position of the component.
:param width: Tuple. Optional. A tuple with the integer for the component width and its unit.
:param height: Tuple. Optional. A tuple with the integer for the component height and its unit.
:param options: Dictionary. Optional. Specific Python options available for this component.
:param profile: Boolean | Dictionary. Optional. A flag to set the component performance storage.
sponsor(logos, title='Sponsors', content='', background=None, width=(100, '%'), height=('auto', ''), align='center', options=None, profile=False)
Tags:

Categories:

Usage:

:param logos:
:param title: String. Optional. A panel title. This will be attached to the title property.
:param content:
:param background: String. Optional. Background color code.
:param align: String. Optional. A string with the horizontal position of the component.
:param width: Tuple. Optional. A tuple with the integer for the component width and its unit.
:param height: Tuple. Optional. A tuple with the integer for the component height and its unit.
:param options: Dictionary. Optional. Specific Python options available for this component.
:param profile: Boolean | Dictionary. Optional. A flag to set the component performance storage.
text(data='', size_notch=0, background=None, width=(100, '%'), align='center', height=(None, 'px'), options=None, html_code=None, profile=False)
Tags:

Categories:

Usage:

:param data:
:param size_notch:
:param background: String. Optional. Background color code.
:param align: String. Optional. A string with the horizontal position of the component.
:param width: Tuple. Optional. A tuple with the integer for the component width and its unit.
:param height: Tuple. Optional. A tuple with the integer for the component height and its unit.
:param options: Dictionary. Optional. Specific Python options available for this component.
:param html_code: String. Optional. An identifier for this component (on both Python and Javascript side).
:param profile: Boolean | Dictionary. Optional. A flag to set the component performance storage.
title(title, content, size_notch=0, background=None, width=(100, '%'), align='center', height=(None, 'px'), options=None, profile=False)
Tags:

Categories:

Usage:

:param title:  String. Optional. A panel title. This will be attached to the title property.
:param content: String. Optional. The value to be displayed to the component.
:param size_notch:
:param background: String. Optional. Background color code.
:param align: String. Optional. A string with the horizontal position of the component.
:param width: Tuple. Optional. A tuple with the integer for the component width and its unit.
:param height: Tuple. Optional. A tuple with the integer for the component height and its unit.
:param options: Dictionary. Optional. Specific Python options available for this component.
:param profile: Boolean | Dictionary. Optional. A flag to set the component performance storage.
top(data='', background=None, width=(100, '%'), height=(None, 'px'), options=None, profile=False)
Tags:

Categories:

Usage:

# to Change the CSS style
top = page.ui.banners.top("text")
top.style.css.font_size = '40px'

Underlying HTML Objects:

Templates:

Parameters:

  • data –

  • background – String. Optional. Background color code.

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

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

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

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