Progress Indicator

See: https://www.carbondesignsystem.com/components/progress-indicator/usage/

A progress indicator is a visual representation of a user’s progress through a set of steps, guiding toward the completion of a specified process.

Overview

Use progress indicators to keep the user on track when completing a specific task. By dividing the end goal into smaller, sub-tasks, it increases the percentage of completeness as each task is completed.

class carbondesign.tags.progress_indicator.ProgressIndicator(*args, **kwargs)

Progress Indicator component.

WANT_CHILDREN = True

Template Tag needs closing end tag.

NODE_PROPS = ('vertical',)

Extended Template Tag arguments.

prepare(values, context)

Prepare values for rendering the templates.

render_default(values, context)

Output html of the component.

class carbondesign.tags.progress_indicator.ProgressIndicatorItem(*args, **kwargs)

Progress Indicator item component.

WANT_CHILDREN = True

Template Tag needs closing end tag.

SLOTS = ('help', 'optional')

Named children.

NODE_PROPS = ('id', 'variant')

Extended Template Tag arguments.

CLASS_AND_PROPS = ('list',)

Prepare xxx_class and xxx_props values.

POSSIBLE_VARIANT = ('current', 'complete', 'incomplete', 'invalid', 'disabled')

Documentation only.

prepare(values, context)

Prepare values for rendering the templates.

render_default(values, context)

Output html of the component.

render_slot_help(values, context)

Render html of the slot.

render_slot_optional(values, context)

Render html of the slot.

render_tmpl_icon(values, context)

Dynamically render a part of the component’s template.