Struct TextField 

pub struct TextField { /* private fields */ }

TextField — port of @heroui/text-field (v3).

The composition-friendly field: a label, an Input, and a description or validation message. Input is the bare control; TextField is the labelled wrapper most applications reach for.

Implementations

impl TextField

pub fn new(state: impl Borrow<Entity<InputState>>) -> Self

Builds the labelled field over state, borrowed or owned — see Input::new.

pub fn input_type(self, input_type: InputType) -> Self

type — the HTML input type, which v3 sets on the field and this port forwards to the inner Input.

pub fn label(self, text: impl Into<SharedString>) -> Self

Sets the visible label.

pub fn content( self, render: impl Fn(TextFieldRenderState) -> AnyElement + 'static, ) -> Self

v3’s field children-as-a-function, handed the complete resolved field state.

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

Sets the placeholder shown while the value is empty.

pub fn description(self, text: impl Into<SharedString>) -> Self

Sets the description text.

pub fn auto_focus(self, v: bool) -> Self

autoFocus — see Input::auto_focus.

pub fn name(self, name: impl Into<SharedString>) -> Self

name — see Input::name.

pub fn default_value(self, text: impl Into<SharedString>) -> Self

defaultValue — see Input::default_value.

pub fn value(self, text: impl Into<SharedString>) -> Self

value — see Input::value.

pub fn validation_behavior(self, behavior: ValidationBehavior) -> Self

validationBehavior — see crate::input::Input::validation_behavior.

pub fn validate( self, f: impl Fn(&str) -> Option<SharedString> + 'static, ) -> Self

validate — see Input::validate.

pub fn validation_errors( self, errors: impl IntoIterator<Item = impl Into<SharedString>>, ) -> Self

validationErrors — see Input::validation_errors.

pub fn error_message(self, text: impl Into<SharedString>) -> Self

Sets the error message shown when the field is invalid.

pub fn variant(self, variant: FieldVariant) -> Self

Sets the field variant.

pub fn full_width(self) -> Self

Makes the field fill its parent’s width.

pub fn height(self, h: impl Into<Pixels>) -> Self

The single-line box height — see Input::height.

pub fn padding_x(self, p: impl Into<Pixels>) -> Self

The box’s horizontal padding — see Input::padding_x.

pub fn recipe(self, name: impl Into<SharedString>) -> Self

Named theme recipe — see Input::recipe.

pub fn text_size(self, size: impl Into<Pixels>) -> Self

The field text size — see Input::text_size.

pub fn radius(self, r: impl Into<Pixels>) -> Self

The box’s corner radius — see Input::radius.

pub fn is_bare(self, v: bool) -> Self

Drops the field’s chrome — see Input::is_bare.

pub fn focus_ring(self, v: bool) -> Self

Shows or hides only the inner field’s visual focus ring — see Input::focus_ring.

pub fn font_family(self, family: impl Into<SharedString>) -> Self

The field text’s font family — see Input::font_family.

pub fn start_content(self, el: impl IntoElement) -> Self

Leading content inside the box — see Input::start_content.

pub fn is_disabled(self, v: bool) -> Self

Sets whether the field is disabled.

pub fn is_read_only(self, v: bool) -> Self

Sets whether the field is read-only.

pub fn is_required(self, v: bool) -> Self

Sets whether the field is required.

pub fn is_invalid(self, v: bool) -> Self

Sets whether the field is invalid.

pub fn on_change( self, handler: impl Fn(&str, &mut Window, &mut App) + 'static, ) -> Self

Sets the handler called with the new value whenever it changes.

pub fn on_submit( self, handler: impl Fn(&str, &mut Window, &mut App) + 'static, ) -> Self

Sets the handler called with the current value when Enter is pressed.

pub fn sx(self, style: impl FnOnce(Div) -> Div) -> Self

The one slot for caller-owned low-level styling: GPUI’s styling methods (bg, text_color, w, h, p, rounded, border_color, …) applied to the field’s root element after every value the variant and the active theme chose, so they win. The wrapper renders no element of its own, so the slot rides the inner Input and lands on that root.

Trait Implementations

impl Disableable for TextField

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

isDisabled — whether the component is disabled.

impl IntoElement for TextField

type Element = ViewElement<TextField>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for TextField

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.