@cerberus-design/react
Version:
The Cerberus Design React component library.
21 lines (20 loc) • 889 B
text/typescript
import { HTMLAttributes } from 'react';
import { FieldMessageVariantProps } from 'styled-system/recipes';
/**
* This module contains the FieldMessage component.
* @module
*/
export interface FieldMessageBaseProps extends HTMLAttributes<HTMLParagraphElement> {
/**
* The id of the FieldMessage element describing the field. Required for accessibility. It is considered best practice to use the `help` or `error` prefix to help screen readers identify the type of message.
*
* @example For help messages: `help:field_id`
* @example For error messages: `error:field_id`
*/
id: string;
}
export type FieldMessageProps = FieldMessageBaseProps & FieldMessageVariantProps;
/**
* @deprecated use FieldHelperText, FieldErrorText, or FieldParts instead
*/
export declare function FieldMessage(props: FieldMessageProps): import("react/jsx-runtime").JSX.Element;