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

Proposal: Add a guide for using CanJS with other libraries #4730

Open
chasenlehara opened this issue Feb 8, 2019 · 0 comments

Comments

Projects
None yet
1 participant
@chasenlehara
Copy link
Member

commented Feb 8, 2019

TLDR: add docs for using other libraries inside CanJS and using CanJS components inside other frameworks.

This was discussed on a recent live stream (5:09).

Motivation

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.

Solution

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:

  • “Apps”/components from other libraries (Angular, React, Vue, etc.)
  • A popular jQuery plugin
  • …other popular libraries? [leave a comment please!]

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).

Drawbacks

This adds a maintenance burden with each CanJS release and when other libraries have major releases.

Alternatives

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.]

Prior art

Unresolved questions

  • Should this go on canjs.com? If so, where?
  • This proposes docs for how to integrate other libraries into CanJS and CanJS components into other libraries. Should these be the part of the same doc, or two separate guides?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.