rework canBind callback #3797
rework canBind callback #3797
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
huppy-bot
bot
added
improvement
| const canBindFrom = from | ||
| ? this.getShapeUtil(from).canBind({ shape: from, otherShape: to, direction: 'from', type }) | ||
| : undefined | ||
| const canBindTo = to | ||
| ? this.getShapeUtil(to).canBind({ shape: to, otherShape: from, direction: 'to', type }) | ||
| : undefined | ||
|
|
||
| return canBindFrom !== false && canBindTo !== false |
There was a problem hiding this comment.
this feels quite heavy. I wonder whether we need to actually refer to the instances of the shapes when deciding if it can bind, for the time being can we just use the shape type and then maybe add support for deciding based on the actual shape instances later if anybody needs it?
So we could have e.g. editor.canBindShapes({fromShapeType, toShapeType, bindingType}) and then the shape utils can implement the same interface canBind({ fromShapeType, toShapeType, bindingType }) too.
There was a problem hiding this comment.
we need the actual instances in some cases (or at least... we need to go from ID to type first). i've moved those to the callsites though - i think i prefer this the way it is now.
This PR reworks the
canBindcallback to work with customizable bindings. It now accepts an object with a the shape, the other shape (optional - it may not exist yet), the direction, and the type of the binding. Devs can use this to create shapes that only participate in certain binding types, can have bindings from but not to them, etc.If you're implementing a binding, you can see if binding two shapes is allowed using
editor.canBindShapes(fromShape, toShape, 'my binding type')Change Type
sdk— Changes the tldraw SDKimprovement— Improving existing featuresRelease Notes
Breaking changes
The
canBindflag now accepts an options object instead of just the shape in question. If you're relying on its arguments, you need to change fromcanBind(shape) {}tocanBind({shape}) {}.