Skip to content
Components

IdentifiedSurfaceFrame

High-contrast brackets and disclosure frame for an object identified inside an image or document. Resting corners preserve the evidence geometry; highlight and active states reveal the complete frame and compact label.

Identified surfaceA-12

Usage

import { IdentifiedSurfaceFrame, IdentifiedSurfaceFrameProps } from "@instruments/materia-ui/components/identified-surface";

Best practices

  • Position this over the exact identified bounds inside a relative container; inflate the bounds outside this component when the source geometry is smaller than a comfortable pointer target.

  • Pair it with a real button or link. This component is deliberately pointer-transparent and carries no interaction semantics of its own.

Props

PropTypeDefaultDescription
activeboolean

Persists the stronger treatment after the identified object is selected.

classNamestring
highlightedboolean

Reveals the complete frame while a related control is hovered or focused.

label(required)string
labelAlign"center" | "end" | "start"
labelPlacement"above" | "below"
persistentFrameboolean

Keeps the complete evidence boundary visible before interaction.

secondaryLabelstring | undefined
thumbnailUrlstring | null | undefined

Also exports

  • interfaceIdentifiedSurfaceFrameProps