Skip to main content
Version: 57.2.0

Signature capture field

Lets a user sign by drawing or by typing their name and choosing a font, chosen via a

Package: @terreno/ui
Categories: Component
Props interface: SignatureCaptureFieldProps
Story source: demo/stories/Signaturecapturefield.stories.tsx

Live demo

Props

PropTypeRequiredDescription
onChangereflectionYes
defaultModeSignatureModeWhich capture method is shown first when the field is empty. Ignored once
disabledboolean
errorTextstring
fontsarrayFonts offered in "type" mode. Defaults to the library's bundled signature fonts. When supplying a custom list, the consumer must load those font families themselves.
fullWidthbooleanStretches the draw pad to the full available width.
helperTextstring
nameLabelstringLabel for the typed name input. Defaults to "Full name".
onEndreflectionFired when the signer stops drawing — use to re-enable a parent ScrollView.
onStartreflectionFired when the signer starts drawing — use to disable a parent ScrollView.
placeholderstringPlaceholder for the typed name input. Defaults to "Type your full name".
testIDstringRoot test id for the primary interactive element or container.
testIDsFieldTestIDs
titlestringSection title rendered above the field. Defaults to "Signature".
valueSignatureCaptureValueControlled value. When omitted the field starts empty in