Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[draft] Add tldraw integration #291

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

TodePond
Copy link

@TodePond TodePond commented Nov 10, 2023

This PR adds a simple integration for tldraw, ahead of our call next week.

There are more examples on this page right here, that we can also talk through.


The example in this PR is a custom block for when you paste a tldraw multiplayer project. It can also be accessed by typing /tldraw. It embeds the multiplayer project in a modal, similar to some of the other integrations. You can paste a public, read-only, or snapshot board. And you can try it here.

Future work can include thumbnail support, an embedded editor, and displaying just an exported image in 'view mode'. (I'm looking forward to speaking with you about this).

Copy link

changeset-bot bot commented Nov 10, 2023

🦋 Changeset detected

Latest commit: 094f676

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
tldraw-gitbook-block Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@TodePond TodePond changed the title [draft] Add tldraw integration example [draft] Add tldraw integration Nov 10, 2023
@addisonschultz
Copy link
Contributor

Hi @TodePond!

Thanks for putting this together, it's looking great - and the code is working as expected as well. Just a few requests, and some small questions on the UX of the integration.

The first set of small things - in order for us to verify and list this integration in our marketplace, we'll need some assets and more metadata (preview images, descriptions, summaries, external links) to make the listing a bit more friendly for anyone discovering the integration. We have more info on what you can/should add here!

https://developer.gitbook.com/marketplace/submit-your-app-for-review#prepare-assets

The second thing is more of the UX of the integration. I see in the code you've prepared 2 different blocks (and saw that in your demo / demo file as well 😄).

My question is what the default behavior should be - is the intended default to be the modal/click to open modal?

I do think some of the other workflows/versions could also be useful - like the canvas version in edit mode - and the static version in the published version.

That being said, it's totally up to you how you'd like to have this app work - but maybe it might be worth exploring adding a configuration option in the block itself to let the user choose what version/type they want?

You can add controls for a block directly on the element: https://developer.gitbook.com/integrations/contentkit/reference/reference#layout

We have an example of that in the GitHub Files integration as well:

Let me know what you think, and if you can re-publish with some assets, and we'll go from there!

@TodePond
Copy link
Author

TodePond commented Jan 8, 2024

Hey, revisiting this now! We suddenly became very busy (with AI demos) shortly after opening this PR.
Thank you for your feedback - that's very helpful. I hope to dive back in at some point soon, and published a finalised version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants