search

Nexmo / nexmo-oas-renderer

Render your API references, Nexmo-style!
https://developer.nexmo.com/api
MIT License
46 stars 4 forks source link

Fix oneOf responses #12

Closed fabianrbz closed 5 years ago

fabianrbz commented 5 years ago

Related https://github.com/Nexmo/nexmo-developer/issues/1743

This changes the way we display the oneOf responses. It creates one table for each response with the corresponding attributes and toggles them depending on the Response selected.

lornajane commented 5 years ago

This does what I expected but I only seem to be able to select between responses in the right hand pane, the list of response fields just tells me which response is currently being shown - but no way to switch. We also discussed that I should add a field to make better labels than "Response 1" but I don't remember which field was to be used. Prompt me and I'll make some changes in the API specs.

fabianrbz commented 5 years ago

@lornajane the field we talked about was description

fabianrbz commented 5 years ago

@lornajane can you take another look? Sadly Volta's tabs don't support accessibility features :/, let me know if it's easier now, otherwise I'll look into adding support for it in Volta.

lornajane commented 5 years ago

This looks a lot better although the JSON/XML label can sort of float randomly depending where you are when you scroll. Can we possibly make those tabs clickable? Upstream contribution of that I know will be gratefully received as they are working more on accessibility. I also added some descriptions to the Verify API (and tagged you @fabianrbz to review) to try it out and it looks GREAT :smile:

mheap commented 5 years ago

tabindex=0 is enough to make them clickable. Sadly this can’t really be contributed upstream as it’s a HTML structure thing rather than in the CSS, so will be different for every app depending on if they use tabindex for correctly (we only use it for focusing)

On Wed, 14 Aug 2019 at 12:47, Lorna Jane Mitchell notifications@github.com wrote:

This looks a lot better although the JSON/XML label can sort of float randomly depending where you are when you scroll. Can we possibly make those tabs clickable? Upstream contribution of that I know will be gratefully received as they are working more on accessibility. I also added some descriptions to the Verify API (and tagged you @fabianrbz https://github.com/fabianrbz to review) to try it out and it looks GREAT 😄

— You are receiving this because your review was requested. Reply to this email directly, view it on GitHub https://github.com/Nexmo/nexmo-oas-renderer/pull/12?email_source=notifications&email_token=AAAON6SM7GZZY7OJMDQGLB3QEPPFJA5CNFSM4IIQ46B2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD4INK7I#issuecomment-521196925, or mute the thread https://github.com/notifications/unsubscribe-auth/AAAON6QI4LFMYVB7BQS3KVLQEPPFJANCNFSM4IIQ46BQ .

fabianrbz commented 5 years ago

@mheap @lornajane what about http://volta-core.vonage.com/storybook/?path=/story/layout-tabs--unstyled ? I used the default one, and tried to add all the necessary accessibility features, but Volta's js doesn't support it and it also keeps a state for some reason.

What we could push upstream is the support for the aria controls and tabindexing, it is pure html + some js and it's up to the end user to add them

mheap commented 5 years ago

I'd keep the existing style rather than moving to unstyled. I believe that the structure is the same, it's purely CSS differences.

If we can push aria controls upstream in to the examples that would be excellent

mheap commented 5 years ago

@fabianrbz What do we need to get this merged?

fabianrbz commented 5 years ago

@mheap I'm currently working on the accessibility features in Volta, but we can merge this as it is and later bump the library