ContentQualityAnnotationTypeConfiguration

Type: Object

The configuration for registering a Content Quality annotation type.

Properties

CardContentComponent

A ReactComponent for the visualization of the card for annotations of this type. Receives the annotationId as a prop, string.

The color that will be used when rendering annotations of this type.

createContextualOperations

Optional. A callback function for the contextual operations for annotations of this type.

decoration

Type: String | NULL

Optional. The text decoration in the content for annotations of this type. Can be wavy-underline or underline. Defaults to wavy-underline.

heading

Type: String

The heading that will be used when rendering annotations of this type.

icon

Type: String

The icon that will be used when rendering annotations of this type. This should be one of the FontAwesome (v5 Pro) icon names with an optional style prefix ('far ' is the default prefix). For more info, see the Font Awesome concept page.

localName

Type: String

The local name (within the given namespaceURI) of the annotation type.

namespaceURI

Type: String

The namespace URI where the annotation type resides.