///
/**
* @description Base interface for all form components. Extends the
* element props. Allows for ReactNode on label prop.
*/
export interface BaseFormElementWithNodeLabel extends React.ComponentPropsWithoutRef<'input'> {
color?: 'default' | 'inverse';
/** This property shows the required asterisk (*). Required validation needs to be implemented separately. */
showRequiredLabel?: boolean;
hasError?: boolean;
errorMessage?: string;
helpMessage?: string;
label: string | React.ReactNode;
}
/**
* @description Base interface for all form components. Extends the
* element props.
*/
export interface BaseFormElement extends BaseFormElementWithNodeLabel {
label: string;
}
/**
* @description Base interface for form messages. These are typically help
* or error messages.
*/
export interface BaseFormMessage {
children?: React.ReactNode;
className?: string;
color?: 'default' | 'inverse';
/**
* @description The root form element "id". This is normally the id
* applied to an element. We use this prop to set the
* "error-for" and "help-for" attributes.
*/
rootElementId?: string;
/**
* @description A unique indentifier used to set the "id" of this element,
* which connects it with the root element. This ensures screen readers
* can read the error and help messages when one appears.
* This ID should be something like "error-for-" or
* "help-for-".
*/
describedById?: string;
}
export interface buildDescribedByProps {
hasError?: boolean;
hasHelpMessage?: boolean;
uniqueId: string;
}
/**
* A utility function to build the `aria-describedby` attribute.
*
* @param hasError - Boolean to define if component has an error
* @param hasHelpMessage - Boolean to define if component has a help message
* @param uniqueId - Unique identifier for the element.
*/
export declare const buildDescribedBy: ({ hasError, hasHelpMessage, uniqueId, }: buildDescribedByProps) => string | undefined;
export declare const errorFor: (uniqueId: string) => string;
export declare const helpFor: (uniqueId: string) => string;