Form
Form lays out typed fields and an optional footer. The application owns values, validation, submission, and responsive column choices.
Import
use gpui_kit::component::form::{field, v_form, h_form, Form, Field};Predictable composition
Form::new() defaults to one column with labels above controls. label_layout(Axis::Horizontal) places labels beside controls; columns(2) independently creates two field columns. Existing horizontal(), vertical(), layout(Axis), h_form(), and v_form() remain available.
Form::new()
.label_layout(Axis::Horizontal)
.columns(2)
.child(Field::new().label("Name").child(Input::new(&name_input)))
.child(Field::new().label("Email").child(Input::new(&email_input)))
.footer(Button::new("save").label("Save"))child accepts a Field. Put commands in footer, which spans all columns and aligns its content to the trailing edge. Attach submission behavior to the supplied Button; Form does not submit automatically. See the complete application recipe for retained state, callbacks, and window setup.
Usage
Basic Form
v_form()
.child(
field()
.label("Name")
.child(Input::new(&name_input))
)
.child(
field()
.label("Email")
.child(Input::new(&email_input))
.required(true)
)Horizontal Form Layout
h_form()
.label_width(px(120.))
.child(
field()
.label("First Name")
.child(Input::new(&first_name))
)
.child(
field()
.label("Last Name")
.child(Input::new(&last_name))
)Multi-Column Form
v_form()
.columns(2) // Two-column layout
.child(
field()
.label("First Name")
.child(Input::new(&first_name))
)
.child(
field()
.label("Last Name")
.child(Input::new(&last_name))
)
.child(
field()
.label("Bio")
.col_span(2) // Span across both columns
.child(Input::new(&bio_input))
)Form Container and Layout
Vertical Layout (Default)
v_form()
.gap(px(12.))
.child(field().label("Name").child(input))
.child(field().label("Email").child(email_input))Horizontal Layout
h_form()
.label_width(px(100.))
.child(field().label("Name").child(input))
.child(field().label("Email").child(email_input))Custom Sizing
v_form()
.large() // Large form size
.label_text_size(rems(1.2))
.child(field().label("Title").child(input))
v_form()
.small() // Small form size
.child(field().label("Code").child(input))Form Validation
Required Fields
field()
.label("Email")
.required(true) // Shows asterisk (*) next to label
.child(Input::new(&email_input))Field Descriptions
field()
.label("Password")
.description("Must be at least 8 characters long")
.child(Input::new(&password_input))Dynamic Descriptions
field()
.label("Bio")
.description_fn(|_, _| {
div().child("Use at most 100 words to describe yourself.")
})
.child(Input::new(&bio_input))Field Visibility
field()
.label("Admin Settings")
.visible(user.is_admin()) // Conditionally show field
.child(Switch::new("admin-mode"))Submit Handling
Basic Submit Pattern
struct FormView {
name_input: Entity<InputState>,
email_input: Entity<InputState>,
}
impl FormView {
fn submit(&mut self, cx: &mut Context<Self>) {
let name = self.name_input.read(cx).value();
let email = self.email_input.read(cx).value();
// Validate inputs
if name.is_empty() || email.is_empty() {
// Show validation error
return;
}
// Submit form data
self.handle_submit(name, email, cx);
}
}
// Form with submit button
v_form()
.child(field().label("Name").child(Input::new(&self.name_input)))
.child(field().label("Email").child(Input::new(&self.email_input)))
.child(
field()
.label_indent(false)
.child(
Button::new("submit")
.primary()
.child("Submit")
.on_click(cx.listener(|this, _, _, cx| this.submit(cx)))
)
)Form with Action Buttons
v_form()
.child(field().label("Title").child(Input::new(&title)))
.child(field().label("Content").child(Input::new(&content)))
.child(
field()
.label_indent(false)
.child(
h_flex()
.gap_2()
.child(Button::new("save").primary().child("Save"))
.child(Button::new("cancel").child("Cancel"))
.child(Button::new("preview").outline().child("Preview"))
)
)Field Groups
Related Fields
v_form()
.child(
field()
.label("Name")
.child(
h_flex()
.gap_2()
.child(div().flex_1().child(Input::new(&first_name)))
.child(div().flex_1().child(Input::new(&last_name)))
)
)
.child(
field()
.label("Address")
.items_start() // Align to start for multi-line content
.child(
v_flex()
.gap_2()
.child(Input::new(&street))
.child(
h_flex()
.gap_2()
.child(div().flex_1().child(Input::new(&city)))
.child(div().w(px(100.)).child(Input::new(&zip)))
)
)
)Custom Field Components
field()
.label("Theme Color")
.child(ColorPicker::new(&color_state).small())
field()
.label("Birth Date")
.description("We'll send you a birthday gift!")
.child(DatePicker::new(&date_state))
field()
.label("Notifications")
.child(
v_flex()
.gap_2()
.child(Switch::new("email").label("Email notifications"))
.child(Switch::new("push").label("Push notifications"))
.child(Switch::new("sms").label("SMS notifications"))
)Conditional Fields
v_form()
.child(
field()
.label("Account Type")
.child(Select::new(&account_type))
)
.child(
field()
.label("Company Name")
.visible(is_business_account) // Show only for business accounts
.child(Input::new(&company_name))
)
.child(
field()
.label("Tax ID")
.visible(is_business_account)
.required(is_business_account)
.child(Input::new(&tax_id))
)Grid Layout and Positioning
Column Spanning
v_form()
.columns(3) // Three-column grid
.child(field().label("First").child(input1))
.child(field().label("Second").child(input2))
.child(field().label("Third").child(input3))
.child(
field()
.label("Full Width")
.col_span(3) // Spans all three columns
.child(Input::new(&full_width))
)Column Positioning
v_form()
.columns(4)
.child(field().label("A").child(input_a))
.child(field().label("B").child(input_b))
.child(
field()
.label("Positioned")
.col_start(1) // Start at column 1
.col_span(2) // Span 2 columns
.child(input_positioned)
)Responsive Layout
v_form()
.columns(if is_mobile { 1 } else { 2 })
.child(field().label("Name").child(name_input))
.child(field().label("Email").child(email_input))
.child(
field()
.label("Bio")
.when(!is_mobile, |field| field.col_span(2))
.child(bio_input)
)Examples
User Registration Form
struct RegistrationForm {
first_name: Entity<InputState>,
last_name: Entity<InputState>,
email: Entity<InputState>,
password: Entity<InputState>,
confirm_password: Entity<InputState>,
terms_accepted: bool,
}
impl Render for RegistrationForm {
fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
v_form()
.large()
.child(
field()
.label("Personal Information")
.label_indent(false)
.child(
h_flex()
.gap_3()
.child(
div().flex_1().child(
Input::new(&self.first_name)
.placeholder("First name")
)
)
.child(
div().flex_1().child(
Input::new(&self.last_name)
.placeholder("Last name")
)
)
)
)
.child(
field()
.label("Email")
.required(true)
.child(Input::new(&self.email))
)
.child(
field()
.label("Password")
.required(true)
.description("Must be at least 8 characters")
.child(Input::new(&self.password))
)
.child(
field()
.label("Confirm Password")
.required(true)
.child(Input::new(&self.confirm_password))
)
.child(
field()
.label_indent(false)
.child(
Checkbox::new("terms")
.label("I agree to the Terms of Service")
.checked(self.terms_accepted)
.on_click(cx.listener(|this, checked, _, cx| {
this.terms_accepted = *checked;
cx.notify();
}))
)
)
.child(
field()
.label_indent(false)
.child(
Button::new("register")
.primary()
.large()
.w_full()
.child("Create Account")
)
)
}
}Settings Form with Sections
v_form()
.column(2)
.child(
field()
.label("Profile")
.label_indent(false)
.col_span(2)
.child(Separator::horizontal())
)
.child(
field()
.label("Display Name")
.child(Input::new(&display_name))
)
.child(
field()
.label("Email")
.child(Input::new(&email))
)
.child(
field()
.label("Bio")
.col_span(2)
.items_start()
.child(Input::new(&bio))
)
.child(
field()
.label("Preferences")
.label_indent(false)
.col_span(2)
.child(Separator::horizontal())
)
.child(
field()
.label("Theme")
.child(Select::new(&theme_state))
)
.child(
field()
.label("Language")
.child(Select::new(&language_state))
)
.child(
field()
.label_indent(false)
.child(Switch::new("notifications").label("Enable notifications"))
)
.child(
field()
.label_indent(false)
.child(Switch::new("marketing").label("Marketing emails"))
)Contact Form
v_form()
.child(
field()
.label("Contact Information")
.child(
h_flex()
.gap_2()
.child(
Select::new(&prefix_state)
.w(px(80.))
)
.child(
div().flex_1().child(
Input::new(&name_input)
.placeholder("Your name")
)
)
)
)
.child(
field()
.label("Email")
.required(true)
.child(Input::new(&email_input))
)
.child(
field()
.label("Subject")
.child(Select::new(&subject_state))
)
.child(
field()
.label("Message")
.required(true)
.items_start()
.description("Please describe your inquiry in detail")
.child(Input::new(&message_input))
)
.child(
field()
.label_indent(false)
.child(
h_flex()
.gap_2()
.justify_between()
.child(
Checkbox::new("copy")
.label("Send me a copy")
)
.child(
h_flex()
.gap_2()
.child(Button::new("cancel").child("Cancel"))
.child(Button::new("send").primary().child("Send Message"))
)
)
)Documentation license: original prose and illustrations for which GPUI Kit holds licensing rights are also offered under CC BY 4.0. When copying or adapting, credit GPUI Kit, link the source (https://gpui-kit.com/component/form) and https://creativecommons.org/licenses/by/4.0/, and indicate changes. Code examples and software source use Apache-2.0; third-party material retains its terms; existing Apache-2.0 permissions remain.
Bundled from GPUI Kit. Documentation prose: CC BY 4.0; code examples: Apache-2.0. Changes: documentation links localized, asset URLs made absolute, and this attribution added.