Skip to navigation

Annotation defaults

Default visual theme for screenshot and recording annotations. Specs and tests can override this value with their own annotationDefaults fields (test level wins over spec level, which wins over config level), and an individual annotation’s style wins over all of them. Fields left unset fall back to Doc Detective’s built-in theme. Setting a theme here keeps every annotated image in a doc set visually consistent.

Referenced In

Fields

FieldTypeDescriptionDefault
colorstringOptional. Default foreground color for every annotation type.—
backgroundstringOptional. Default background color for text-bearing annotations.—
strokeWidthnumberOptional. Default line width in pixels.

Minimum: 0
—
fontSizenumberOptional. Default font size in pixels.

Minimum: 1
—
fontFamilystringOptional. Default font family.—
opacitynumberOptional. Default opacity, from 0 to 1.

Minimum: 0. Maximum: 1
—
radiusnumberOptional. Default corner radius in pixels.

Minimum: 0
—
paddingnumberOptional. Default padding in pixels.

Minimum: 0
—
maxWidthnumberOptional. Default maximum text width in pixels.

Minimum: 1
—
intensitynumberOptional. Default blur strength.

Minimum: 1
—
outlineobject(Annotation style)Optional. Style overrides applied to every outline annotation.—
arrowobject(Annotation style)Optional. Style overrides applied to every arrow annotation.—
badgeobject(Annotation style)Optional. Style overrides applied to every badge annotation.—
calloutobject(Annotation style)Optional. Style overrides applied to every callout annotation.—
blurobject(Annotation style)Optional. Style overrides applied to every blur annotation.—
textobject(Annotation style)Optional. Style overrides applied to every text annotation.—
transitionobject(Annotation transition)Optional. Default transition for annotations that don’t set their own.—

Examples

{
"color": "#E11D48",
"strokeWidth": 3,
"badge": {
"background": "#E11D48",
"color": "#FFFFFF"
},
"blur": {
"intensity": 14
}
}
{
"fontFamily": "Inter, system-ui, sans-serif",
"fontSize": 14,
"transition": {
"enter": "fade",
"exit": "fade",
"durationMs": 250
}
}