@dotcms/uve
Version:
Official JavaScript library for interacting with Universal Visual Editor (UVE)
35 lines (34 loc) • 1.45 kB
TypeScript
import type { StyleEditorFieldInputType } from '@dotcms/types/internal';
import { StyleEditorCheckboxGroupField, StyleEditorDropdownField, StyleEditorInputField, StyleEditorInputFieldConfig, StyleEditorRadioField } from './types';
/**
* Helper functions for creating style editor field definitions.
* Used by the dotCMS schema builder UI.
*
* @experimental This API is experimental and may be subject to change.
*/
export declare const styleEditorField: {
/**
* Creates an input field definition.
*
* @experimental This method is experimental and may be subject to change.
*/
input: <T extends StyleEditorFieldInputType>(config: StyleEditorInputFieldConfig<T>) => StyleEditorInputField;
/**
* Creates a dropdown field definition.
*
* @experimental This method is experimental and may be subject to change.
*/
dropdown: (config: Omit<StyleEditorDropdownField, "type">) => StyleEditorDropdownField;
/**
* Creates a radio button field definition.
*
* @experimental This method is experimental and may be subject to change.
*/
radio: (config: Omit<StyleEditorRadioField, "type">) => StyleEditorRadioField;
/**
* Creates a checkbox group field definition.
*
* @experimental This method is experimental and may be subject to change.
*/
checkboxGroup: (config: Omit<StyleEditorCheckboxGroupField, "type">) => StyleEditorCheckboxGroupField;
};