Links Interface
- class epyk.interfaces.components.CompLinks.Links(ui)
- button(text: str = '', url: str = '', icon: Optional[str] = None, helper: Optional[str] = None, height: Optional[Union[tuple, int, str]] = (None, 'px'), decoration: bool = False, html_code: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)
Underlying HTML Objects:
Usage:
page.ui.links.button()
Templates:
- Parameters:
text – Optional. The string value to be displayed in the component
url – The destination page when clicked
icon – Optional. The component icon content from font-awesome references
helper – Optional. A tooltip helper
height – Tuple. Optional. A tuple with the integer for the component height and its unit
decoration –
html_code – String. 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
- colored(text: str = '', url: str = '', icon: Optional[str] = None, helper: Optional[str] = None, color: Optional[str] = None, height: Optional[Union[tuple, int, str]] = (None, 'px'), decoration: bool = False, html_code: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)
Display a link with the same layout than a buttons.colored HTML component.
Usage:
page.ui.links
- Parameters:
text – Optional. The string value to be displayed in the component.
url – Optional. The string url of the link.
icon – Optional. A string with the value of the icon to display from font-awesome.
helper – Optional. A tooltip helper.
color – Optional. The font color in the component. Default inherit.
height – Optional. A tuple with the integer for the component height and its unit.
decoration –
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. Optional. A flag to set the component performance storage.
- data(text: str, value, width: Optional[Union[tuple, int, str]] = (None, '%'), height: Optional[Union[tuple, int, str]] = (None, 'px'), fmt: str = 'txt', options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)
Python interface to the Hyperlink to retrieve data.
Usage:
data_link = page.ui.links.data("link", "test#data") data_link.build({"text": 'new link Name', 'data': "new content"})
Underlying HTML Objects:
Templates:
- Parameters:
text – The string value to be displayed in the component
value – The value to be displayed to this 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.
fmt – Optional. The downloaded data format.
options – Optional. Specific Python options available for this component
profile – Optional. A flag to set the component performance storag.e
- download(url: str = '#', text: str = '', icon: str = 'download', helper: Optional[str] = None, height: Optional[Union[tuple, int, str]] = (None, 'px'), decoration: bool = False, align: str = 'left', html_code: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)
HTML component to upload files.
Usage:
page.ui.links
- Parameters:
text – Optional. The string value to be displayed in the component
url – Optional. The string url of the link
icon – Optional. A string with the value of the icon to display from font-awesome
helper – Optional. A tooltip helper
height – Optional. A tuple with the integer for the component height and its unit
decoration –
align – Optional. The text-align property within this component.
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
- external(text: str, url: str, icon: Optional[str] = None, align: str = 'left', helper: Optional[str] = None, height: Optional[Union[tuple, int, str]] = (None, 'px'), decoration=False, html_code: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)
Usage:
page.ui.links.external('data', 'www.google.fr', icon="fas fa-align-center", options={"target": "_blank"})
Underlying HTML Objects:
Related Pages:
Templates:
- Parameters:
text – Optional. The string value to be displayed in the component
url – Optional. The string url of the link
icon – Optional. A string with the value of the icon to display from font-awesome
align – Optional. The text-align property within this component.
helper – Optional. A tooltip helper
height – Optional. A tuple with the integer for the component height and its unit
decoration –
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
- link(text: str = '', url: str = '', icon: Optional[str] = None, align: str = 'left', tooltip: Optional[str] = None, helper: Optional[str] = None, height: Optional[Union[tuple, int, str]] = (None, 'px'), decoration: bool = False, html_code: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)
Python interface to the common Hyperlink.
Usage:
page.ui.link({"text": "Profiling results", "url": '#'}) l = page.ui.links.link('data', 'www.google.fr', icon="fas fa-align-center", options={"target": "_blank"}) b = page.ui.images.badge("new") l.append_child(b)
Underlying HTML Objects:
- Parameters:
text – Optional. The string value to be displayed in the component.
url – Optional. The string url of the link.
align – Optional. The text-align property within this component.
icon – Optional. A string with the value of the icon to display from font-awesome.
tooltip – Optional. The tooltip displayed when the mouse is on the component.
helper – Optional. A tooltip helper.
height – Tuple. Optional. A tuple with the integer for the component height and its unit.
decoration –
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
- upload(url: str = '#', text: str = '', icon: str = 'upload', helper: Optional[str] = None, height: Optional[Union[tuple, int, str]] = (None, 'px'), decoration: bool = False, align: str = 'left', html_code: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)
HTML component to upload files.
Usage:
page.ui.links
- Parameters:
text – Optional. The string value to be displayed in the component
url – Optional. The string url of the link
icon – Optional. A string with the value of the icon to display from font-awesome
helper – Optional. A tooltip helper
height – Tuple. Optional. A tuple with the integer for the component height and its unit
decoration –
align – Optional. The text-align property within this component.
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