@atlaskit/form
Version:
A form allows people to input information.
38 lines (37 loc) • 1.05 kB
TypeScript
/**
* @jsxRuntime classic
* @jsx jsx
*/
import { type ReactNode } from 'react';
type MessageAppearance = 'default' | 'error' | 'valid';
/**
* API for the internal `<Message />` component. This is not public API.
*/
interface InternalMessageProps {
/**
* The content of the message
*/
children: ReactNode;
/**
* A testId prop is provided for specified elements, which is a unique string
* that appears as a data attribute data-testid in the rendered code,
* serving as a hook for automated tests
*/
testId?: string;
/**
* Determines the appearance of the message.
*/
appearance?: MessageAppearance;
fieldId?: string;
}
/**
* Public API of the various message components.
*/
export type MessageProps = Pick<InternalMessageProps, 'children' | 'testId'>;
/**
* __Message__
*
* A message component for displaying messages in a form.
*/
declare const Message: ({ children, appearance, fieldId, testId, }: InternalMessageProps) => React.ReactNode;
export default Message;