Struct Table 

pub struct Table { /* private fields */ }

A table component

Implementations

impl Table

pub fn new(cols: usize) -> Self

Creates a new table with the specified number of columns.

pub fn disable_base_style(self) -> Self

Disables based styling of row cell (paddings, text ellipsis, nowrap, etc), keeping width settings

Doesn’t affect base style of header cell. Doesn’t remove overflow-hidden

pub fn uniform_list( self, id: impl Into<ElementId>, row_count: usize, render_item_fn: impl Fn(Range<usize>, &mut Window, &mut App) -> Vec<UncheckedTableRow<AnyElement>> + 'static, ) -> Self

Enables uniform list rendering. The provided function will be passed directly to the uniform_list element. Therefore, if this method is called, any calls to Table::row before or after this method is called will be ignored.

pub fn variable_row_height_list( self, row_count: usize, list_state: ListState, render_row_fn: impl Fn(usize, &mut Window, &mut App) -> UncheckedTableRow<AnyElement> + 'static, ) -> Self

Enables rendering of tables with variable row heights, allowing each row to have its own height.

This mode is useful for displaying content such as CSV data or multiline cells, where rows may not have uniform heights. It is generally slower than Table::uniform_list due to the need to measure each row individually, but it provides correct layout for non-uniform or multiline content.

Parameters

• row_count: The total number of rows in the table.
• list_state: The ListState used for managing scroll position and virtualization. This must be initialized and managed by the caller, and should be kept in sync with the number of rows.
• render_row_fn: A closure that renders a single row, given the row index, a mutable reference to Window, and a mutable reference to App. It should return an array of AnyElements, one for each column.

pub fn striped(self) -> Self

Enables row striping (alternating row colors)

pub fn hide_row_borders(self) -> Self

Hides the border lines between rows

pub fn width(self, width: impl Into<DefiniteLength>) -> Self

Sets a fixed table width with auto column widths.

This is a shorthand for .width_config(ColumnWidthConfig::auto_with_table_width(width)). For resizable columns or explicit column widths, use Table::width_config directly.

pub fn width_config(self, config: ColumnWidthConfig) -> Self

Sets the column width configuration for the table.

pub fn interactable( self, interaction_state: &Entity<TableInteractionState>, ) -> Self

Enables interaction (primarily scrolling) with the table.

Vertical scrolling will be enabled by default if the table is taller than its container.

Horizontal scrolling will only be enabled if a table width is set via ColumnWidthConfig, otherwise the list will always shrink the table columns to fit their contents.

pub fn header(self, headers: UncheckedTableRow<impl IntoElement>) -> Self

pub fn sortable_header( self, headers: UncheckedTableRow<impl Into<SharedString>>, sort_column: Option<usize>, direction: SortDirection, on_sort: impl Fn(usize, &mut Window, &mut App) + 'static, ) -> Self

Renders a header row where every column is clickable and shows a sort direction indicator (chevron up/down/up-down icon), calling on_sort with the clicked column index.

sort_column (if set) marks which column currently drives the sort and is rendered with a direction-specific chevron (SortDirection::Ascending/SortDirection::Descending); all other columns show a neutral up/down chevron. This is purely additive to Table::header — existing callers that use .header(...) are unaffected.

pub fn row(self, items: UncheckedTableRow<impl IntoElement>) -> Self

pub fn no_ui_font(self) -> Self

pub fn map_row( self, callback: impl Fn((usize, Stateful<Div>), &mut Window, &mut App) -> AnyElement + 'static, ) -> Self

pub fn hide_row_hover(self) -> Self

Hides the default hover background on table rows. Use this when you want to handle row hover styling manually via map_row.

pub fn empty_table_callback( self, callback: impl Fn(&mut Window, &mut App) -> AnyElement + 'static, ) -> Self

Provide a callback that is invoked when the table is rendered without any rows

Trait Implementations

impl Component for Table

fn scope() -> ComponentScope

Returns the scope of the component.

fn description() -> Option<&'static str>

An optional description of the component.

fn preview(_window: &mut Window, _cx: &mut App) -> Option<AnyElement>

The component’s preview.

fn id() -> ComponentId

The component’s unique identifier.

fn status() -> ComponentStatus

The ready status of this component.

fn name() -> &'static str

The name of the component.

fn sort_name() -> &'static str

Returns a name that the component should be sorted by.

impl IntoElement for Table

type Element = Component<Table>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for Table

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.