Trilium Frontend API
    Preparing search index...

    Interface DowncastHighlightDescriptor

    An object describing how the marker highlight should be represented in the view.

    Each text node contained in a highlighted range will be wrapped in a <span> module:engine/view/attributeelement~ViewAttributeElement view attribute element with CSS class(es), attributes and a priority described by this object.

    Additionally, each module:engine/view/containerelement~ViewContainerElement container element can handle displaying the highlight separately by providing the addHighlight and removeHighlight custom properties. In this case:

    • The DowncastHighlightDescriptor object is passed to the addHighlight function upon conversion and should be used to apply the highlight to the element.
    • The descriptor id is passed to the removeHighlight function upon conversion and should be used to remove the highlight with the given ID from the element.
    interface DowncastHighlightDescriptor {
        attributes?: Record<string, string>;
        classes: string | string[];
        id?: string;
        priority?: number;
    }
    Index

    Properties

    attributes? classes id? priority?

    Properties

    attributes?: Record<string, string>

    Attributes to set. If the descriptor is used to create an module:engine/view/attributeelement~ViewAttributeElement attribute element over text nodes, these attributes will be set on that attribute element. If the descriptor is applied to an element, usually these attributes will be set on that element, however, this depends on how the element converts the descriptor.

    classes: string | string[]

    A CSS class or an array of classes to set. If the descriptor is used to create an module:engine/view/attributeelement~ViewAttributeElement attribute element over text nodes, these classes will be set on that attribute element. If the descriptor is applied to an element, usually these classes will be set on that element, however, this depends on how the element converts the descriptor.

    id?: string

    Descriptor identifier. If not provided, it defaults to the converted marker's name.

    priority?: number

    Descriptor priority. If not provided, it defaults to 10. If the descriptor is used to create an module:engine/view/attributeelement~ViewAttributeElement attribute element, it will be that element's module:engine/view/attributeelement~ViewAttributeElement#priority priority. If the descriptor is applied to an element, the priority will be used to determine which descriptor is more important.

    Settings

    Member Visibility

    On This Page

    Properties