UNPKG

1.88 kBTypeScriptView Raw
1import * as React from "react";
2import { AbstractPureComponent } from "../../common";
3import { IntentProps, Props } from "../../common/props";
4export interface FormGroupProps extends IntentProps, Props {
5 /** Group contents. */
6 children?: React.ReactNode;
7 /**
8 * A space-delimited list of class names to pass along to the
9 * `Classes.FORM_CONTENT` element that contains `children`.
10 */
11 contentClassName?: string;
12 /**
13 * Whether form group should appear as non-interactive.
14 * Remember that `input` elements must be disabled separately.
15 */
16 disabled?: boolean;
17 /**
18 * Optional helper text. The given content will be wrapped in
19 * `Classes.FORM_HELPER_TEXT` and displayed beneath `children`.
20 * Helper text color is determined by the `intent`.
21 */
22 helperText?: React.ReactNode;
23 /** Whether to render the label and children on a single line. */
24 inline?: boolean;
25 /** Label of this form group. */
26 label?: React.ReactNode;
27 /**
28 * `id` attribute of the labelable form element that this `FormGroup` controls,
29 * used as `<label for>` attribute.
30 */
31 labelFor?: string;
32 /**
33 * Optional secondary text that appears after the label.
34 */
35 labelInfo?: React.ReactNode;
36 /** CSS properties to apply to the root element. */
37 style?: React.CSSProperties;
38 /**
39 * Optional text for `label`. The given content will be wrapped in
40 * `Classes.FORM_GROUP_SUB_LABEL` and displayed beneath `label`. The text color
41 * is determined by the `intent`.
42 */
43 subLabel?: React.ReactNode;
44}
45/**
46 * Form group component.
47 *
48 * @see https://blueprintjs.com/docs/#core/components/form-group
49 */
50export declare class FormGroup extends AbstractPureComponent<FormGroupProps> {
51 static displayName: string;
52 render(): JSX.Element;
53 private getClassName;
54}