Struct LiveGrid 

pub struct LiveGrid<D: LiveGridDelegate> { /* private fields */ }

A live grid element over a LiveGridState.

LiveGrid::new(&grid)
    .accessibility_label("Trades")
    .xsmall()
    .bordered(false)
    .group_panel(true)

Sizes follow gpui-kit tables: xsmall 26 px rows, small 30, medium (default) 32, large 40, or an explicit Size::Size(px).

The cells take the font of the element the grid is placed in: its family, size and OpenType features, and so do the ghosts its drags show under the pointer (a header, a group level, rows), though GPUI draws them outside that element. The grid adds tabular figures (tnum) so digits line up, and keeps the rest, so a feature set on an ancestor reaches the cells:

div()
    .font_family("IBM Plex Mono")
    // A slashed zero in every cell.
    .font_features(FontFeatures(Arc::new(vec![("zero".into(), 1)])))
    .child(LiveGrid::new(&grid))

Give every grid an accessible name with Self::accessibility_label: a screen reader announces the grid by it (Design Guides, “controls have accessible names”).

Implementations

impl<D: LiveGridDelegate> LiveGrid<D>

pub fn new(state: &Entity<LiveGridState<D>>) -> Self

A grid element for state.

pub fn accessibility_label(self, label: impl Into<SharedString>) -> Self

The accessible name of the grid, e.g. “Trades”: a screen reader names the table by it. No name by default.

pub fn bordered(self, bordered: bool) -> Self

Draws a border with the theme radius around the grid (default true).

pub fn group_panel(self, shown: bool) -> Self

Shows the group panel above the header (default false): the grouping levels as chips, and a drop zone for column headers. The user drags a header into it to group by the column, drags a chip to reorder the levels or out onto the grid to remove one, clicks a chip to reverse its groups, and removes it with its button. The panel is one header row tall; the rows get that much less room.

The application decides when it shows, as with Self::bordered: always, only while the grid is grouped, or behind a toolbar toggle.

Trait Implementations

impl<D: LiveGridDelegate> IntoElement for LiveGrid<D>

type Element = ViewElement<LiveGrid<D>>

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<D: LiveGridDelegate> RenderOnce for LiveGrid<D>

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.

impl<D: LiveGridDelegate> Sizable for LiveGrid<D>

fn with_size(self, size: impl Into<Size>) -> Self

Set the ui::Size of this element.

fn xsmall(self) -> Self

Set to Size::XSmall

fn small(self) -> Self

Set to Size::Small

fn large(self) -> Self

Set to Size::Large