Docs

Not yet — and the reason matters.

Documenting the embed is the same act as freezing it. The moment this page describes an option, a callback or a version number, somebody builds against it and we owe them that shape for years. We have not finished deciding what we are willing to owe.

What will be on this page, once we can keep the promise.

  1. The one line you paste

    The snippet is the same for all three doors. It points at your project, not at a frozen version.

  2. What you can pass in

    Every option, with what happens if you leave it out.

  3. What you get back

    The callbacks your page can listen to, and the shape of what each one hands you.

  4. What each version number versions

    There is more than one, they do not mean the same thing, and saying so here is part of the contract.

Want to be told when this page exists?

Not open yet. Leave an address and you hear from us once, when it is.