UNPKG

1 kBTypeScriptView Raw
1import * as React from 'react';
2export interface HelperTextProps extends React.HTMLProps<HTMLDivElement | HTMLUListElement> {
3 /** Content rendered inside the helper text container. */
4 children?: React.ReactNode;
5 /** Additional classes applied to the helper text container. */
6 className?: string;
7 /** Component type of the helper text container */
8 component?: 'div' | 'ul';
9 /** ID for the helper text container. The value of this prop can be passed into a form component's
10 * aria-describedby prop when you intend for all helper text items to be announced to
11 * assistive technologies.
12 */
13 id?: string;
14 /** Flag for indicating whether the helper text container is a live region. Use this prop when you
15 * expect or intend for any helper text items within the container to be dynamically updated.
16 */
17 isLiveRegion?: boolean;
18}
19export declare const HelperText: React.FunctionComponent<HelperTextProps>;
20//# sourceMappingURL=HelperText.d.ts.map
\No newline at end of file