| 1 | import * as React from 'react';
|
| 2 | export interface HelperTextItemProps extends React.HTMLProps<HTMLDivElement | HTMLLIElement> {
|
| 3 | /** Content rendered inside the helper text item. */
|
| 4 | children?: React.ReactNode;
|
| 5 | /** Additional classes applied to the helper text item. */
|
| 6 | className?: string;
|
| 7 | /** Sets the component type of the helper text item. */
|
| 8 | component?: 'div' | 'li';
|
| 9 | /** Variant styling of the helper text item. */
|
| 10 | variant?: 'default' | 'indeterminate' | 'warning' | 'success' | 'error';
|
| 11 | /** Custom icon prefixing the helper text. This property will override the default icon paired with each helper text variant. */
|
| 12 | icon?: React.ReactNode;
|
| 13 | /** Flag indicating the helper text item is dynamic. This prop should be used when the
|
| 14 | * text content of the helper text item will never change, but the icon and styling will
|
| 15 | * be dynamically updated via the `variant` prop.
|
| 16 | */
|
| 17 | isDynamic?: boolean;
|
| 18 | /** Flag indicating the helper text should have an icon. Dynamic helper texts include icons by default while static helper texts do not. */
|
| 19 | hasIcon?: boolean;
|
| 20 | /** ID for the helper text item. The value of this prop can be passed into a form component's
|
| 21 | * aria-describedby prop when you intend for only specific helper text items to be announced to
|
| 22 | * assistive technologies.
|
| 23 | */
|
| 24 | id?: string;
|
| 25 | }
|
| 26 | export declare const HelperTextItem: React.FunctionComponent<HelperTextItemProps>;
|
| 27 | //# sourceMappingURL=HelperTextItem.d.ts.map |
| \ | No newline at end of file |