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

Playground elements #226

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open

Playground elements #226

wants to merge 18 commits into from

Conversation

saiutkarsh33
Copy link
Collaborator

📖 Description

- [ x]  New feature (non-breaking change which adds functionality)
- [ x ] This change requires a documentation update

## :test_tube: How Has This Been Tested?

Has not been tested. 

## :white_check_mark: Checklist:

- [x ] My code follows the SGDS style guidelines and naming conventions
- [ x] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [x ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [x ] Any dependent changes have been merged and published in downstream modules

@clukhei
Copy link
Collaborator

clukhei commented Nov 7, 2024

Hi I've reviewed and tried it out, there are a few concerns about this that we need to sort out before we can release this. I was trying this with the v3 to see how it will work for us as we change the code. Here are some concerns to be addressed , more for maintenance concerns.

The biggest one is that i can't get it to show when deployed to amplify as a static site. I think @saiutkarsh33 has tried to import the playground elements in preview.ts, but the ide just doesnt load well and had to workaround to load it as a script tag from node_modules. But the static deployment of storybook does not detect to add the playground-elements package to the final bundle. So i cant make it appear during deployment.

Other concerns are whether the maintenance overload for this IDE is worth the effort :

  1. The CDN version of the library is currently set at 2.0.0 after initial code generation. Whenever the new version changes, this will need to be manually updated.

Possible solution is to set Storybook env variables to set the latest published version or to pull from package.json's version.

  1. Code snippet needs to be updated, but can be easily copied from storybook examples.
  2. Code formatting with event.js. Manually address.
  3. Every time the component API change, we have to update the playground API as well.
  4. Unsure whether react users or vue, angular users will find this useful as the syntax is different.

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

Successfully merging this pull request may close these issues.

2 participants