Consider documentation / demo with Storybook.js about girder_web_components

[jeffbaumes]

The examples look nice. Since most/all the components in this repo need Girder in order to function, would there be an easy way to use storybook? Though this would be an obstacle to any live example site we might want to make for this repo, not specific to storybook.

[jbeezley]

I was playing with storybook a few months back in a branch of resonantgeo. I came to the conclusion that it works well for React, but less well for Vue. My memory is hazy, but I think it came down to it assuming the use of jsx as opposed to Vue components. That said, I think it would be worthwhile to have someone else explore it.

[jbeezley]

Another related approach to sharing, releasing, and demoing UI components is https://bitsrc.io. It has a searchable registry that you can use to group together related things. As an example, see https://bitsrc.io/bit/movie-app.

[jbeezley]

Since most/all the components in this repo need Girder in order to function, would there be an easy way to use storybook?

For many things, you can get away with using data.kitware.com since it has cors enabled. For components that only worked when logged in (like a jobs list widget), we would have to do something custom get a login token.

[subdavis]

There has evidently been a lot of work done on the Vue front over the last couple months. I don't know if it changed recently, but SFCs are definitely supported now.

I'll have to take a look at Bitsrc as well, one may have an advantage over the other. Thanks!

Since most/all the components in this repo need Girder in order to function, would there be an easy way to use storybook?

I imagine it would be a good idea to have each of our components show a "dead" message for when there isn't an active session. Library consumers that aren't us may put these components in places such that the parent application doesn't guarantee an active session to render, and we would want to handle that gracefully. So if your browser has a session, everything works, and if not, you can either visit the Auth component or sign into girder. Would be easy to allow users to change the girder base URL, I think?

[subdavis]

Doesn't seem like something that would add a whole lot of value for us.