Struct DiffView 

pub struct DiffView { /* private fields */ }

A diff view widget with selectable rendering backends.

Implementations

impl DiffView

pub fn new() -> Self

Create a new, empty diff view.

pub fn before(self, before: impl Into<Arc<str>>) -> Self

Set the “before” content of the diff.

pub fn after(self, after: impl Into<Arc<str>>) -> Self

Set the “after” content of the diff.

pub fn patch(self, patch: impl Into<Arc<str>>) -> Self

Set the diff content from a raw unified diff (patch) string.

pub fn with_content( before: impl Into<Arc<str>>, after: impl Into<Arc<str>>, ) -> Self

Create a diff view for the given before/after text.

pub fn from_patch(patch: impl Into<Arc<str>>) -> Self

Create a diff view from a raw unified diff (patch) string.

This constructor is useful when you have a pre-computed patch (e.g. from git or an API) and want to display it with DiffView colors and formatting.

pub fn backend(self, backend: DiffViewBackend) -> Self

Set rendering backend explicitly.

Not required in most cases: calling Self::text_area or Self::document_view also infers backend when this isn’t set.

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

Enable/disable editing when using the TextArea backend.

This flag is ignored by the DocumentView backend.

pub fn scroll_offset(self, offset: usize) -> Self

Set controlled vertical scroll offset for rendered pane(s).

pub fn scroll_to_hunk(self, index: usize) -> Self

Scroll rendered pane(s) to the first visible row for a parsed patch hunk.

index is zero-based patch order. The target is resolved after indentation trimming and context collapse, then delegated to the active backend so soft wrapping maps to the final visual row during layout. A controlled Self::scroll_offset takes precedence if both are set.

pub fn on_scroll(self, cb: Callback<DiffScrollEvent>) -> Self

Receive pane-aware scroll events from rendered pane(s).

pub fn on_context_separator_click( self, cb: Callback<DiffContextSeparatorEvent>, ) -> Self

Set the callback fired when a visible context separator is clicked.

Use Self::expanded_contexts with the clicked event’s range on the next render to expand the hidden lines represented by that separator.

pub fn context_separator_hover_style(self, style: Style) -> Self

Set the style patched over a context separator while the pointer hovers it.

pub fn mode(self, mode: DiffViewMode) -> Self

Set the diff presentation mode.

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

Override the outer diff view width.

pub fn height(self, height: impl Into<Length>) -> Self

Override the outer diff view height.

pub fn text_area(self, text_area: TextArea) -> Self

Provide a base TextArea configuration.

When backend is not explicitly set, this also selects the TextArea backend.

pub fn document_view(self, document_view: DocumentView) -> Self

Provide a base DocumentView configuration.

When backend is not explicitly set, this also selects the DocumentView backend.

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

Enable/disable wrapping in both backends.

pub fn line_numbers(self, show: bool) -> Self

Enable/disable line numbers in both backends.

pub fn min_line_number_width(self, width: u8) -> Self

Set minimum line-number digit width in both backends.

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

Show or hide an outer border around the whole DiffView.

pub fn panels_border(self, border: bool) -> Self

Show or hide per-pane borders in split/unified pane wrappers.

pub fn highlight_full_width(self, enabled: bool) -> Self

Highlight changed-line backgrounds to full row width.

pub fn scrollbar(self, show: bool) -> Self

Show or hide vertical scrollbars in both backends.

pub fn gutter_inset(self, inset: u16) -> Self

Reserve empty cells before the gutter / line numbers in both backends.

pub fn h_scrollbar(self, show: bool) -> Self

Show or hide horizontal scrollbars in both backends.

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

Control focusability in both backends.

pub fn single_scrollbar(self, enabled: bool) -> Self

In split mode, render a single vertical scrollbar on the right pane only.

pub fn join_frame(self, join: bool) -> Self

Join pane frames when adjacent (uses Frame::join_frame).

pub fn vertical_separator(self, enabled: bool) -> Self

Show a vertical separator between split panes.

pub fn vertical_separator_char(self, ch: char) -> Self

Set the split-pane vertical separator character.

pub fn vertical_separator_style(self, style: Style) -> Self

Set style for the split-pane vertical separator.

pub fn diff_style(self, style: DiffPalette) -> Self

Configure diff line and word styles.

pub fn neutral_bg(self, color: Color) -> Self

Set background color for unchanged/context lines.

Note: split filler lines (DiffLineKind::Empty) are not affected.

pub fn shared_selection_id(self, id: impl Into<Arc<str>>) -> Self

Enable cross-widget drag selection for this diff view’s internal panels.

In unified mode the id is used as-is on the single panel. In split mode the id is suffixed with :left and :right so that only same-side panels share selection across multiple DiffViews.

Multiple DiffViews (and plain DocumentViews) under the same ScrollView that share the same id participate in unified drag selection and copy.

pub fn prefixes(self, prefixes: DiffPrefixes) -> Self

Configure diff prefixes.

pub fn show_prefixes(self, show: bool) -> Self

Toggle prefix rendering.

pub fn word_diff(self, enabled: bool) -> Self

Toggle word-level diff highlighting.

pub fn trim_common_indent(self, enabled: bool) -> Self

Trim shared leading indentation from diff line content.

When enabled (the default), DiffView computes the smallest common leading indent across visible non-empty diff lines and removes that many leading spaces/tabs from line content before rendering. In split mode, both panes share the same trim amount so rows stay aligned.

pub fn context_lines(self, n: usize) -> Self

Set the number of unchanged context lines to keep around each change.

When set, unchanged regions farther than n lines from any change are collapsed into a single separator line. The default (None) shows all lines.

DiffView::with_content(before, after).context_lines(4)

pub fn show_context_separator(self, show: bool) -> Self

Show or hide the placeholder separator line when collapsing context.

When true (the default) a context separator line is rendered in place of each collapsed region. When false the hidden lines are simply omitted without any visual placeholder. Only meaningful when Self::context_lines is set.

pub fn context_separator_text(self, text: impl Into<Arc<str>>) -> Self

Set the template text used for context separators.

Supported placeholders:

• {count}: number of hidden lines
• {line_word}: line or lines
• {direction}: above, below, or between
• {arrow}: ↑, ↓, or ↑↓

pub fn context_separator_min_lines(self, min_lines: usize) -> Self

Minimum number of hidden lines required before a context separator is shown.

Shorter collapsed runs render as normal context lines instead of a separator placeholder (default: 2).

pub fn context_expand_lines(self, lines: usize) -> Self

Default number of hidden lines revealed per context-separator click.

This value is included in DiffContextSeparatorEvent and used by DiffContextSeparatorEvent::next_expansion (default: 20).

pub fn expanded_contexts( self, ranges: impl IntoIterator<Item = DiffContextRange>, ) -> Self

Set collapsed context ranges that should render fully expanded.

Pass ranges received from DiffContextSeparatorEvent::range to turn individual separators back into their hidden lines. This is controlled by the app so expansion state survives normal component rerenders.

pub fn expanded_context_expansions( self, expansions: impl IntoIterator<Item = DiffContextExpansion>, ) -> Self

Set controlled partial or full context expansions.

pub fn expanded_context(self, range: DiffContextRange) -> Self

Expand one collapsed context range fully.

pub fn expanded_context_lines( self, range: DiffContextRange, lines_revealed: usize, ) -> Self

Expand one collapsed context range by a specific number of lines.

pub fn base_color_strategy( self, strategy: impl TextAreaColorStrategy + 'static, ) -> Self

Provide a base color strategy (syntax highlighting).

Applied to both backends:

• TextArea backend via TextArea::color_strategy
• DocumentView backend via the internal diff formatter

pub fn language(self, language: impl Into<Arc<str>>) -> Self

Set the language identifier for syntax strategies.

pub fn language_from_path(self, path: impl AsRef<Path>) -> Self

Set language identifier by resolving from a file path’s extension or name.

Uses the default syntect syntax definitions. If no syntax matches the path, the language remains unset (plain text fallback). TypeScript/TSX paths fall back to JavaScript/JSX-compatible syntaxes when the default set does not provide exact grammars.

pub fn theme(self, theme: impl Into<Arc<str>>) -> Self

Set the theme identifier for syntax strategies.

pub fn with_syntax( self, language: impl Into<Arc<str>>, theme: impl Into<Arc<str>>, ) -> Self

Enable syntect-based syntax highlighting.

pub fn with_syntax_bg( self, language: impl Into<Arc<str>>, theme: impl Into<Arc<str>>, ) -> Self

Enable syntect-based syntax highlighting with background colors.

pub fn with_diff(self, data: DiffData) -> Self

Use precomputed diff data.

pub fn with_shared_diff(self, data: Arc<DiffData>) -> Self

Use shared precomputed diff data.

Trait Implementations

impl Clone for DiffView

fn clone(&self) -> DiffView

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for DiffView

fn default() -> Self

Returns the “default value” for a type.

impl From<DiffView> for Element

fn from(view: DiffView) -> Self

Converts to this type from the input type.