Skip to content

[EuiAccordion] Allow external control#3614

Merged
thompsongl merged 7 commits intoelastic:masterfrom
thompsongl:3594-accordion
Jun 16, 2020
Merged

[EuiAccordion] Allow external control#3614
thompsongl merged 7 commits intoelastic:masterfrom
thompsongl:3594-accordion

Conversation

@thompsongl
Copy link
Copy Markdown
Contributor

@thompsongl thompsongl commented Jun 15, 2020 •
edited
Loading

Summary

Resolves #3594 by allowing forceState and onToggle to work together as an external state value and update function pair.

When forceState is in use onToggle will be called with a boolean reflecting the current open/closed state. This might be slightly confusing as standard onToggle is called with a boolean reflecting the new open/closed state after click.

Checklist

- [ ] Check against all themes for compatibility in both light and dark modes
- [ ] Checked in mobile
- [ ] Checked in IE11 and Firefox

  • Props have proper autodocs
  • Added documentation
  • Checked Code Sandbox works for the any docs examples
  • Added or updated jest tests
  • Checked for breaking changes and labeled appropriately

- [ ] Checked for accessibility including keyboard-only and screenreader modes

  • A changelog entry exists and is marked appropriately

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Jun 15, 2020

Preview documentation changes for this PR: https://eui.elastic.co/pr_3614/

@thompsongl thompsongl requested a review from chandlerprall June 15, 2020 22:07
@chandlerprall
Copy link
Copy Markdown
Contributor

chandlerprall commented Jun 16, 2020

Changes look good, though thinking about

onToggle will be called with a boolean reflecting the current open/closed state. This might be slightly confusing

Thoughts on calling onToggle with the user-initiated state value instead?

@thompsongl
Copy link
Copy Markdown
Contributor Author

thompsongl commented Jun 16, 2020

Thoughts on calling onToggle with the user-initiated state value instead?

I could definitely go either way on this.
My read is that the consumer won't be attempting a bunch of logic around this value and will just update state accordingly, so perhaps passing the state expected by the user after click makes more sense.

@chandlerprall
Copy link
Copy Markdown
Contributor

chandlerprall commented Jun 16, 2020

so perhaps passing the state expected by the user after click makes more sense.

I think so; let's go that way, then this is good to merge

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Jun 16, 2020

Preview documentation changes for this PR: https://eui.elastic.co/pr_3614/

@chandlerprall
Copy link
Copy Markdown
Contributor

chandlerprall commented Jun 16, 2020

Looks like the accordion_forceState.js example wasn't updated and expects the inverse value in onToggle

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Jun 16, 2020

Preview documentation changes for this PR: https://eui.elastic.co/pr_3614/

@chandlerprall
Copy link
Copy Markdown
Contributor

chandlerprall commented Jun 16, 2020

PUPPETEER_SKIP_CHROMIUM_DOWNLOAD

jenkins test this

chandlerprall
chandlerprall approved these changes Jun 16, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@chandlerprall chandlerprall left a comment

Choose a reason for hiding this comment

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

Changes LGTM! Tested in the PR's docs

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Jun 16, 2020

Preview documentation changes for this PR: https://eui.elastic.co/pr_3614/

@thompsongl thompsongl merged commit 2c47d9c into elastic:master Jun 16, 2020
@thompsongl thompsongl mentioned this pull request Jun 29, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@chandlerprall chandlerprall chandlerprall approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

EuiAccordion - allow user to control open state from the outside

3 participants

@thompsongl @kibanamachine @chandlerprall