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

We should have a better overview to display components #590

Closed
1 of 2 tasks
LucaMele opened this issue Oct 5, 2018 · 14 comments
Closed
1 of 2 tasks

We should have a better overview to display components #590

LucaMele opened this issue Oct 5, 2018 · 14 comments

Comments

@LucaMele
Copy link
Contributor

LucaMele commented Oct 5, 2018

We should have a better overview on how we display components, especially if they grow in number

We need an evaluation of https://github.com/frctl/fractal (The "Storybook" of Vanilla.js)

Are you reporting a bug or a feature?

  • Bug
  • Feature

Expected Behavior

Better overview and usability of the main demo page of the patterns library (Example: https://axa-ch.github.io/patterns-library/molecules.html)

Actual Behavior

Difficult to have a overview on all the components

@AndyOGo
Copy link

AndyOGo commented Oct 5, 2018

Sounds great, we would save ourselves a whole lot of work.

@LucaMele
Copy link
Contributor Author

LucaMele commented Oct 5, 2018

thank you @jackblackCH for this input :)

@AndyOGo
Copy link

AndyOGo commented Oct 5, 2018

I nice read about storybook and web components
https://medium.com/storybookjs/how-to-combine-web-components-with-storybook-a-match-made-in-heaven-9d9939eedc76

@LucaMele
Copy link
Contributor Author

LucaMele commented Oct 5, 2018

So we need to evaluate fractal and Storybook for WC.

Main Requirements (Functional and Non Functionals):

  • Semplicity (a apprentice can use it)
  • Full With Pure Html testable
  • Better usability then today (max 2 seconds to find the desired component starting of the main page and 1 second needed to know how to test it)

@AndyOGo
Copy link

AndyOGo commented Oct 5, 2018

I would add themability.

Edit:
I mean the ability to change the design of storybook or fractal to meet AXA's brand.
And to me this is a rather lower priority, though if it goes public it may be of strong interest for AXA in regards of branding.

Storybook theming support:

And Fractal seems to have theme support too.

@LucaMele
Copy link
Contributor Author

LucaMele commented Oct 5, 2018

Ok you can add but if is a requirement is would like to have it „measurable“ and also we need to know mor clearly what you mean with it

@AndyOGo
Copy link

AndyOGo commented Oct 5, 2018

BTW, since we have our withReact helper, we could use storybook with our reactified web components 💪

@LucaMele
Copy link
Contributor Author

LucaMele commented Oct 8, 2018

i would reccomend something that supports them natively so we are not bound to a technology

@MarekLacoAXA
Copy link
Contributor

It would be helpful to include a demo of a real-world micro site, including header/nav. menu/columns/form/validation/footer.
Perhaps as a bootstrapping template.

@AndyOGo
Copy link

AndyOGo commented Nov 21, 2018

@LucaMele
@MarekLacoAXA
@jackblackCH
We should have a checklist of features we need and an evaluation of them, so I start:

TL/DR: Let's go with storybook v4!

For devs:

  • custom elements V1 support
  • easy attribute updates (called knobs addon in Storybook)
  • it has to be maintained
  • markdown support
  • feature to parse and render doclets like jsdocs, sassdoc, you name it
  • extensible API
  • Testing
  • Search / Filter

For non-devs, designers, UXlers, users, etc.:

  • Viewport emulation
  • Web Accessibility compliance testing
  • Allow for custom documentation, additional ressources like templates, etc.

For AXA branding

  • Theming

Evaluation chart:

Feature Fractal Storybook
Maintained Nope 💣 Yes
Custom Elements V1 Yes Yes (through Vue, Polymer)
Knobs Nope Yes - knob addon
Markdown Yes Yes - through notes-addon
Doclets support n/a can be added
Extensible API n/a  Yes called addons
Theming Yes Yes
Testing n/a Yes - maybe best for React
Viewport n/a Yes
Accessibility n/a Yes
Search / Filter n/a Yes

@LucaMele
Copy link
Contributor Author

thank you for this overview @AndyOGo we need to sit down the 3 of us and dicuss it

@AndyOGo AndyOGo mentioned this issue Nov 28, 2018
12 tasks
@jackblackCH
Copy link
Contributor

jackblackCH commented Dec 17, 2018

There is a new, but alraeady famous kid on the block: https://www.docz.site/

@jackblackCH
Copy link
Contributor

@LucaMele
Copy link
Contributor Author

Closing as V2 is released. If issue is still relevant in v2, please re-open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants