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

FIO-9159: add intentionallyHidden ephemeral state and breaking change to clearOnHide behavior #173

Merged
merged 6 commits into from
Dec 16, 2024

Conversation

brendanbond
Copy link
Contributor

Link to Jira Ticket

https://formio.atlassian.net/browse/FIO-9159

Description

The platform has always treated an intentionally hidden component (i.e. one with the hidden property checked) as the same as conditionally hidden. This, combined with the fact that the clearOnHide property defaults to true, means that the the server would likely clear any intentionally hidden container's (e.g. Container component, Edit Grid, Nested Form, etc.) data. For a long while, however, there was a bug that meant that Nested Forms would not behave this way.

This PR aims to simplify and codify the behavior of hidden components - the clearOnHide property will now clear data only when that component is conditionally hidden. Intentionally hidden components will be unaffected and their data will not be cleared.

Breaking Changes / Backwards Compatibility

This fundamentally is a breaking change, because it decouples intentionally hidden components from conditionally hidden ones. It needs to be included in a changelog as breaking and released as part of a major version.

Dependencies

n/a

How has this PR been tested?

Added automated tests around clearOnHide

Checklist:

  • I have completed the above PR template
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • My changes include tests that prove my fix is effective (or that my feature works as intended)
  • New and existing unit/integration tests pass locally with my changes
  • Any dependent changes have corresponding PRs that are listed above

@johnformio johnformio merged commit 0a627a7 into master Dec 16, 2024
8 checks passed
lane-formio pushed a commit that referenced this pull request Dec 16, 2024
… to clearOnHide behavior (#173)

* add intentionallyHidden ephemeral state; change clearOnHide behavior to only clear when conditionally hidden; add tests; minor linting

* more tests

* fix merge conflict problem
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