UI Shell

See: https://the-carbon-components.netlify.app/?nav=ui-shell

class carbondesign.tags.ui_shell.UiShell(*args, **kwargs)

UI Shell component.

WANT_CHILDREN = True

Template Tag needs closing end tag.

SLOTS = ('title', 'title_prefix', 'navigation', 'links', 'actions', 'sidenav', 'switcher')

Named children.

NODE_PROPS = ('id', 'href', 'label_prefix')

Extended Template Tag arguments.

DEFAULT_TAG = 'header'

Rendered HTML tag.

prepare(values, context)

Prepare values for rendering the templates.

render_default(values, context)

Output html of the component.

render_slot_navigation(values, context)

Render html of the slot.

render_slot_links(values, context)

Render html of the slot.

render_slot_actions(values, context)

Render html of the slot.

render_slot_title_prefix(values, context)

Render html of the slot.

render_tmpl_title(values, context)

Dynamically render a part of the component’s template.

render_tmpl_hamburger(values, context)

Dynamically render a part of the component’s template.

class carbondesign.tags.ui_shell.Link(*args, **kwargs)

Navigation link.

WANT_CHILDREN = True

Template Tag needs closing end tag.

SLOTS = ('submenu',)

Named children.

NODE_PROPS = ('expanded',)

Extended Template Tag arguments.

prepare(values, context)

Prepare values for rendering the templates.

render_default(values, context)

Output html of the component.

render_slot_submenu(values, context)

Render html of the slot.

class carbondesign.tags.ui_shell.Action(*args, **kwargs)

Topbar action buttons.

WANT_CHILDREN = True

Template Tag needs closing end tag.

SLOTS = ('svg_open', 'svg_close')

Named children.

NODE_PROPS = ('target',)

Extended Template Tag arguments.

REQUIRED_PROPS = ('target',)

Will raise Exception if not set.

DEFAULT_TAG = 'button'

Rendered HTML tag.

prepare(values, context)

Prepare values for rendering the templates.

render_default(values, context)

Output html of the component.

render_slot_svg_open(values, context)

Render html of the slot.

render_slot_svg_close(values, context)

Render html of the slot.

class carbondesign.tags.ui_shell.NavSection(*args, **kwargs)

Side navigation’s section.

WANT_CHILDREN = True

Template Tag needs closing end tag.

render_default(values, context)

Output html of the component.

class carbondesign.tags.ui_shell.NavItem(*args, **kwargs)

Side navigation’s items.

WANT_CHILDREN = True

Template Tag needs closing end tag.

SLOTS = ('submenu', 'icon')

Named children.

NODE_PROPS = ('id', 'active', 'icon_size')

Extended Template Tag arguments.

prepare(values, context)

Prepare values for rendering the templates.

render_default(values, context)

Output html of the component.

render_slot_submenu(values, context)

Render html of the slot.

render_slot_icon(values, context)

Render html of the slot.

class carbondesign.tags.ui_shell.SideNav(*args, **kwargs)

UI Shell side navigation.

WANT_CHILDREN = True

Template Tag needs closing end tag.

SLOTS = ('title_icon', 'title', 'switcher')

Named children.

NODE_PROPS = ('id', 'fixed')

Extended Template Tag arguments.

DEFAULT_TAG = 'aside'

Rendered HTML tag.

prepare(values, context)

Prepare values for rendering the templates.

render_default(values, context)

Output html of the component.

render_slot_title_icon(values, context)

Render html of the slot.

render_slot_title(values, context)

Render html of the slot.

render_slot_switcher(values, context)

Render html of the slot.

render_tmpl_header(values, context)

Dynamically render a part of the component’s template.

class carbondesign.tags.ui_shell.SideNavOption(*args, **kwargs)

UI Shell side navigation’s switcher option.

WANT_CHILDREN = True

Template Tag needs closing end tag.

render_default(values, context)

Output html of the component.

class carbondesign.tags.ui_shell.SideNavItem(*args, **kwargs)

UI Shell side navigation’s items.

WANT_CHILDREN = True

Template Tag needs closing end tag.

SLOTS = ('submenu', 'icon')

Named children.

NODE_PROPS = ('active', 'current', 'icon_size')

Extended Template Tag arguments.

CLASS_AND_PROPS = ('link',)

Prepare xxx_class and xxx_props values.

prepare(values, context)

Prepare values for rendering the templates.

render_default(values, context)

Output html of the component.

render_slot_icon(values, context)

Render html of the slot.