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

Component Examples #89

Merged
merged 38 commits into from
Jun 3, 2020
Merged

Component Examples #89

merged 38 commits into from
Jun 3, 2020

Conversation

jerelmiller
Copy link
Contributor

@jerelmiller jerelmiller commented Jun 3, 2020

Description

Adds component examples to the reference template. Components that have a preview are live-editable.

This PR also addresses:

  • Puts the examples in shadow DOM to isolate the SDK CSS. This avoids the global styles in the SDK conflicting with the documentation site
  • Loads the SDK JS along with the rest of the static content rather than loading it on demand

Reviewer Notes

IMPORTANT: The Modal and Tooltip examples are currently broken. These components add a portal root to the site body, which does not include the SDK styles. This will need to be fixed before we go live. This PR does not address this issue.

The component docs are not accessible via a link right now. To preview, visit: https://pr-89.dlyi50rq9kt6c.amplifyapp.com/components/button. You can then navigate the other components using this link as a starting point.

Related Issue(s) / Ticket(s)

If there are any related GitHub Issues or JIRA tickets, add links to them here.

Screenshot(s)

Screen Shot 2020-06-03 at 1 07 21 PM

Screen Shot 2020-06-03 at 1 07 27 PM

Screen Shot 2020-06-03 at 1 07 37 PM

Screen Shot 2020-06-03 at 1 07 45 PM

@jerelmiller jerelmiller merged commit 394ac94 into master Jun 3, 2020
@jerelmiller jerelmiller deleted the jerel/example-docs branch June 3, 2020 22:21
@nr-opensource-bot
Copy link
Contributor

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

3 participants