`duck.html.components.icon`¶

Icon component module.

Notes:

This depends on your JS/CSS bundle you are using for icons.

Module Contents¶

Classes¶

`Icon`	Icon component.
`IconLink`	Icon Link component.

API¶

class duck.html.components.icon.Icon(element: Optional[str] = None, properties: Optional[Dict[str, str]] = None, props: Optional[Dict[str, str]] = None, style: Optional[Dict[str, str]] = None, inner_html: Optional[Union[str, str, float]] = None, children: Optional[List[duck.html.components.HtmlComponent]] = None, **kwargs)[source]¶

Bases: duck.html.components.InnerComponent

Icon component.

Notes:

This is just a <span> component, provide argument klass for the icon class.

Initialization

Initialize an HTML component.

Parameters:

element – The HTML element tag name (e.g., textarea, input, button). Can be None, but make sure element is returned by get_element method.
accept_inner_html – Whether the HTML component accepts an inner body (e.g., inner-body-here).
inner_html – Inner html to add to the HTML component. Defaults to None.
properties – Dictionary for properties to initialize the component with.
props – Just same as properties argument (added for simplicity).
style – Dictionary for style to initialize the component with.
**kwargs – Extra keyword arguments

Raises:

HtmlComponentError – If ‘element’ is not a string or ‘inner_html’ is set but ‘accept_inner_html’ is False.

get_element()[source]¶

class duck.html.components.icon.IconLink(url: str = None, *args, **kwargs)[source]¶

Bases: duck.html.components.link.Link

Icon Link component.