Struct TextField 

pub struct TextField { /* private fields */ }

A single-line text input bound to a String.

Supports typing, deleting, moving by character, word and line, selecting with Shift, the mouse (drag, double-click) or Cmd/Ctrl+A, copy, cut and paste, and Enter (submit). Passwords can be pasted but not copied.

use ravenrs_reactive::State;
use ravenrs_widgets::{IconName, TextField, Ui};

let query = State::new(String::new());
let field = TextField::new(query.binding()).placeholder("Search").icon(IconName::Search).clearable();
let mut ui = Ui::new(field, ravenrs_style::Theme::raven_dark());
ui.update();

Implementations

impl TextField

pub fn new(value: Binding<String>) -> Self

An empty-placeholder field bound to value.

pub fn placeholder(self, text: impl Into<String>) -> Self

Muted text shown while the value is empty.

pub fn icon(self, icon: IconName) -> Self

An icon inside the field, before the text.

pub fn secure(self) -> Self

Shows dots instead of the characters (passwords).

pub fn width(self, width: f32) -> Self

Fixed width in logical pixels; by default the field stretches.

pub fn compact(self) -> Self

A shorter field with smaller text, for toolbars, filter rows and cells: the same as Self::size with ButtonSize::Small.

pub fn size(self, size: ButtonSize) -> Self

Sets the height and text size to line up with a Button of the same size (Medium by default). The smaller ones have no minimum width.

pub fn prefix(self, view: impl View + 'static) -> Self

Any view inside the field, before the text, such as a currency or a unit.

pub fn suffix(self, view: impl View + 'static) -> Self

Any view inside the field, after the text, such as a unit or a button.

pub fn clearable(self) -> Self

A button inside the field that empties it, shown while there is text to clear. The keyboard comes back to the field afterwards.

pub fn flat(self) -> Self

No box of its own until it is pointed at or focused, filling what it is in, for fields that line up with what is around them, as under the columns of a grid.

pub fn end_aligned(self) -> Self

Puts the text at the end of the field, as under a column of numbers.

pub fn autofocus(self) -> Self

Takes keyboard focus when it first appears.

pub fn select_on_open(self) -> Self

Starts with all of its text selected, so that typing replaces it.

pub fn on_cancel(self, handler: impl Fn() + 'static) -> Self

Called when Escape is pressed while the field is focused.

pub fn intercept_keys(self, handler: KeyHandler) -> Self

Sees keys before the field edits; return true to consume them (lists navigated from a search field use it for arrows and Enter).

pub fn on_submit(self, handler: impl Fn(String) + 'static) -> Self

Called with the current text when Enter is pressed.

pub fn on_leave(self, handler: impl Fn() + 'static) -> Self

Called when the keyboard goes elsewhere after being here.

pub fn disabled(self, disabled: bool) -> Self

Turns the control off: it fades, leaves the tab order and ignores input.

pub fn read_only(self, read_only: bool) -> Self

Shows the value without letting it change; it can still be focused, selected and copied.

Trait Implementations

impl Debug for TextField

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

Formats the value using the given formatter.

impl View for TextField

fn build(&self, cx: &mut BuildCx<'_>) -> NodeId

Creates this view’s node for the current build.

fn type_name(&self) -> &'static str

The name the diagnostics panel shows this view’s cost under.