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] Sort props in docs in ascending order #3944

Merged
merged 7 commits into from
Aug 25, 2020

Conversation

ashikmeerankutty
Copy link
Contributor

@ashikmeerankutty ashikmeerankutty commented Aug 19, 2020

Summary

Makes progress on #3056

  • Sorted props in ascending order for better readability

Checklist

  • Check against all themes for compatibility in both light and dark modes
  • Checked in mobile
  • Checked in Chrome, Safari, Edge, 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

Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually?

@thompsongl
Copy link
Contributor

jenkins test this

@kibanamachine
Copy link

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

@cchaos
Copy link
Contributor

cchaos commented Aug 19, 2020

I have a suggestion for this. Lots of times we are writing the props in the component so that they're in an order where they relate to each other. For instance it's nice to keep prepend and append grouped together.

Is it possible, then to just hook up the sort ability of the table header to allow users to then sort it themselves into the alphabetical order?

@ashikmeerankutty
Copy link
Contributor Author

Is it possible, then to just hook up the sort ability of the table header to allow users to then sort it themselves into the alphabetical order?

Yes, For that I needed to add the props to the state so that I can update. I have done the changes, Can you please review it.

@cchaos
Copy link
Contributor

cchaos commented Aug 21, 2020

retest

@kibanamachine
Copy link

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

@chandlerprall
Copy link
Contributor

jenkins test this

@kibanamachine
Copy link

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

Copy link
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.

Code changes LGTM; My only remark is that sorting in descending order isn't present, but I don't know how necessary that is, thoughts @cchaos ?

@cchaos
Copy link
Contributor

cchaos commented Aug 24, 2020

sorting in descending order isn't present

Playing with the current implementation it feels odd to me to not allow descending order.

@chandlerprall
Copy link
Contributor

Playing with the current implementation it feels odd to me to not allow descending order.

👍

@ashikmeerankutty let's toggle asc->desc->off, then this will be good to go!

@ashikmeerankutty
Copy link
Contributor Author

@chandlerprall Updated with asc->desc>off. Can you please review 😃

@chandlerprall
Copy link
Contributor

jenkins test this

@kibanamachine
Copy link

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

@chandlerprall
Copy link
Contributor

off->asc->desc->off works, re-kicking CI for a flaky unit test - jenkins test this

@kibanamachine
Copy link

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

Copy link
Contributor

@thompsongl thompsongl left a comment

Choose a reason for hiding this comment

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

🎉

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.

5 participants