Vuer

vuer.schemas.html_components

Element

python
class Element

Source

Base class for all elements

python
tag: str = 'div'

Element.init

python
def __init__(self, key=None, **kwargs)

Source

Element.serialize

python
def serialize(self)

Source

Serialize the element to a dictionary for sending over the websocket.

:return: Dictionary representing the element.

BlockElement

python
class BlockElement(Element)

Source

BlockElement.init

python
def __init__(self, *children, **kwargs)

Source

BlockElement.serialize

python
def serialize(self)

Source

Inherited members

AutoScroll

python
class AutoScroll(BlockElement)

Source

Inherited members

python
tag = 'AutoScroll'

Markdown

python
class Markdown(BlockElement)

Source

Inherited members

python
tag = 'Markdown'

Page

python
class Page(BlockElement)

Source

A Page is an element that contains other elements. It is represented by a div element in the DOM.

Inherited members

python
tag = 'article'

div

python
class div(BlockElement)

Source

Inherited members

python
tag = 'Div'

InputBox

python
class InputBox(Element)

Source

An InputBox is an element that allows the user to input text. It is represented by an input element in the DOM.

InputBox.init

python
def __init__(self, **kwargs)

Source

Inherited members

python
tag = 'Input'

Header1

python
class Header1(BlockElement)

Source

A Text element is an element that displays text. It is represented by a text, or p element in the DOM.

Header1.init

python
def __init__(self, *children, **kwargs)

Source

Inherited members

python
tag = 'h1'

Header2

python
class Header2(Header1)

Source

Header 2

Inherited members

python
tag = 'h2'

Header3

python
class Header3(Header1)

Source

Header 2

Inherited members

python
tag = 'h3'

Paragraph

python
class Paragraph(BlockElement)

Source

A Text element is an element that displays text. It is represented by a text, or p element in the DOM.

Paragraph.init

python
def __init__(self, *children, **kwargs)

Source

Inherited members

python
tag = 'p'

span

python
class span(Element)

Source

A Text element is an element that displays text. It is represented by a text, or p element in the DOM.

span.init

python
def __init__(self, *text, sep=' ', **kwargs)

Source

Inherited members

python
tag = 'Span'

Bold

python
class Bold(span)

Source

Bold.init

python
def __init__(self, text, style=None, **kwargs)

Source

Inherited members

Italic

python
class Italic(span)

Source

Italic.init

python
def __init__(self, text, style=None, **kwargs)

Source

Inherited members

Link

python
class Link(span)

Source

Link.init

python
def __init__(self, text, src, **kwargs)

Source

Inherited members

python
tag = 'a'

Button

python
class Button(Element)

Source

A Button element is an element that allows the user to click on it. It is represented by a button element in the DOM.

Button.init

python
def __init__(self, **kwargs)

Source

Inherited members

python
tag = 'Button'

Slider

python
class Slider(Element)

Source

A Slider element is an element that allows the user to slide a value. It is represented by a slider element in the DOM.

Slider.init

python
def __init__(self, **kwargs)

Source

:param min: Minimum value of the slider :param max: Maximum value of the slider :param step: Step size of the slider :param value: Initial value of the slider :param kwargs:

Inherited members

python
tag = 'Slider'

Image

python
class Image(Element)

Source

An Image element is an element that displays an image. It is represented by an img element in the DOM.

Image.init

python
def __init__(self, data: Union[str, np.ndarray, pil_image.Image]=None, *, src: Union[str, bytes]=None, format: Literal['png', 'jpeg', 'b64png', 'b64jpeg']='png', quality: int=None, **kwargs)

Source

Inherited members

python
tag = 'Img'

ImageUpload

python
class ImageUpload(Element)

Source

A ImageUpload element is an element that allows the user to upload a file. It is represented by a file upload element in the DOM.

ImageUpload.init

python
def __init__(self, **kwargs)

Source

Inherited members

python
tag = 'ImageUpload'