anvilco / spectaql

Autogenerate static GraphQL API documentation
https://useanvil.com/docs/api/graphql/reference/
MIT License
1.09k stars 116 forks source link

Feature Request: Modals #194

Open knotenpunkt opened 2 years ago

knotenpunkt commented 2 years ago

hey it would be nice if we can show parts of the documents (additional) in a Modal-View.

So the Scalar-Types for example can be shown in a Modal. If I click on String i dont fly to the position, where the String-Scalar is described, but the String-Scalar information is shown in a Modal.

This coould be also be done for other information, normal types and so on.

The question hiere is when i jump to the position in the page where the information is, and when a Modal is opend for that. Sometimes it would be also nice having booth. So the String-Scalar is openend in the Modal but also is in the normal page.

There could be some automatic rules to choose when a Modal is opened and when not. Additional could the user (the documentaion-creator^^) give there some more rules and decidede manually when it should be opened and when not.

Scalars would be a good candidate for automatically opened in the Modal.

So if the Scalaras then are also not anymore shown in the sidebar/the-main-page dirctly the document seems not anymore so voluminous and more compact.

knotenpunkt commented 2 years ago

@newhouse what you mean with triaging?

newhouse commented 2 years ago

@newhouse what you mean with triaging?

It means I'm thinking about it and its implications and difficulty, etc. There are a lot of things I could do, and I have limited time. I'm letting this one simmer a bit.