HtmlTextEditor Module

class epyk.core.html.HtmlTextEditor.Cell(page: PageModel, vals: Union[list, str], language: str, width: tuple, height: tuple, html_code: Optional[str], options: Optional[dict], profile: Optional[Union[bool, dict]])
action(icon: str, js_funcs: Union[list, str], tooltip: Optional[str] = None)

Add a bespoke action to the action panel.

Parameters:
  • icon – The font awesome icon

  • js_funcs – The Javascript functions

  • tooltip – Optional. Text to be displayed when mouse is hover

run(js_funcs: Union[list, str], icon: str = 'play', tooltip: Optional[str] = None)

Emtpy run button.

This function will just add the icon on the actions panel.

Parameters:
  • icon – The font awesome icon

  • js_funcs – Optional. The Javascript functions

  • tooltip – Optional. Text to be displayed when mouse is hover

save(js_funcs: Union[list, str], icon: str = 'save', tooltip: Optional[str] = None)

Emtpy save button.

This function will just add the icon on the actions panel.

Parameters:
  • icon – The font awesome icon

  • js_funcs – Optional. The Javascript functions

  • tooltip – Optional. Text to be displayed when mouse is hover

class epyk.core.html.HtmlTextEditor.Console(page: PageModel, data: Union[str, list], width: tuple, height: tuple, html_code: Optional[str], helper: Optional[str], options: Optional[dict], profile: Optional[Union[bool, dict]])
property dom: Console

Return all the Javascript functions defined for an HTML Component.

Those functions will use plain javascript by default.

Returns:

A Javascript Dom object

property options: OptionsConsole

Property to the component options.

Options can either impact the Python side or the Javascript builder.

Python can pass some options to the JavaScript layer.

class epyk.core.html.HtmlTextEditor.Editor(page: PageModel, vals, language, width, height, html_code, options, profile)
action(icon: str, js_funcs: Union[list, str], tooltip: Optional[str] = None)

Add a bespoke action to the action panel.

Parameters:
  • icon – The font awesome icon

  • js_funcs – The Javascript functions

  • tooltip – Optional. Text to be displayed when mouse is hover

clear(js_funcs: Union[list, str], icon: str = 'remove', tooltip: Optional[str] = None)

Add an event action to the console object.

Parameters:
  • icon – The font awesome icon

  • js_funcs – Optional. The Javascript functions

  • tooltip – Optional. Text to be displayed when mouse is hover

copy(js_funcs: Union[list, str], icon: str = 'capture', tooltip: Optional[str] = None)

Copy the content of the editor component to the clipboard.

Parameters:
  • icon – The font awesome icon

  • js_funcs – Optional. The Javascript functions

  • tooltip – Optional. Text to be displayed when mouse is hover

property dom: Editor

Return all the Javascript functions defined for an HTML Component.

Those functions will use plain javascript by default.

Returns:

A Javascript Dom object

run(js_funcs: Union[list, str], icon: str = 'play', tooltip: Optional[str] = None)

Emtpy run button.

This function will just add the icon on the actions panel.

Parameters:
  • icon – The font awesome icon

  • js_funcs – Optional. The Javascript functions

  • tooltip – Optional. Text to be displayed when mouse is hover

save(js_funcs: Union[list, str], icon: str = 'save', tooltip: Optional[str] = None)

Emtpy save button.

This function will just add the icon on the actions panel.

Parameters:
  • icon – The font awesome icon

  • js_funcs – Optional. The Javascript functions

  • tooltip – Optional. Text to be displayed when mouse is hover

toggle(js_funcs: Union[list, str], icons: tuple = ('show', 'hide'), tooltip: Optional[str] = None)

Add an event action to the console object.

Parameters:
  • icons – The font awesome icon

  • js_funcs – Optional. The Javascript functions

  • tooltip – Optional. Text to be displayed when mouse is hover

class epyk.core.html.HtmlTextEditor.MarkdownReader(page: PageModel, vals: Union[str, list], width: tuple, height: tuple, html_code: Optional[str], options: Optional[dict], profile: Optional[Union[bool, dict]])
property dom: JsHtmlRich

Return all the Javascript functions defined for an HTML Component.

Those functions will use plain javascript available for a DOM element by default.

Usage:

div = page.ui.div(htmlCode="testDiv")
print(div.dom.content)
Returns:

A Javascript Dom object.

property options: OptionsText

Property to set all the input TimePicker component properties.

Related Pages:

tooltips(data: dict)

Add automatically tooltips to the words.

Parameters:

data – The list of word to be automatically changed

class epyk.core.html.HtmlTextEditor.Tags(page: PageModel, vals: list, title: str, icon: str, size: tuple, width: tuple, height: tuple, html_code: Optional[str], profile: Optional[Union[bool, dict]])
jsAdd(data)
Parameters:

data

jsEmpty()
property val