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

feat(docs): Add deprecated badge for icons with deprecation status #2618

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

epifaniofrancisco
Copy link
Contributor

@epifaniofrancisco epifaniofrancisco commented Nov 17, 2024

What is the purpose of this pull request?

  • New Icon
  • Bug fix
  • New Feature
  • Documentation update
  • Other:

Description

This pull request introduces a "Deprecated" badge that appears for icons flagged as deprecated in the IconInfo.vue component. This update improves the user interface by clearly indicating which icons are deprecated, helping users avoid using outdated assets.

Changes Made:

  • Badge Component: Added a Badge component to display the "Deprecated" label next to icons flagged as deprecated.
  • Conditional Badge Display: Updated IconInfo.vue to conditionally show the deprecated badge if the icon has the deprecated property set to true.
  • Tooltip with Deprecation Details: Included a tooltip that provides additional context on hover, displaying the reason for deprecation and the version in which the icon will be removed.

Testing:

Manually tested the badge display on various icons, ensuring the tooltip shows the correct deprecation reason and version.
Verified the badge does not appear for icons without the deprecated property.

Screenshots:
Before:
image

After:
image

Before Submitting

@github-actions github-actions bot added the 🌍 site Has to do something with the Lucide website label Nov 17, 2024
@epifaniofrancisco
Copy link
Contributor Author

@jguddas @ericfennis Is this feature for the icons not beneficial? Can I close this PR?

@ericfennis
Copy link
Member

@epifaniofrancisco sorry for late reply.
Yess this very useful!

I think I want to make some adjustments in the design of the UI!

@lucide-icons lucide-icons deleted a comment from github-actions bot Dec 19, 2024
@epifaniofrancisco
Copy link
Contributor Author

No problem at all! I'm glad you found it useful. Let me know what adjustments you have in mind for the UI, and we can work on it together!

@github-actions github-actions bot removed the Stale label Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌍 site Has to do something with the Lucide website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants