Struct Textarea 

pub struct Textarea { /* private fields */ }

A multi-line text input prompt.

Implementations

impl Textarea

pub fn new(prompt: impl Into<String>) -> Self

Creates a multi-line prompt with the given label.

Examples found in repository

examples/prompt-readme.rs (line 84)

fn left_column() -> Rendered {
    vstack(
        &[
            Confirm::new("Deploy to production?").default_yes().frame(),
            blank(),
            TextInput::new("Service").initial("api-gateway").frame(),
            PasswordInput::new("Password").initial("hunter2").frame(),
            NumberInput::new("Replicas")
                .initial(3.0)
                .range(1.0, 10.0)
                .frame(),
            TextInput::new("Email")
                .placeholder("you@example.com")
                .frame(),
            TextInput::new("Region")
                .initial("eu-")
                .suggestions(["eu-central-1"])
                .frame(),
            blank(),
            Textarea::new("Notes")
                .initial("first line\nsecond line\nthird line")
                .frame(),
        ],
        0,
    )
}

examples/prompts.rs (line 56)

fn main() -> sparcli::Result<()> {
    footer_hint()?;

    let name = get!(
        TextInput::new("Your name?")
            .placeholder("e.g. Alice")
            .validate(non_empty())
            .run()?
    );

    let _username = get!(
        TextInput::new("Username?")
            .char_filter(alnum())
            .max_chars(16)
            .suggestions(["alice", "albert", "bob", "carol"])
            .history(["alice", "bob"])
            .run()?
    );

    let _password = get!(PasswordInput::new("Password?").mask("•").run()?);

    let age = get!(
        NumberInput::new("Age? (try `= 20 + 2`)")
            .range(0.0, 130.0)
            .calculator()
            .run()?
    );

    let _bio = get!(Textarea::new("Short bio (Ctrl-D to submit):").run()?);

    let color = get!(
        Select::new("Favorite color?")
            .options(["red", "green", "blue"])
            .run()?
    );

    let toppings = get!(
        Select::new("Pick toppings (Space to toggle):")
            .options(["cheese", "mushroom", "olive", "onion"])
            .multi()
            .run_multi()?
    );

    let _fruit = get!(pick_fruit()?);

    let date = get!(DatePicker::new("Pick a date:").run()?);

    let confirmed = matches!(
        Confirm::new("Save everything?")
            .default_yes()
            .labels("Save", "Discard")
            .run()?,
        Outcome::Submitted(true)
    );

    if confirmed {
        Alert::success(format!(
            "Saved {name}, age {age:.0}, color #{color}, {} toppings, \
             date {}-{:02}-{:02}.",
            toppings.len(),
            date.year,
            date.month,
            date.day,
        ))
        .print()?;
    } else {
        cancelled()?;
    }
    Ok(())
}

pub fn initial(self, value: impl Into<String>) -> Self

Sets the initial multi-line value.

Examples found in repository

examples/prompt-readme.rs (line 85)

fn left_column() -> Rendered {
    vstack(
        &[
            Confirm::new("Deploy to production?").default_yes().frame(),
            blank(),
            TextInput::new("Service").initial("api-gateway").frame(),
            PasswordInput::new("Password").initial("hunter2").frame(),
            NumberInput::new("Replicas")
                .initial(3.0)
                .range(1.0, 10.0)
                .frame(),
            TextInput::new("Email")
                .placeholder("you@example.com")
                .frame(),
            TextInput::new("Region")
                .initial("eu-")
                .suggestions(["eu-central-1"])
                .frame(),
            blank(),
            Textarea::new("Notes")
                .initial("first line\nsecond line\nthird line")
                .frame(),
        ],
        0,
    )
}

pub fn editor(self) -> Self

Enables opening the buffer in $EDITOR with Ctrl-G.

pub fn editor_command(self, command: impl Into<String>) -> Self

Sets the editor command (implies editor).

pub fn run(self) -> Result<Outcome<String>>

Runs the prompt on the real terminal.

Errors

Returns SparcliError::NoTerminal without an interactive terminal, or SparcliError::Io on a terminal failure.

Examples found in repository

examples/prompts.rs (line 56)

fn main() -> sparcli::Result<()> {
    footer_hint()?;

    let name = get!(
        TextInput::new("Your name?")
            .placeholder("e.g. Alice")
            .validate(non_empty())
            .run()?
    );

    let _username = get!(
        TextInput::new("Username?")
            .char_filter(alnum())
            .max_chars(16)
            .suggestions(["alice", "albert", "bob", "carol"])
            .history(["alice", "bob"])
            .run()?
    );

    let _password = get!(PasswordInput::new("Password?").mask("•").run()?);

    let age = get!(
        NumberInput::new("Age? (try `= 20 + 2`)")
            .range(0.0, 130.0)
            .calculator()
            .run()?
    );

    let _bio = get!(Textarea::new("Short bio (Ctrl-D to submit):").run()?);

    let color = get!(
        Select::new("Favorite color?")
            .options(["red", "green", "blue"])
            .run()?
    );

    let toppings = get!(
        Select::new("Pick toppings (Space to toggle):")
            .options(["cheese", "mushroom", "olive", "onion"])
            .multi()
            .run_multi()?
    );

    let _fruit = get!(pick_fruit()?);

    let date = get!(DatePicker::new("Pick a date:").run()?);

    let confirmed = matches!(
        Confirm::new("Save everything?")
            .default_yes()
            .labels("Save", "Discard")
            .run()?,
        Outcome::Submitted(true)
    );

    if confirmed {
        Alert::success(format!(
            "Saved {name}, age {age:.0}, color #{color}, {} toppings, \
             date {}-{:02}-{:02}.",
            toppings.len(),
            date.year,
            date.month,
            date.day,
        ))
        .print()?;
    } else {
        cancelled()?;
    }
    Ok(())
}

pub fn frame(&self) -> Rendered

Renders the prompt’s static frame without running it (for previews and README screenshots).

Examples found in repository

examples/prompt-readme.rs (line 86)

fn left_column() -> Rendered {
    vstack(
        &[
            Confirm::new("Deploy to production?").default_yes().frame(),
            blank(),
            TextInput::new("Service").initial("api-gateway").frame(),
            PasswordInput::new("Password").initial("hunter2").frame(),
            NumberInput::new("Replicas")
                .initial(3.0)
                .range(1.0, 10.0)
                .frame(),
            TextInput::new("Email")
                .placeholder("you@example.com")
                .frame(),
            TextInput::new("Region")
                .initial("eu-")
                .suggestions(["eu-central-1"])
                .frame(),
            blank(),
            Textarea::new("Notes")
                .initial("first line\nsecond line\nthird line")
                .frame(),
        ],
        0,
    )
}