Suggestions

Introdução

A suggestion é um padrão utilizado para permitir que alguns campos do editor tenham opções de seleção durante o seu uso.

Como utilizar

Ao definir uma propriedade que será exibida dentro do editor, basta informar no atributo suggestion uma lista de valores que serão utilizados como sugestões na input do value quando esta tiver suporte para sugestões. E no atributo nameSuggestions as sugestões que você gostaria que a input de nome tenha.

Interface

/**
 * Defines how a suggestion for a selection or expression input should be reported
 * 
 * @param T Used to define the value attribute
 */
export interface ISuggestion<T = string | number> {
    /**
     * Displayed as a "title" for any type of information that may be relevant at the time of selection
     */
    description: string;
    /**
     * When "true" disables the option and does not allow it to be selected
     */
    disabled: boolean;
    /**
     * Showing as option name to be selected
     */
    label: string;
    /**
     *  Name used internally by the component
     */
    name: string;
    /**
     * Value that will be assigned to input when the option is selected
     */
    value: T;
}