Documentation should mention ElementUtils' inert api.
Nobody has claimed this yet.
- Dominant language
- AsciiDoc
- Stars
- 38
- Forks
- 225
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 170
Description
With V23 (?) we added the server side inert flag to allow a real modality for modal dialogs etc. That leads to issues with other elements, that can popup anyway but are not part of the dialogs hierarchy, e.g. Notifications. For developers it is very hard to find out how to circumcise this server side inert flag to allow interaction with such elements.
We have the page https://vaadin.com/docs/latest/advanced/server-side-modality but it does not mention the possibility to ignore the inert state for certain elements by using the ElementUtils, e.g.
ElementUtil.setIgnoreParentInert(Notification.show(...), true);
Therefore this issue requests to extend the documentation regarding this functionality.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the server-side modality page at https://vaadin.com/docs/latest/advanced/server-side-modality and review its discussion of the inert flag. Document how ElementUtil.setIgnoreParentInert can allow interaction with elements such as notifications, including the shown example; done means developers can find and understand this workaround.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100