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

Wording of "Done" Button => "Cancel" #4211

Closed
hoereth opened this issue Feb 10, 2018 · 5 comments · Fixed by #4212
Closed

Wording of "Done" Button => "Cancel" #4211

hoereth opened this issue Feb 10, 2018 · 5 comments · Fixed by #4212

Comments

@hoereth
Copy link

hoereth commented Feb 10, 2018

Version: [ 2.8.0]

What kind of issue is this? Change Request.

We experienced usability issues with the springfox-swagger-ui. The authorization window shows a "Done" button (see screenshot) which acts like a "Cancel" button. I like to suggest to rename it, because users might be tempted to click "Done" to perform the authorization. In fact they should click "Authorize". You would improve awareness by renaming "Done" to "Cancel".

swagger-authorization

@charlescapps
Copy link
Contributor

charlescapps commented Feb 12, 2018

This is funny. We have a usability issue at our company --- if there isn't a Done button. The problem is that after you are done authorizing, it's confusing that there's just a Logout button and an x. Many users will just click logout because it's the big button present, and it's not 100% clear that clicking the x will let you keep your authentication.

I put up a PR to add the Done button to the OAuth dialog where it's currently missing, see #4212

I would suggest we arrive at a compromise, either
A) The Done button is only present after you have at least one authorization (to solve both of our issues)
B) We could just make it configurable whether or not there's a Done button. I could adjust my PR to make it a config option that's off by default.
C) The Done button is called Cancel initially, but after you have authorizations it's then called Done

Thoughts?

@hoereth
Copy link
Author

hoereth commented Feb 12, 2018

I understand that "Cancel" can also be misleading. The button seems to have been introduced as "Close" action. It seems that "Close" could serve both parties. (?) :)

@charlescapps
Copy link
Contributor

I'd be fine with Close if that's cool with you, @hoereth . I can update my pull request to call it Close instead of Done. I'll do so now!

Thanks for finding such an easy compromise. Cheers!

@charlescapps
Copy link
Contributor

OK, #4212 should satisfy this feature request now I believe.

@hoereth
Copy link
Author

hoereth commented Feb 13, 2018

@charlescapps : thank you! :)

@hoereth hoereth closed this as completed Feb 13, 2018
@lock lock bot locked and limited conversation to collaborators Jul 2, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants