asyncapi / asyncapi-react

React component for rendering documentation from your specification in real-time in the browser. It also provides a WebComponent and bundle for Angular and Vue
https://asyncapi.github.io/asyncapi-react/
Apache License 2.0
188 stars 126 forks source link

Suggestion to add description on the tooltips of the tags pill #1084

Closed aditygrg2 closed 1 month ago

aditygrg2 commented 1 month ago

Description

Currently if there are any descriptions available on the pill, they are not shown.

Screenshot 2024-10-14 at 11 05 04

Here, external docs have a description, but it is just not shown in visual info. The suggestion is to show the description on the tooltip so when the user hovers over it, it can be shown.

Reasons

Description often contains valuable information about any tags, for example what that pill will take you to, or a better explanation of that tag.

The solution I am thinking of is using a react-tooltip which can do the work for us.

github-actions[bot] commented 1 month ago

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Manancode commented 1 month ago

I've created a PR to address this issue: #1090 The PR proposes adding tooltip functionality to display descriptions for tags pills. It includes a new TooltipWrapper component, but I failed to locate the external docs information. I will make another PR wrapping the docs with the TooltipWrapper component It would be really helpful if someone helps me with that @aditygrg2

Manancode commented 1 month ago

Sir linked a new PR for it . Please Checkout @catosaurusrex2003

AceTheCreator commented 1 month ago

issue resolved by #1093