UndoHistory builder

A history list that reports jump intents and changes no document state.

A builder is RenderOnce. Construct and mount it in one expression.

The verified undo-history scene in studio-dark

use gpui_kit::navigation::UndoHistory;

Reviewed in undo-history.

Construct

new(ident: impl Into<Ident>, label: impl Into<SharedString>) -> Self

Options

Chain onto the value.

entry(entry: HistoryEntry) -> Self
entries(entries: impl IntoIterator<Item = HistoryEntry>) -> Self
current(id: impl Into<SharedString>) -> Self
on_jump(handler: impl Fn(SharedString, &mut Window, &mut App) + 'static) -> Self

Example · undo-history

fn undo_history(_window: &mut Window, cx: &mut App) -> AnyElement {
    let theme = cx.theme().clone();
    stack(&theme)
        .w(px(520.0))
        .child(caption(
            &theme,
            "the caller owns every revision and whether it can be restored",
        ))
        .child(
            UndoHistory::new("scene.undo-history", "Document undo history")
                .entries([
                    HistoryEntry::new("opened", "Opened the fixture")
                        .description("The initial verified document")
                        .source("Fixture host")
                        .time("10:14"),
                    HistoryEntry::new("renamed", "Renamed the title")
                        .source("Alex")
                        .time("10:16"),
                    HistoryEntry::new("imported", "Imported archived blocks")
                        .description("The archive is no longer available")
                        .source("Archive")
                        .time("10:18")
                        .unavailable("This revision cannot be restored without the archive."),
                    HistoryEntry::new("current", "Reordered the summary")
                        .description("Current document")
                        .source("Alex")
                        .time("10:21"),
                    HistoryEntry::new("draft", "Drafted a new conclusion")
                        .source("Fixture host")
                        .time("10:23"),
                ])
                .current("current")
                .on_jump(|_, _, _| {}),
        )
        .into_any_element()
}

Source: crates/gpui-kit/src/navigation/undo_history.rs