Struct FooterWidgets 

pub struct FooterWidgets { /* private fields */ }

A group of Widgets consisting of a StatusLine, PromptLine and Notifications combo

These are the default Widgets placed in the footer position of Duat. By default, they will be placed around the window, but they can also be placed around individual Buffers:

setup_duat!(setup);
use duat::prelude::*;

fn setup() {
    hook::add::<BufferOpened>(|pa, handle| {
        FooterWidgets::new(status!(
            "{name_txt}{Spacer}{} {sels_txt} {main_txt}",
            mode_txt()
        ))
        .push_on(pa, handle);
    });
}

This specific Widget configuration makes use of hooks in order to show the PromptLine only when it is in focus, showing Notifications whenever that is not the case. Like Vim/Neovim, it also takes up two lines on the screen, one for the StatusLine and one for the other two Widgets.

If you want a Kakoune-like one line footer, use the one_line method. You can also use the prompt and notifs methods in order to specify the PromptLine and Notifications Widgets, respectively.

Additionally, you can call the above method in order to place the footer as a header instead.

Implementations

impl FooterWidgets

pub fn push_on(self, pa: &mut Pass, push_target: &impl PushTarget)

Adds footer Widgets

pub fn new(status_cfg: StatusLineFmt) -> Self

Returns a new FooterWidgets, with a StatusLine and default PromptLine and Notifications

You can set those other two through the prompt and notifs methods.

pub fn one_line(self) -> Self

Turns this footer into a Kakoune-like one liner, as opposed to a Neovim-like two liner

pub fn above(self) -> Self

Changes this footer to a header

pub fn prompt(self, prompt: PromptLineBuilder) -> Self

Sets the PromptLine to be used

pub fn notifs(self, notifs: NotificationsOpts) -> Self

Sets the Notifications to be used

Trait Implementations

impl Default for FooterWidgets

fn default() -> Self

Returns the “default value” for a type.