Skip to content

docs(troubleshooting): add info about z-index issue #17

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.

Sign up for GitHub

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

Merged
varl merged 2 commits into from
Apr 23, 2020
Merged

docs(troubleshooting): add info about z-index issue #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc4884d
docs(troubleshooting): add info about z-index issue
HendrikThePendric Apr 1, 2020
5f7a587
docs(troubleshooting): add instructions for using `yarn why`
HendrikThePendric Apr 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_sidebar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
- [**Getting started**](getting-started)
- [**API**](api)
- [**Live demos**](/demo/ ':ignore Live demos')
- [**Troubleshooting**](troubleshooting)
7 changes: 7 additions & 0 deletions docs/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Troubleshooting

## Encountering z-index issues?

To ensure that components are stacked on top of each other correctly, a Layer component is used which leverages a React context. If an application is using multiple instances of `@dhis2/ui-core`, it will end up using multiple instances of this context as well. As a result components will not be stacked on top of each other correctly.

To prevent this issue, make sure that the app and its dependencies are using compatible version ranges of `@dhis2/ui`, so `yarn` is able to deduplicate these versions. You can assess if this is in fact the case by running `yarn why @dhis2/ui-core`. See the [yarn docs](https://classic.yarnpkg.com/en/docs/cli/why/) for more information.