search

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 127 forks source link

feat : Add description tooltips to tags pills #1090

Closed Manancode closed 1 month ago

Manancode commented 1 month ago

I've created a reusable TooltipWrapper component in library/src/components/TooltipWrapper.tsx However, I've been unable to locate the exact component or file where the External Docs information is currently rendered. As a result, I can't yet implement the full solution. It would be helpful if someone helps me with the location of external docs information . Till then I am submitting this draft PR which includes a TooltipWrapper component.

asyncapi-bot commented 1 month ago

We require all PRs to follow Conventional Commits specification. More details 👇🏼

 No release type found in pull request title "feat : Add description tooltips to tags pills". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit
catosaurusrex2003 commented 1 month ago

Hey @Manancode

i would suggest

instead of adding any new dependencies for tootips

we can use the native tool-tips title of html just like how it has been done in tags here in https://github.com/asyncapi/asyncapi-react/blob/master/library/src/components/Href.tsx#L18

also rename your pr from feat : {your text} to feat: {your text} . we follow https://www.conventionalcommits.org/en/v1.0.0/ and hence your Pr linting is failing.

sonarcloud[bot] commented 1 month ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud