payload
Version:
Node, React, Headless CMS and Application Framework built on Next.js
25 lines • 1.57 kB
TypeScript
import type { I18nClient, TFunction } from '@payloadcms/translations';
import type { Field } from '../../fields/config/types.js';
import type { ClientFieldWithOptionalType, ServerComponentProps } from './Field.js';
export type DescriptionFunction = (args: {
i18n: I18nClient;
t: TFunction;
}) => string;
export type FieldDescriptionClientComponent<TFieldClient extends ClientFieldWithOptionalType = ClientFieldWithOptionalType> = React.ComponentType<FieldDescriptionClientProps<TFieldClient>>;
export type FieldDescriptionServerComponent<TFieldServer extends Field = Field, TFieldClient extends ClientFieldWithOptionalType = ClientFieldWithOptionalType> = React.ComponentType<FieldDescriptionServerProps<TFieldServer, TFieldClient>>;
export type StaticDescription = Record<string, string> | string;
export type Description = DescriptionFunction | StaticDescription;
export type GenericDescriptionProps = {
readonly className?: string;
readonly description?: StaticDescription;
readonly marginPlacement?: 'bottom' | 'top';
readonly path: string;
};
export type FieldDescriptionServerProps<TFieldServer extends Field = Field, TFieldClient extends ClientFieldWithOptionalType = ClientFieldWithOptionalType> = {
clientField: TFieldClient;
readonly field: TFieldServer;
} & GenericDescriptionProps & ServerComponentProps;
export type FieldDescriptionClientProps<TFieldClient extends ClientFieldWithOptionalType = ClientFieldWithOptionalType> = {
field: TFieldClient;
} & GenericDescriptionProps;
//# sourceMappingURL=Description.d.ts.map