Attributes

• id (:string) (required)
• on_toggle_all (:any)
• selected_count (:integer) (required)
• selected (:map) - A map of row ids to 'true' or 'false'. Defaults to %{}.

Slots

• promoted_bulk_action - BulkActions for the table. Accepts attributes:
  • content (:string) - Content the action displays.
  • disabled (:boolean) - Whether or not the action is disabled.
  • variant (:string) - Changes the visual appearance of the Button.Must be one of "plain", "primary", "secondary", "tertiary", or "monochromePlain".
  • tone (:string) - Sets the color treatment of the Button.Must be one of "critical", or "success".
  • full_width (:boolean) - Allows the button to grow to the width of its container.
  • size (:string) - Changes the size of the button, giving it more or less padding.Must be one of "micro", "slim", "medium", or "large".
  • navigate (:string) - Passes through to .link component.
  • patch (:string) - Passes through to .link component.
  • href (:string) - Passes through to .link component.
  • target (:string) - Passes through to .link component.
  • icon (:any) - Source of the icon.Examples include &OctantisWeb.Components.Polaris.Icons.arrow_right/1.
  • phx_click (:any) - Click function passed through to the button.

Attributes

• id (:string) (required)
• name (:string) - Defaults to "select_all".
• accessibility_label (:string) - Defaults to nil.
• label (:string) - Defaults to nil.
• checked (:atom) - Must be one of true, false, or :indeterminate.
• disabled (:boolean) - Defaults to false.
• phx_click (:any) - onClick: Callback when row is clicked.
• aria_live (:atom) - Defaults to nil.

An index table displays a collection of objects of the same type, like orders or products. The main job of an index table is to help merchants get an at-a-glance of the objects to perform actions or navigate to a full-page representation of it.

Examples

<.index_table />

See

• https://polaris.shopify.com/components/tables/index-table
• https://github.com/Shopify/polaris/blob/main/polaris-react/src/components/IndexTable/IndexTable.tsx

Attributes

• id (:string) - A unique identifier for the table. Defaults to "IndexTable".
• selectable (:boolean) (required) - Include the selection checkboxes to the left.
• selected (:map) - A map of row ids to 'true' or 'false'. Defaults to %{}.
• rows (:list) (required) - A list of items, each item must have an id.
• class (:any) - A class name to be added to the component class name. Defaults to "".
• on_selection_change (:any) - Callback for when the checkbox is toggled. Defaults to nil.
• style (:string) - Style attribute.
• align_items (:string) - Style attribute.
• align_self (:string) - Style attribute.
• display (:string) - Style attribute.
• flex_grow (:string) - Style attribute.
• grid_auto_rows (:string) - Style attribute.
• grid_template_columns (:string) - Style attribute.
• grid_template_rows (:string) - Style attribute.
• justify_content (:string) - Style attribute.
• margin (:string) - Style attribute.
• max_height (:string) - Style attribute.
• min_height (:string) - Style attribute.
• object_fit (:string) - Style attribute.
• opacity (:string) - Style attribute.

Slots

• col (required) - Accepts attributes:
  • header (:any) (required) - Examples include "Order", "Date", "Customer", and {"Total", [alignment: "end"]}.
  • class (:any) - Class to be passed on to the header and cell.
• promoted_bulk_action - BulkActions for the table. Accepts attributes:
  • content (:string) - Content the action displays.
  • disabled (:boolean) - Whether or not the action is disabled.
  • variant (:string) - Changes the visual appearance of the Button.Must be one of "plain", "primary", "secondary", "tertiary", or "monochromePlain".
  • tone (:string) - Sets the color treatment of the Button.Must be one of "critical", or "success".
  • full_width (:boolean) - Allows the button to grow to the width of its container.
  • size (:string) - Changes the size of the button, giving it more or less padding.Must be one of "micro", "slim", "medium", or "large".
  • navigate (:string) - Passes through to .link component.
  • patch (:string) - Passes through to .link component.
  • href (:string) - Passes through to .link component.
  • target (:string) - Passes through to .link component.
  • icon (:any) - Source of the icon.Examples include &OctantisWeb.Components.Polaris.Icons.arrow_right/1.
  • phx_click (:any) - Click function passed through to the button.
• inner_block

Attributes

• phx_click (:any) - onClick: Callback when row is clicked.
• class (:any) - Class to be passed on to the cell.
• Global attributes are accepted.

Slots

• inner_block

Attributes

• phx_click (:any) - onClick: Callback when row is clicked.
• checked (:boolean) (required)
• selectable (:boolean) (required)

Slots

• inner_block

Attributes

• id (:string)
• parent_id (:string)
• on_selection_change (:any) - Callback for when the checkbox is toggled.
• checked (:boolean) - Defaults to false.

Attributes

• heading (:any) (required)
• index (:integer) (required)
• last (:boolean) (required)
• selectable (:boolean) (required)
• class (:any) - Class to be passed on to the header and cel.

Attributes

• id (:string)
• on_selection_change (:any) - Callback for when the checkbox is toggled.
• checked (:boolean) - Defaults to false.
• selected_count (:integer) (required) - The number of selected rows.