@vtex/admin-ui
Version:
> VTEX admin component library
42 lines (41 loc) • 974 B
TypeScript
import type { ReactNode } from 'react';
import type { ResolverRenderProps } from './core';
/**
* Resolve image fields
* @generic T: item type
*/
export declare function imageResolver<T>(): import("./core").Resolver<T, "image", ImageResolver<T>>;
declare type ImagePreview = {
/**
* if should display preview or not
* @default true
*/
display: boolean;
/**
* Delay to show (in ms)
* @default 0
*/
delay: number;
/**
* Preview size
* @default regular
*/
size: 'small' | 'regular' | 'large';
};
export declare type ImageResolver<T> = {
type: 'image';
/**
* HTML img alt
*/
alt?: string;
/**
* Preview options
* @default {display:true,delay:0,size:'regular'}
*/
preview?: ImagePreview;
/**
* optional render function
*/
render?: (props: ResolverRenderProps<JSX.Element, T>) => ReactNode;
};
export {};