How to support a new Framework?

[TechQuery]

Such as WebCell (a new framework based on TSX & Web Components)

[steve8708]

Hey @TechQuery - thanks for the question!

We are actually in the process of making this easier and having documentation for how to do it yourself. In short, using our HTML API is the easiest way, e.g.

fetch(
  `https://cdn.builder.io/api/v1/html/${modelName}?url=${encodeURIComponent(location.href)}&apiKey=${apiKey}`
)
.then(res => res.json())
.then(content => {
  if (content) {
    element.innerHTML = content.data.html
  } else {
    // trigger some kind of "not found" callback
  }
})

Where you might take modelName and apiKey as input args to your component. Note that the HTML API response uses a webcomponent called builder-component by default so be sure to name your component anything else, e.g.

<builder model="..." apiKey="..." /> and call the HTML API internally and you should be good!

Happy to answer questions anytime you get stuck and follow up with the full integration docs when available

And we have a more advanced example coming in the next few weeks on how to do a deeper integration that involves rendering all of the content in your framework components and using your components in the editor

[steve8708]

Going to leave this open for now until we have our easier way to add full framework support coming up