1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
/// <reference types="react" />
export declare enum HelperTextItemVariant {
default = "default",
warning = "warning",
error = "error",
success = "success"
}
export interface HelperTextItemProps extends React.HTMLProps<HTMLDivElement | HTMLLIElement> {
/** Content rendered inside the helper text item. */
children?: React.ReactNode;
/** Additional classes applied to the helper text item. */
className?: string;
/** Sets the component type of the helper text item. */
component?: 'div' | 'li';
/** Variant styling of the helper text item. Will also render a default icon, which can be overridden
* with the icon prop.
*/
variant?: 'default' | 'indeterminate' | 'warning' | 'success' | 'error';
/** Custom icon prefixing the helper text. This property will override the default icon when the variant property is passed in. */
icon?: React.ReactNode;
/** ID for the helper text item. The value of this prop can be passed into a form component's
* aria-describedby prop when you intend for only specific helper text items to be announced to
* assistive technologies.
*/
id?: string;
/** Text that is only accessible to screen readers in order to announce the variant of a helper text item.
* This prop can only be used when the variant prop has a value other than "default".
*/
screenReaderText?: string;
}
export declare const HelperTextItem: React.FunctionComponent<HelperTextItemProps>;
//# sourceMappingURL=HelperTextItem.d.ts.map
|
