Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
Proposal: Add a guide for using CanJS with other libraries #4730
TLDR: add docs for using other libraries inside CanJS and using CanJS components inside other frameworks.
We sometimes get questions about how to use a jQuery plugin or embed a React component inside a CanJS component. It’d be nice to have a guide that answers these questions.
Additionally, it would be nice to show how to use CanJS components inside other frameworks. Having docs on this would help CanJS converts use it in their existing apps, and help show potential converts that it’s easy to start using CanJS in the apps they already maintain.
Let’s create a guide that shows how to use other libraries with CanJS. This would show how to embed the following into a CanJS component:
Ideally, we’d walk through one example for each library. This would include instantiating the component, providing data, binding, listening to events, and tearing down the component.
Additionally, we should show the reverse: a CanJS component embedded into popular JS frameworks (Angular, React, etc.).
It’d be nice to have a working CodePen for each example, but if the library doesn’t make it easy, then a GitHub repo would suffice (à la webpack-example).
This adds a maintenance burden with each CanJS release and when other libraries have major releases.
Instead of writing a guide on canjs.com, write a series of blog or forum posts with each example. This would be a “one-time” expense that we wouldn’t necessarily have to maintain over time.
[Even if we do include this as part of canjs.com, it might not be a bad idea to also publish each one as a blog post for posterity/SEO.]