Struct DiffConfig 

pub struct DiffConfig {

    pub added_bg: Color,
    pub added_fg: Color,
    pub removed_bg: Color,
    pub removed_fg: Color,
    pub hunk_header_bg: Color,
    pub hunk_header_fg: Color,
    pub line_number_fg: Color,
    pub show_line_numbers: bool,
    pub context_lines: usize,
    pub style: DiffStyle,
    pub gutter_width: u16,
    pub line_number_width: u16,
    pub sidebar_enabled: bool,
    pub sidebar_default_width: u16,
    pub sidebar_min_width: u16,
    pub sidebar_max_width: u16,
}

Configuration options for the CodeDiff widget.

Controls the visual appearance and behavior of the diff display, including colors for added/removed lines, line number visibility, context line count, and sidebar options.

Fields

• added_bg - Background color for added lines (default: dark green)
• removed_bg - Background color for removed lines (default: dark red)
• added_fg - Foreground color for added lines (default: green)
• removed_fg - Foreground color for removed lines (default: red)
• hunk_header_bg - Background color for hunk headers (default: dark gray)
• hunk_header_fg - Foreground color for hunk headers (default: cyan)
• line_number_fg - Foreground color for line numbers (default: dark gray)
• show_line_numbers - Whether to display line numbers (default: true)
• context_lines - Number of context lines to show around changes (default: 3)
• style - The diff display style (default: SideBySide)
• gutter_width - Width of the gutter for markers (default: 2)
• line_number_width - Width of line number columns (default: 4)
• sidebar_enabled - Whether the sidebar is enabled (default: false)
• sidebar_default_width - Default sidebar width as percentage (default: 25)
• sidebar_min_width - Minimum sidebar width as percentage (default: 10)
• sidebar_max_width - Maximum sidebar width as percentage (default: 50)

Fields

added_bg: Color

Background color for added lines.

added_fg: Color

Foreground color for added lines.

removed_bg: Color

Background color for removed lines.

removed_fg: Color

Foreground color for removed lines.

hunk_header_bg: Color

Background color for hunk header lines.

hunk_header_fg: Color

Foreground color for hunk header lines.

line_number_fg: Color

Foreground color for line numbers.

show_line_numbers: bool

Whether to show line numbers.

context_lines: usize

Number of context lines to show around changes.

style: DiffStyle

The diff display style.

gutter_width: u16

Width of the gutter column (for +/- markers).

line_number_width: u16

Width of line number columns.

sidebar_enabled: bool

Whether the sidebar file tree is enabled.

sidebar_default_width: u16

Default sidebar width as percentage (0-100).

sidebar_min_width: u16

Minimum sidebar width as percentage (0-100).

sidebar_max_width: u16

Maximum sidebar width as percentage (0-100).

Implementations

impl DiffConfig

pub fn new() -> Self

Creates a new diff configuration with default values.

Default colors are chosen to work well on both light and dark terminals:

• Added lines: dark green background, bright green foreground
• Removed lines: dark red background, bright red foreground
• Hunk headers: gray background, cyan foreground

Returns

A new DiffConfig with default settings

Example

use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new();
assert!(config.show_line_numbers);

impl DiffConfig

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

Sets the background color for added lines.

Arguments

• color - The background color to use

Returns

Self for method chaining

Example

use ratatui::style::Color;
use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().added_bg(Color::Green);

impl DiffConfig

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

Sets the foreground color for added lines.

Arguments

• color - The foreground color to use

Returns

Self for method chaining

Example

use ratatui::style::Color;
use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().added_fg(Color::LightGreen);

impl DiffConfig

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

Sets the number of context lines to show around changes.

Arguments

• lines - Number of context lines

Returns

Self for method chaining

Example

use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().context_lines(5);

impl DiffConfig

pub fn gutter_width(self, width: u16) -> Self

Sets the width of the gutter column.

The gutter displays the +/- markers for each line.

Arguments

• width - The gutter width in characters

Returns

Self for method chaining

Example

use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().gutter_width(3);

impl DiffConfig

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

Sets the background color for hunk header lines.

Arguments

• color - The background color to use

Returns

Self for method chaining

Example

use ratatui::style::Color;
use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().hunk_header_bg(Color::DarkGray);

impl DiffConfig

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

Sets the foreground color for hunk header lines.

Arguments

• color - The foreground color to use

Returns

Self for method chaining

Example

use ratatui::style::Color;
use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().hunk_header_fg(Color::Cyan);

impl DiffConfig

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

Sets the foreground color for line numbers.

Arguments

• color - The foreground color to use

Returns

Self for method chaining

Example

use ratatui::style::Color;
use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().line_number_fg(Color::Gray);

impl DiffConfig

pub fn line_number_width(self, width: u16) -> Self

Sets the width of line number columns.

Arguments

• width - The line number column width in characters

Returns

Self for method chaining

Example

use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().line_number_width(6);

impl DiffConfig

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

Sets the background color for removed lines.

Arguments

• color - The background color to use

Returns

Self for method chaining

Example

use ratatui::style::Color;
use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().removed_bg(Color::Red);

impl DiffConfig

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

Sets the foreground color for removed lines.

Arguments

• color - The foreground color to use

Returns

Self for method chaining

Example

use ratatui::style::Color;
use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().removed_fg(Color::LightRed);

impl DiffConfig

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

Sets whether to display line numbers.

Arguments

• show - Whether to show line numbers

Returns

Self for method chaining

Example

use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().show_line_numbers(false);

impl DiffConfig

pub fn sidebar_default_width(self, width: u16) -> Self

Sets the default sidebar width as a percentage (0-100).

This is the initial width when the widget is created. The width can be adjusted at runtime with resize methods.

Arguments

• width - The default width as percentage (clamped to min/max)

Returns

The modified configuration for method chaining

Example

use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().sidebar_default_width(30);
assert_eq!(config.sidebar_default_width, 30);

impl DiffConfig

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

Sets whether the sidebar file tree is enabled.

When enabled, the CodeDiff widget will display a file tree sidebar showing all files in a multi-file diff. The [ key toggles visibility.

Arguments

• enabled - Whether to enable the sidebar

Returns

The modified configuration for method chaining

Example

use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().sidebar_enabled(true);
assert!(config.sidebar_enabled);

impl DiffConfig

pub fn sidebar_max_width(self, width: u16) -> Self

Sets the maximum sidebar width as a percentage (0-100).

The sidebar cannot be resized larger than this value.

Arguments

• width - The maximum width as percentage

Returns

The modified configuration for method chaining

Example

use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().sidebar_max_width(40);
assert_eq!(config.sidebar_max_width, 40);

impl DiffConfig

pub fn sidebar_min_width(self, width: u16) -> Self

Sets the minimum sidebar width as a percentage (0-100).

The sidebar cannot be resized smaller than this value.

Arguments

• width - The minimum width as percentage

Returns

The modified configuration for method chaining

Example

use ratatui_toolkit::code_diff::DiffConfig;

let config = DiffConfig::new().sidebar_min_width(15);
assert_eq!(config.sidebar_min_width, 15);

impl DiffConfig

pub fn style(self, style: DiffStyle) -> Self

Sets the diff display style.

Arguments

• style - The display style to use

Returns

Self for method chaining

Example

use ratatui_toolkit::code_diff::{DiffConfig, DiffStyle};

let config = DiffConfig::new().style(DiffStyle::Unified);

Trait Implementations

impl Clone for DiffConfig

fn clone(&self) -> DiffConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiffConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DiffConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for DiffConfig

fn eq(&self, other: &DiffConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DiffConfig

impl StructuralPartialEq for DiffConfig