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

docs: extend 'environment' prop explanation (#536) #588

Merged
merged 1 commit into from
Oct 2, 2018

Conversation

Rendez
Copy link
Contributor

@Rendez Rendez commented Oct 2, 2018

What:

Downshift's environment prop must provide 3 accessible object properties that roots other than window do not contain; for example a shadow-root.

Why:

We document the fact that shadow-root needs a workaround and provide a gist with a solid example.

How:

Adding a clarification to the use of the prop and a link to extend with an example.

Checklist:

  • Documentation
  • Tests N/A
  • Ready to be merged
  • Added myself to contributors table N/A (already added)

* Add link to gist example featuring a shadow-root as environment
Copy link
Member

@kentcdodds kentcdodds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super!

@kentcdodds kentcdodds merged commit 43a8787 into downshift-js:master Oct 2, 2018
@kentcdodds
Copy link
Member

🎉 This PR is included in version 3.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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