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

• Checkbox - Checkbox control
• CheckboxBody - Body content area of a checkbox
• CheckboxDescription - Description text for a checkbox
• Form - Top-level form container
• FormActionGroup - Contains form action buttons (submit, cancel)
• FormAlert - Displays an alert within a form
• FormControl - Base class for form controls with validation support
• FormFieldGroup - Nestable field group with header and body
• FormFieldGroupBody - Body area of a form field group
• FormFieldGroupHeader - Header area of a form field group with title and actions
• FormGroup - Groups a label with a control and helper text
• FormGroupControl - Control area within a form group
• FormGroupLabel - Label for a form group
• FormGroupRole - Enumeration of form group ARIA roles (radiogroup, group)
• FormSection - Groups related form groups under a heading
• FormSelect - Native select dropdown
• FormSelectOption - Individual option within a form select
• FormSelectOptionGroup - Option group within a form select
• Radio - Radio button control
• RadioBody - Body content area of a radio button
• RadioDescription - Description text for a radio button
• TextArea - Multi-line text input
• TextAreaResize - Enumeration of text area resize options
• TextInput - Single-line text input
• TextInputType - Enumeration of text input types (text, email, password, etc.)

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	A body content of a checkbox within a Checkbox component.
CheckboxDescription	A description text of a checkbox within a Checkbox component.
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	A form action group within a Form component.
FormAlert	A form alert within a Form component.
FormControl<E extends HTMLElement, B extends BaseComponent<E,B>>	A wrapper for form control elements such as inputs, selects, and text areas within a Form.
FormFieldGroup	A form field group within a Form component.
FormFieldGroupBody	A body of a form field group within a FormFieldGroup component.
FormFieldGroupHeader	A header of a form field group within a FormFieldGroup component.
FormGroup	A form group within a Form component.
FormGroupControl	The control area within a FormGroup, containing the actual input element.
FormGroupLabel	A label within a form group within a FormGroup component.
FormGroupRole	Defines the ARIA role applied to a FormGroup.
FormSection	A form section within a Form component.
FormSelect	A form select embeds browser native select lists into a form.
FormSelectOption	A form select option within a FormSelect component.
FormSelectOptionGroup	A option group within a form select within a FormSelect component.
Radio	A radio button is used to present the user with mutually exclusive choices.
RadioBody	A body content of a radio button within a Radio component.
RadioDescription	A description text of a radio button within a Radio component.
TextArea	A text area component is used for entering a paragraph of text that is longer than one line.
TextAreaResize	Defines the resize directions available for a TextArea.
TextInput	A text input is used to gather free-form text from a user.
TextInputType	Defines the HTML input types available for a TextInput.