New to KendoReactStart a free 30-day trial

Represents the props of the KendoReact Signature component.

Definition

Package:@progress/kendo-react-inputs

Properties

Identifies the element(s) which will describe the component.

Specifies the accessible label of the Signature.

Identifies the element(s) which will label the component.

Specifies the background color of the Signature.

Adds custom CSS classes to the Signature.

color?

string

Specifies the stroke color of the Signature.

dir?

string

Represents the dir HTML attribute.

disabled?

boolean

Disables the Signature when set to true.

The scale factor for the exported image.

The Signature width and height will be multiplied by the scale when converting the signature to an image.

Default:

2

fillMode?

"flat" | "solid" | "outline"

Configures the fill mode of the Signature.

Default:

undefined (theme-controlled)

height?

number

Specifies the height of the Signature in pixels.

hideLine?

boolean

Hides the dotted line in the background.

Default:

false

id?

string

Specifies the id of the Signature.

inputStyle?

CSSProperties

Represents the input element style HTML attribute.

Enables the maximizable feature of the Signature.

name?

string

Specifies the name of the Signature input.

onBlur?

(event: SignatureBlurEvent) => void

Fires when the Signature is blurred.

Parameters:eventSignatureBlurEvent

Fires when the value of the Signature changes.

Parameters:eventSignatureChangeEvent

Fires when the Signature popup is closed.

Parameters:eventSignatureCloseEvent

Fires when the Signature is focused.

Parameters:eventSignatureFocusEvent

onOpen?

(event: SignatureOpenEvent) => void

Fires when the Signature popup is opened.

Parameters:eventSignatureOpenEvent

open?

boolean

Sets the open state of the Signature popup.

The scale factor for the popup.

The Signature width and height will be multiplied by the scale when showing the popup.

Default:

3

readOnly?

boolean

Sets the Signature to read-only mode.

required?

boolean

Specifies if null is a valid value for the component.

This property is part of the FormComponentProps interface.

rounded?

"small" | "medium" | "large" | "none"

Configures the roundness of the Signature.

Default:

undefined (theme-controlled)

size?

"small" | "medium" | "large"

Configures the size of the Signature.

Default:

undefined (theme-controlled)

smooth?

boolean

Enables smoothing of the signature lines.

Specifies the stroke width of the Signature.

style?

CSSProperties

Represents the style HTML attribute.

tabIndex?

number

Specifies the tabIndex of the Signature.

valid?

boolean

Overrides the validity state of the component. If valid is set, the required property will be ignored.

This property is part of the FormComponentProps interface.

Controls the form error message of the component. If set to an empty string, no error will be thrown.

This property is part of the FormComponentProps interface.

If set to false, no visual representation of the invalid state of the component will be applied.

This property is part of the FormComponentProps interface.

value?

string

Specifies the value of the Signature as a Data URL.

webMcp?

boolean | WebMcpProps

Enables Web MCP tool registration for this component. Requires a parent WebMcpProvider from @progress/kendo-react-webmcp.

width?

number

Specifies the width of the Signature in pixels.