Struct TextInput 

pub struct TextInput { /* private fields */ }

A single-line text field input. May be used as an evaluation for dependent form elements.

Examples

use tty_form::{
    step::CompoundStep,
    control::{Control, TextInput},
};

let mut step = CompoundStep::new();
TextInput::new("Enter your name:", false).add_to(&mut step);

Implementations

impl TextInput

pub fn new(prompt: &str, force_lowercase: bool) -> Self

Create a new text input control with the specified prompt and casing-rules.

Examples found in repository

examples/basic.rs (line 39)

fn execute() -> Result<String> {
    let mut form = Form::new();

    let mut commit_summary = CompoundStep::new();
    commit_summary.set_max_line_length(80);

    SelectInput::new(
        "Select the commit type.",
        vec![
            ("feat", "implemented a new feature"),
            ("bug", "fixed existing behavior"),
            ("docs", "added documentation"),
            ("chore", "non-source changes"),
        ],
    )
    .add_to(&mut commit_summary);

    let mut opening_paren = StaticText::new("(");
    let mut closing_paren = StaticText::new(")");

    let mut scope_input = TextInput::new("Enter the commit's scope.", true);

    let empty_scope = scope_input.set_evaluation(Evaluation::IsEmpty);
    opening_paren.set_dependency(empty_scope, Action::Hide);
    closing_paren.set_dependency(empty_scope, Action::Hide);

    let mut breaking_bang = StaticText::new("!");
    let colon = StaticText::new(": ");

    let description = TextInput::new("Enter the commit's description.", true);

    let mut long_description = TextBlockStep::new("Enter a long-form commit description.");
    long_description.set_margins(Some(1), Some(1));
    long_description.set_max_line_length(100);

    let mut breaking_step = YesNoStep::new(
        "Is this commit a breaking change?",
        "Enter a description of the breaking change.",
        "BREAKING CHANGE",
    );

    let trailers = KeyValueStep::new("Enter any key-value trailers, such as tickets.");

    let breaking_change = breaking_step.set_evaluation(Evaluation::Equal("Yes".to_string()));
    breaking_bang.set_dependency(breaking_change, Action::Show);

    opening_paren.add_to(&mut commit_summary);
    scope_input.add_to(&mut commit_summary);
    closing_paren.add_to(&mut commit_summary);
    breaking_bang.add_to(&mut commit_summary);
    colon.add_to(&mut commit_summary);
    description.add_to(&mut commit_summary);
    commit_summary.add_to(&mut form);
    long_description.add_to(&mut form);
    trailers.add_to(&mut form);
    breaking_step.add_to(&mut form);

    let mut stdout = stdout();
    let mut stdin = StdinDevice;

    let mut interface = Interface::new_relative(&mut stdout)?;

    let result = form.execute(&mut interface, &mut stdin);
    interface.exit()?;

    let mut output = String::new();
    match result {
        Ok(value) => output = value,
        Err(Error::Canceled) => println!("Form canceled."),
        Err(err) => eprintln!("Unexpected error occurred: {:?}", err),
    }

    Ok(output)
}

pub fn set_prompt(&mut self, prompt: &str)

Update this input’s prompt text.

pub fn set_force_lowercase(&mut self, force: bool)

Specify whether this input should force its value to be lowercase.

pub fn set_evaluation(&mut self, evaluation: Evaluation) -> DependencyId

Sets the dependency evaluation which other form elements can react to.

Examples found in repository

examples/basic.rs (line 41)

fn execute() -> Result<String> {
    let mut form = Form::new();

    let mut commit_summary = CompoundStep::new();
    commit_summary.set_max_line_length(80);

    SelectInput::new(
        "Select the commit type.",
        vec![
            ("feat", "implemented a new feature"),
            ("bug", "fixed existing behavior"),
            ("docs", "added documentation"),
            ("chore", "non-source changes"),
        ],
    )
    .add_to(&mut commit_summary);

    let mut opening_paren = StaticText::new("(");
    let mut closing_paren = StaticText::new(")");

    let mut scope_input = TextInput::new("Enter the commit's scope.", true);

    let empty_scope = scope_input.set_evaluation(Evaluation::IsEmpty);
    opening_paren.set_dependency(empty_scope, Action::Hide);
    closing_paren.set_dependency(empty_scope, Action::Hide);

    let mut breaking_bang = StaticText::new("!");
    let colon = StaticText::new(": ");

    let description = TextInput::new("Enter the commit's description.", true);

    let mut long_description = TextBlockStep::new("Enter a long-form commit description.");
    long_description.set_margins(Some(1), Some(1));
    long_description.set_max_line_length(100);

    let mut breaking_step = YesNoStep::new(
        "Is this commit a breaking change?",
        "Enter a description of the breaking change.",
        "BREAKING CHANGE",
    );

    let trailers = KeyValueStep::new("Enter any key-value trailers, such as tickets.");

    let breaking_change = breaking_step.set_evaluation(Evaluation::Equal("Yes".to_string()));
    breaking_bang.set_dependency(breaking_change, Action::Show);

    opening_paren.add_to(&mut commit_summary);
    scope_input.add_to(&mut commit_summary);
    closing_paren.add_to(&mut commit_summary);
    breaking_bang.add_to(&mut commit_summary);
    colon.add_to(&mut commit_summary);
    description.add_to(&mut commit_summary);
    commit_summary.add_to(&mut form);
    long_description.add_to(&mut form);
    trailers.add_to(&mut form);
    breaking_step.add_to(&mut form);

    let mut stdout = stdout();
    let mut stdin = StdinDevice;

    let mut interface = Interface::new_relative(&mut stdout)?;

    let result = form.execute(&mut interface, &mut stdin);
    interface.exit()?;

    let mut output = String::new();
    match result {
        Ok(value) => output = value,
        Err(Error::Canceled) => println!("Form canceled."),
        Err(err) => eprintln!("Unexpected error occurred: {:?}", err),
    }

    Ok(output)
}

Trait Implementations

impl Control for TextInput

fn focusable(&self) -> bool

Whether this control is a focusable input.

fn update(&mut self, input: KeyEvent)

Updates the control’s state from the given input event.

fn help(&self) -> Option<Segment>

This control’s descriptive help text, if available.

fn text(&self) -> (Segment, Option<u16>)

This control’s rendered contents and an optional offset for the cursor.

fn drawer(&self) -> Option<DrawerContents>

This control’s drawer contents, if available.

fn evaluation(&self) -> Option<(DependencyId, Evaluation)>

This control’s dependency evaluation which other controls may react to.

fn dependency(&self) -> Option<(DependencyId, Action)>

This control’s dependency which it may react to.

fn evaluate(&self, evaluation: &Evaluation) -> bool

Perform an evaluation against this control’s current state.

fn add_to(self, step: &mut CompoundStep)

Finish configuration and add this control to the specified form step.