tui-rule

Crates.iotui-rule
lib.rstui-rule
version0.1.2
created_at2025-03-30 16:39:53.437947+00
updated_at2025-04-05 18:46:46.98593+00
descriptiona pretty rule widget for ratatui
homepage
repository
max_upload_size
id1612551
size73,844
F - 77777 (F-77777)

documentation

README

tui-rule,

A pretty rule widget using colorgrad

Info:

A terminal representation of html's <hr> tag in the form of a widget.
Uses colorgrad for gradients.

Note:

  • Rules are automatically fitted inside the provided area to avoid being rendered over blocks

See CHANGELOG.md for more info

Horizontal rule with margin + gradient

    let block = Block::bordered();
    let rule = Rule::from_set(
            presets::test_sets::HORIZONTAL
        )
        .with_gradient(colorgrad::preset::warm())
        .horizontal_padding(4);
    f.render_widget(rule, f.area());
    f.render_widget(block, f.area());

Horizontal Gradient

Vertical rule with margin + gradient

    let block = Block::bordered();
    let rule = Rule::from_set(
            presets::test_sets::VERTICAL,
        )
        .with_gradient(colorgrad::preset::warm())
        .vertical()
        .vertical_padding(1);
        f.render_widget(rule, f.area());
        f.render_widget(block, f.area());

Vertical Gradient

Rules without gradients are also supported

    let block = Block::bordered();
    
    let rule_vert = Rule::from_set(
            presets::test_sets::VERTICAL
        )
        .horizontal_alignment(Alignment::Left)
        .vertical()
        .horizontal_padding(4)
        .vertical_padding(1);
    let rule_hor = Rule::from_set(
            presets::test_sets::HORIZONTAL
        )
        .horizontal_padding(6);
    f.render_widget(rule_hor, f.area());
    f.render_widget(rule_vert, f.area());
    f.render_widget(block, f.area());

No gradient

See PRESET_EXAMPLES.md for more examples

Commit count: 0

cargo fmt