@blinkk/selective-edit
Version:
Selective structured text editor.
22 lines (21 loc) • 1.18 kB
TypeScript
/**
* Utility for determining the preview value given an object.
*/
import { TemplateResult } from 'lit-html';
export declare enum PreviewTypes {
Image = "image",
Text = "text"
}
/**
* In the editor configuration it allows for providing a list of preview keys
* or a single preview key to use for finding the preview value. This method
* combines them into a single array to normalize the value for other methods.
*
* @param previewKeys Array of preview keys to use for previewing a field.
* @param previewKey Preview key to use for previewing a field.
*/
export declare function combinePreviewKeys(previewKeys?: Array<string>, previewKey?: string): Array<string>;
export declare function findPreviewValue(value: Record<string, any>, previewFieldKeys: Array<string>, defaultValue: string): string;
export declare function findOrGuessPreviewValue(value: Record<string, any>, previewFieldKeys: Array<string>, defaultValue: string): string;
export declare function templatePreviewValue(previewValue: string, previewType: PreviewTypes, defaultValue: string, index?: number): TemplateResult;
export declare function templateIndex(index?: number): TemplateResult;