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

Undocumented breaking change from lucide-angular v0.291.0 to v0.292.0 #1735

Closed
4 of 25 tasks
R-Bower opened this issue Dec 21, 2023 · 2 comments
Closed
4 of 25 tasks

Undocumented breaking change from lucide-angular v0.291.0 to v0.292.0 #1735

R-Bower opened this issue Dec 21, 2023 · 2 comments
Labels
🐛 bug Something isn't working

Comments

@R-Bower
Copy link

R-Bower commented Dec 21, 2023

Package

  • lucide
  • lucide-angular
  • lucide-flutter
  • lucide-preact
  • lucide-react
  • lucide-react-native
  • lucide-solid
  • lucide-svelte
  • lucide-vue
  • lucide-vue-next
  • Figma plugin
  • source/main
  • other/not relevant

Version

v0.291.0

Browser

  • Chrome/Chromium
  • Firefox
  • Safari
  • Edge
  • iOS Safari
  • Opera
  • Other/not relevant

Operating system

  • Windows
  • Linux
  • macOS
  • Other/not relevant

Description

The data type of LucideIconData changed in 0.292.0. This change was not documented.

lucide-angular is deeply integrated in our component library. This change is technically breaking because it modifies the type of the Input properties on some of our components.

Example property:

  /**
   * {@link https://lucide.dev/icons lucide-angular} icon, positioned after the label.
   * Can also be supplied as a TemplateRef.
   */
  @Input() endIcon?: LucideIconData | TemplateRef<any>

0.291.0

export type LucideIconData = readonly [string, HtmlAttributes, LucideIconNode[]?];

0.292.0

export type LucideIconData = readonly LucideIconNode[];

Are there plans to support semver? I'd like to avoid future breaking changes, if possible. Thanks!

Steps to reproduce

Inspect the change from 0.291.0 to 0.292.0

0.291.0

https://github.com/lucide-icons/lucide/blob/0.291.0/packages/lucide-angular/src/icons/types/index.ts#L3

0.292.0

https://github.com/lucide-icons/lucide/blob/0.292.0/packages/lucide-angular/src/icons/types/index.ts

Checklist

  • I have searched if someone has submitted a similar issue before and there weren't any. (Please make sure to also search closed issues, as this issue might already have been resolved.)
@R-Bower R-Bower added the 🐛 bug Something isn't working label Dec 21, 2023
@karsa-mistmere
Copy link
Member

Hey @R-Bower,

It was changed in #1641 as part of us getting ready for Lucide v1 and a larger infrastructure based on the new format - a format that's already used by all our other packages.

But you're absolutely right, we could've added this to release notes. (even if third party usage of this format is not documented either).

@karsa-mistmere
Copy link
Member

I retroactively added this to the release notes: https://github.com/lucide-icons/lucide/releases/tag/0.292.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants