Data Table

See: https://www.carbondesignsystem.com/components/data-table/usage/

Data tables are used to organize and display data efficiently. The data table component allows for customization with additional functionality, as needed by your product’s users.

Overview

The data table’s features are ideal for organizing and displaying data in a UI. The column headers can sort data in ascending or descending order, rows can be expanded to progressively disclose information, and single or batch actions can be taken on rows.

The data table toolbar gives a location for primary buttons, search, filtering, table display settings, and other utilities.

class carbondesign.tags.data_table.DataTable(*args, **kwargs)

Data Table component.

WANT_CHILDREN = True

Template Tag needs closing end tag.

SLOTS = ('title', 'description', 'batch_actions', 'search', 'toolbar_actions', 'toolbar_overflow', 'head', 'foot', 'pagination')

Named children.

MODES = ('default', 'sticky')

Available variants.

NODE_PROPS = ('variant', 'sortable', 'small_toolbar', 'batch_field', 'visible_overflow')

Extended Template Tag arguments.

CLASS_AND_PROPS = ('toolbar',)

Prepare xxx_class and xxx_props values.

POSSIBLE_VARIANT = ('compact', 'short', 'tall', 'zebra')

Documentation only.

prepare(values, context)

Prepare values for rendering the templates.

render_default(values, context)

Output html of the component.

render_sticky(values, context)

Output html of the component.

render_slot_head(values, context)

Render html of the slot.

render_slot_foot(values, context)

Render html of the slot.

render_slot_title(values, context)

Render html of the slot.

render_slot_description(values, context)

Render html of the slot.

render_slot_batch_actions(values, context)

Render html of the slot.

render_slot_toolbar_overflow(values, context)

Render html of the slot.

has_tmpl_header()

Should render header template?

render_tmpl_header(values, context)

Dynamically render a part of the component’s template.

has_tmpl_toolbar()

Should render toolbar template?

render_tmpl_toolbar(values, context)

Dynamically render a part of the component’s template.

class carbondesign.tags.data_table.TrExpandable(*args, **kwargs)

Table row for expandable table.

WANT_CHILDREN = True

Template Tag needs closing end tag.

SLOTS = ('subrow',)

Named children.

render_default(values, context)

Output html of the component.

class carbondesign.tags.data_table.Th(*args, **kwargs)

Table row heading.

WANT_CHILDREN = True

Template Tag needs closing end tag.

MODES = ('default', 'checkbox', 'sortable', 'menu', 'expandable', 'expand_all', 'row')

Available variants.

NODE_PROPS = ('id',)

Extended Template Tag arguments.

render_default(values, context)

Output html of the component.

render_checkbox(values, context)

Output html of the component.

render_sortable(values, context)

Output html of the component.

render_menu(values, context)

Output html of the component.

render_expandable(values, context)

Output html of the component.

render_expand_all(values, context)

Output html of the component.

render_row(values, context)

Output html of the component.

class carbondesign.tags.data_table.Td(*args, **kwargs)

Table row column.

WANT_CHILDREN = True

Template Tag needs closing end tag.

MODES = ('default', 'menu', 'menu_visible')

Available variants.

SLOTS = ('secondary',)

Named children.

prepare(values, context)

Prepare values for rendering the templates.

render_default(values, context)

Output html of the component.

render_menu(values, context)

Output html of the component.

render_menu_visible(values, context)

Output html of the component.

render_slot_secondary(values, context)

Render html of the slot.

class carbondesign.tags.data_table.TdCheckBox(*args, **kwargs)

Table row checkbox.

NODE_PROPS = ('value',)

Extended Template Tag arguments.

REQUIRED_PROPS = ('value',)

Will raise Exception if not set.

default_id()

Get Django form field html id.

label()

Get Django form field label.

before_prepare(values, context)

Initialize the values meant for rendering templates.

prepare(values, context)

Prepare values for rendering the templates.

render_default(values, context)

Output html of the component.

class carbondesign.tags.data_table.TableToolbarSearch(*args, **kwargs)

Table toolbar search filter.

NODE_PROPS = ('id', 'expandable', 'small')

Extended Template Tag arguments.

CLASS_AND_PROPS = ('wrapper', 'magnifier')

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_tmpl_magnifier_icon(values, context)

Dynamically render a part of the component’s template.

class carbondesign.tags.data_table.TableToolbarOverflowButton(*args, **kwargs)

Table toolbar action button.

WANT_CHILDREN = True

Template Tag needs closing end tag.

NODE_PROPS = ('active',)

Extended Template Tag arguments.

CLASS_AND_PROPS = ('list',)

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.

class carbondesign.tags.data_table.TdOverflowButton(*args, **kwargs)

Table row action button.

WANT_CHILDREN = True

Template Tag needs closing end tag.

SLOTS = ('icon',)

Named children.

NODE_PROPS = ('icon_size',)

Extended Template Tag arguments.

render_default(values, context)

Output html of the component.

render_slot_icon(values, context)

Render html of the slot.