Tooltip

See: https://www.carbondesignsystem.com/components/tooltip/usage/

Tooltips display additional information upon click, hover, or focus. The information should be contextual, useful, and nonessential.

Overview

A tooltip is a message box that is displayed when a user hovers over, clicks or gives focus to a UI element such as an icon, a highlighted word, or a button.

class carbondesign.tags.tooltip.BaseTooltip(*args, **kwargs)

Base tooltip.

WANT_CHILDREN = True

Template Tag needs closing end tag.

NODE_PROPS = ('id', 'align', 'position')

Extended Template Tag arguments.

POSSIBLE_ALIGN = ('start', 'center', 'end')

Documentation only.

POSSIBLE_POSITION = ('top', 'right', 'bottom', 'left')

Documentation only.

prepare(values, context)

Prepare values for rendering the templates.

render_slot_icon(values, context)

Render html of the slot.

class carbondesign.tags.tooltip.Interactive(*args, **kwargs)

Tooltip component.

SLOTS = ('icon', 'footer', 'heading')

Named children.

MODES = ('interactive', 'nolabel')

Available variants.

REQUIRED_PROPS = ('label',)

Will raise Exception if not set.

CLASS_AND_PROPS = ('label', 'content')

Prepare xxx_class and xxx_props values.

prepare(values, context)

Prepare values for rendering the templates.

render_interactive(values, context)

Output html of the component.

render_nolabel(values, context)

Output html of the component.

render_slot_heading(values, context)

Render html of the slot.

Render html of the slot.

class carbondesign.tags.tooltip.Definition(*args, **kwargs)

Tooltip component.

REQUIRED_PROPS = ('label',)

Will raise Exception if not set.

render_default(values, context)

Output html of the component.

class carbondesign.tags.tooltip.Icon(*args, **kwargs)

Tooltip component.

SLOTS = ('icon',)

Named children.

render_default(values, context)

Output html of the component.