malcolm-kee / react-showroom Goto Github PK

It may not be clear that the code change is encoded in the URL. Share button should be able to help that.

This allows user to create landing page with grid

Provide intellisense in the examples. It should be technically possible, as it is available in playroom.

• Basic support: only our components
• Advanced support: support for imported libraries as well

• The comment should be point to a specific point of the preview
• The comment location/content should be encoded into URL, so it can be shared together with the link

Use react-draggable for the anchor of the comment

Possible approaches

• use puppeteer - this would probably implemented as an optional feature (as forcing user to install puppeteer with this package is a no-go), user need to install puppeteer for this and turn it on.
• use html2canvas. However this requires user to manually run it and save the image as part of the repositories. We probably need to render a dev only panel that allows us to run this in dev server. This may be a good approach, combining with File System Access API.

Seems undermaintain and cause typescript issue.

Inspiration: https://github.com/storybookjs/storybook/tree/next/addons/measure

Include remark-admonitions

Ideally this should be supported by allowing configurations of markdown plugins, so only those like this configure it.

Not sure how

Inspired by the upcoming StorybookJS Interaction Testing, I am thinking of introducing something similar to React Showroom.

Goals

• Allow docs viewer to see a sequence of interactions in browser directly

Must-have

• use testing-library as the programmatic way to run simulations.

Nice-to-have

1. Allowing reusing code for the interaction demo and tests, following our philosophy of reusing existing dev workflow instead of reinvent one.
2. Undo/redo the interaction steps
3. Ability to run the interaction step-by-step

Challenges

• Because we're using markdown instead of javascript, it is probably challenging to achieve nice-to-have 1.

Although already prerender, not sure why the iframe is being reloaded.

use axe-core.

Which need circular dependency support. Not sure if that's possible.

There may be conflict with other UI library approach for portal.

Better stick to full page view only to be safe.