Package org.patternfly.component.form

package org.patternfly.component.form

Provides form components for building structured data entry interfaces.

This package contains the Form component and its sub-components for creating accessible, validated forms. Forms organize input controls into groups with labels, helper text, and validation feedback. The package includes text inputs, text areas, form selects, checkboxes, and radio buttons.

Components

• Form - Top-level form container
• FormGroup - Groups a label with a control and helper text
• FormGroupLabel - Label for a form group
• FormGroupControl - Control area within a form group
• FormSection - Groups related form groups under a heading
• FormActionGroup - Contains form action buttons (submit, cancel)
• FormAlert - Displays an alert within a form
• FormFieldGroup - Nestable field group with header and body
• TextInput - Single-line text input
• TextArea - Multi-line text input
• FormSelect - Native select dropdown
• Checkbox - Checkbox control
• Radio - Radio button control

Usage

A basic form with text inputs, checkboxes, and action buttons:

import static org.patternfly.component.button.Button.button;
import static org.patternfly.component.form.Checkbox.checkbox;
import static org.patternfly.component.form.Form.form;
import static org.patternfly.component.form.FormActionGroup.formActionGroup;
import static org.patternfly.component.form.FormGroup.formGroup;
import static org.patternfly.component.form.FormGroupControl.formGroupControl;
import static org.patternfly.component.form.FormGroupLabel.formGroupLabel;
import static org.patternfly.component.form.FormGroupRole.radiogroup;
import static org.patternfly.component.form.Radio.radio;
import static org.patternfly.component.form.TextInput.textInput;
import static org.patternfly.component.form.TextInputType.email;
import static org.patternfly.component.help.HelperText.helperText;

Form form = form()
        .addGroup(formGroup("name").required()
                .addLabel(formGroupLabel("Full name"))
                .addControl(formGroupControl()
                        .addControl(textInput("name"))
                        .addHelperText(helperText("Include your middle name if you have one."))))
        .addGroup(formGroup("email").required()
                .addLabel(formGroupLabel("Email"))
                .addControl(formGroupControl()
                        .addControl(textInput(email, "email"))))
        .addGroup(formGroup("timezone").role(radiogroup)
                .addLabel(formGroupLabel("Timezone"))
                .addControl(formGroupControl().inline()
                        .addRadio(radio("tz-0", "timezone", "Eastern"))
                        .addRadio(radio("tz-1", "timezone", "Central"))
                        .addRadio(radio("tz-2", "timezone", "Pacific"))))
        .addActionGroup(formActionGroup()
                .addButton(button("Submit").primary())
                .addButton(button("Cancel").link()));

See Also:

• PatternFly Form
• PatternFly Text Input
• PatternFly Checkbox
• PatternFly Radio

Related Packages

Package	Description
org.patternfly.component	Provides PatternFly component implementations for building web applications in Java.

Class	Description
Checkbox	A checkbox is used to select a single item or multiple items, typically to choose elements to perform an action or to reflect a binary setting.
CheckboxBody
CheckboxDescription
Form	A form is a group of elements used to collect information from a user in a variety of contexts, including in a modal, in a wizard, or on a page.
FormActionGroup
FormAlert
FormControl<E extends HTMLElement, B extends BaseComponent<E,B>>
FormFieldGroup
FormFieldGroupBody
FormFieldGroupHeader
FormGroup
FormGroupControl
FormGroupLabel
FormGroupRole
FormSection
FormSelect	A form select embeds browser native select lists into a form.
FormSelectOption
FormSelectOptionGroup
Radio	A radio button is used to present the user with mutually exclusive choices.
RadioBody
RadioDescription
TextArea	A text area component is used for entering a paragraph of text that is longer than one line.
TextAreaResize
TextInput	A text input is used to gather free-form text from a user.
TextInputType