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

Improve presentation of Interface Implementations #151

Open
BoilerTom90 opened this issue Aug 15, 2022 · 2 comments
Open

Improve presentation of Interface Implementations #151

BoilerTom90 opened this issue Aug 15, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@BoilerTom90
Copy link

Describe the problem

When viewing an Interface, the Implementations are listed below the fields of the interface. This is presented as a series of links with no line breaks between them. When presenting this output to our team for review, the question was asked if that list of links could be presented in a more appealing matter? I've attached a snip of that page to show how the list quite long and not easy to find things:

tempsnip

Is this type of request supposed to be addressed by using a different template?

Describe the proposed solution

One thought, is to make it similar to how the References section is presented. That section presents as many references as will fit on the page, and then has a "Show more" link to expand the list. But, one issue I can see with that is if there are this many "Implementations" then there might not be space on the viewable page to show any Interfaces or Usages, and that could go unnoticed by the user.

To address this, perhaps the Implementations, Interfaces and Usages sections could be encapsulated in an expandable section?

Alternatives considered

No response

Importance

nice to have

Additional Information

No response

@BoilerTom90 BoilerTom90 added the enhancement New feature or request label Aug 15, 2022
@pelletier197
Copy link
Collaborator

I see your issue, and I have to say I did not expect a GraphQL schema with that many interfaces when this was implemented 😅

Although, to be honest, I'm not fully convinced a bullet list would fit better here. I'm not particularly happy with the bullet for the references right now. That said, I don't really have another idea to display it, and I feel like it's still very valuable information for most types.

Perhaps the Implementations, Interfaces and Usages sections could be encapsulated in an expandable section?

I kind of fail to understand what you mean here. Would you be able to provide me with a mockup/design idea so we can discuss around it? Or if you feel adventurous, you are welcome to try to implement what you see in a PR. (See the contribution guide for that).

@BoilerTom90
Copy link
Author

I picked our worse case Interface/Type for our example... mainly because that's the one that stood out the most, but also the one we use the most.

I'll try to give it some thought regarding different ways to lay out the information, and solicit ideas from some others I work with.... stay tuned...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants