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

[Docs]: Address "dependency-free" #116

Open
FlorianWendelborn opened this issue Jan 31, 2025 · 2 comments
Open

[Docs]: Address "dependency-free" #116

FlorianWendelborn opened this issue Jan 31, 2025 · 2 comments

Comments

@FlorianWendelborn
Copy link

FlorianWendelborn commented Jan 31, 2025

NumberFlow version

@number-flow/[email protected]

Framework version

[email protected]

Describe the bug and the steps to reproduce it

Currently, the documentation claims this package is dependency-free:

description={`A ${componentType} to animate numbers. Dependency-free. Accessible. Customizable.`}

However, the package.json does not reflect that. I think it’s easy to dismiss the internal dependency on number-flow, but there is also a seemingly external dependency on esm-env

There are probably very good reasons for this, or this might just be an oversight, but I think either those reasons should be addressed or the "dependency-free" claim should be removed

Minimal reproduction

https://number-flow.barvian.me/

@barvian
Copy link
Owner

barvian commented Jan 31, 2025

Hi, thanks for bringing this up. I'm sure some people will disagree, but I give esm-env a pass here because to me it's more of a bundler hack than an external dependency. There's no trace of it left in the final bundle, and it makes the final bundle smaller rather than bigger because it helps bundlers eliminate the server-only or client-only code.

@FlorianWendelborn
Copy link
Author

Hmm, perhaps this could be added to the very bottom of the limitations section or so. If one doesn’t recognize esm-env it’s not really obvious that it wouldn’t actually be used in the runtime

@barvian barvian changed the title Documentation: Address "dependency-free" [Docs]: Address "dependency-free" Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants