BindingUtil • tldraw SDK

Table of contents

Properties
- editor
- migrations
- props
- type
Methods

Public class

Signature

abstract class BindingUtil<
  Binding extends TLUnknownBinding = TLUnknownBinding,
> {}

References

TLUnknownBinding

Source

packages/editor/src/lib/editor/bindings/BindingUtil.ts

Constructor

Public constructor

Constructs a new instance of the BindingUtil class

Parameters

Name	Description
`editor`	`Editor`

References

Editor

Properties

`editor`

Public property

Signature

editor: Editor

References

Editor

`migrations`

Public static property

Signature

static migrations?: TLPropsMigrations

References

TLPropsMigrations

`props`

Public static property

Signature

static props?: RecordProps<TLUnknownBinding>

References

RecordProps, TLUnknownBinding

`type`

Public static property

The type of the binding util, which should match the binding's type.

Signature

static type: string

Methods

`getDefaultProps()`

Public method

Get the default props for a binding.

Signature

abstract getDefaultProps(): Partial<Binding['props']>

`onAfterChange()`

Public method

Signature

onAfterChange?(options: BindingOnChangeOptions<Binding>): void

Parameters

Name	Description
`options`	`BindingOnChangeOptions<Binding>`

Returns

void

References

BindingOnChangeOptions

`onAfterChangeFromShape()`

Public method

Signature

onAfterChangeFromShape?(options: BindingOnShapeChangeOptions<Binding>): void

Parameters

Name	Description
`options`	`BindingOnShapeChangeOptions<Binding>`

Returns

void

References

BindingOnShapeChangeOptions

`onAfterChangeToShape()`

Public method

Signature

onAfterChangeToShape?(options: BindingOnShapeChangeOptions<Binding>): void

Parameters

Name	Description
`options`	`BindingOnShapeChangeOptions<Binding>`

Returns

void

References

BindingOnShapeChangeOptions

`onAfterCreate()`

Public method

Signature

onAfterCreate?(options: BindingOnCreateOptions<Binding>): void

Parameters

Name	Description
`options`	`BindingOnCreateOptions<Binding>`

Returns

void

References

BindingOnCreateOptions

`onAfterUnbind()`

Public method

Signature

onAfterUnbind?(options: BindingOnUnbindOptions<Binding>): void

Parameters

Name	Description
`options`	`BindingOnUnbindOptions<Binding>`

Returns

void

References

BindingOnUnbindOptions

`onBeforeChange()`

Public method

Signature

onBeforeChange?(options: BindingOnChangeOptions<Binding>): Binding | void

Parameters

Name	Description
`options`	`BindingOnChangeOptions<Binding>`

Returns

Binding | void

References

BindingOnChangeOptions

`onBeforeCreate()`

Public method

Signature

onBeforeCreate?(options: BindingOnCreateOptions<Binding>): Binding | void

Parameters

Name	Description
`options`	`BindingOnCreateOptions<Binding>`

Returns

Binding | void

References

BindingOnCreateOptions

`onBeforeUnbind()`

Public method

Signature

onBeforeUnbind?(options: BindingOnUnbindOptions<Binding>): void

Parameters

Name	Description
`options`	`BindingOnUnbindOptions<Binding>`

Returns

void

References

BindingOnUnbindOptions

`onOperationComplete()`

Public method

Signature

onOperationComplete?(): void

BindingUnbindReason BoundsSnapGeometry