@patternfly/react-core
Version:
This library provides a set of common React components for use with the PatternFly reference implementation.
41 lines • 2.09 kB
TypeScript
import * as React from 'react';
export interface FormGroupProps extends Omit<React.HTMLProps<HTMLDivElement>, 'label'> {
/** Anything that can be rendered as FormGroup content. */
children?: React.ReactNode;
/** Additional classes added to the FormGroup. */
className?: string;
/** Label text before the field. */
label?: React.ReactNode;
/** Additional label information displayed after the label. */
labelInfo?: React.ReactNode;
/** Sets an icon for the label. For providing additional context. Host element for Popover */
labelIcon?: React.ReactElement;
/** Sets the FormGroup required. */
isRequired?: boolean;
/**
* Sets the FormGroup validated. If you set to success, text color of helper text will be modified to indicate valid state.
* If set to error, text color of helper text will be modified to indicate error state.
* If set to warning, text color of helper text will be modified to indicate warning state.
*/
validated?: 'success' | 'warning' | 'error' | 'default';
/** Sets the FormGroup isInline. */
isInline?: boolean;
/** Sets the FormGroupControl to be stacked */
isStack?: boolean;
/** Removes top spacer from label. */
hasNoPaddingTop?: boolean;
/** Helper text regarding the field. It can be a simple text or an object. */
helperText?: React.ReactNode;
/** Flag to position the helper text before the field. False by default */
isHelperTextBeforeField?: boolean;
/** Helper text after the field when the field is invalid. It can be a simple text or an object. */
helperTextInvalid?: React.ReactNode;
/** Icon displayed to the left of the helper text. */
helperTextIcon?: React.ReactNode;
/** Icon displayed to the left of the helper text when the field is invalid. */
helperTextInvalidIcon?: React.ReactNode;
/** ID of the included field. It has to be the same for proper working. */
fieldId: string;
}
export declare const FormGroup: React.FunctionComponent<FormGroupProps>;
//# sourceMappingURL=FormGroup.d.ts.map