Skip to content

RedactStyle

RedactStyle = object

Defined in: types.ts:628

How a redacted region is drawn over the page. The mask is an opaque panel applied client side in the live DOM, so the obscured pixels never enter the recording and are never uploaded, and it cannot leak under any renderer.

By default the panel is filled with a color sampled from the surface beneath it, so it blends in as a clean block. Set color for a fixed fill, or css to fully style the panel.

optional color?: string

Defined in: types.ts:633

Opaque fill color, e.g. ‘#fff3d6’. Omit to sample a color from the surface underneath the element.


optional css?: string

Defined in: types.ts:644

Extra CSS applied to the mask panel for full custom styling, e.g. 'background: repeating-linear-gradient(45deg,#222 0 6px,#333 6px 12px)'. Applied last, so it overrides the defaults. Keep the panel opaque, or the content underneath may show through.


optional radius?: number

Defined in: types.ts:635

Corner radius of the mask in px (default 12).


optional shadow?: string | false

Defined in: types.ts:637

CSS box-shadow for the mask, or false to disable it.