s-m-r-t
Open the s-m-r-t source on GitHub Switch to dark color scheme
← All UI components

Forms and controls

SignaturePad

No summary has been written for SignaturePad. Everything below is generated from the declaration shipped in 0.57.40 and describes the real contract.

Public export

typescript
import { SignaturePad } from '@happyvertical/smrt-ui/forms';
Import path
@happyvertical/smrt-ui/forms
Props
12
Props described
12 of 12
Bindable state
0
Callback events
2
Verified release
0.57.40

Props

NameTypeRequiredDescription
stylusOnlybooleanNoAccept pen input only; the caller resolves this rule.
disabledbooleanNoIgnores input and disables both actions.
onCapture(result: CaptureResult) => voidNoCalled when the user commits a signature with "Use signature".
onClear() => voidNoCalled when a committed signature is discarded by "Clear" or a form reset.
namestringNoField name: the committed PNG posts as a file in a native form.
fileNamestringNoPosted file name.
widthnumberNoCanvas backing width in pixels (the display width is responsive).
heightnumberNoCanvas backing height in pixels.
labelsPartial<SignaturePadLabels>NoText overrides; defaults come from the `ui` i18n catalog.
idstringNoDOM id of the component root.
classstringNoCSS class to apply to the component root.
interactionControlInteractionOptions | falseNoInteraction options or false to disable registration.

Bindable state

This component has no bindable public state.

Callback events

  • onCapture(result: CaptureResult) => void
  • onClear() => void

Examples and explanation