babel-plugin-lucide-react-native

English | 中文

🎉 v1.0.0 The plugin released first stable version! This version covered most usage scenes. full usage cases
🐛 Bugs: Please file an issue for bugs, missing documentation, or unexpected behavior.
💡 Feature Requests: Please file an issue to suggest new features.
⭐ Star Welcome！If this plugin helped you, please give me a star❤️

📖 Documentation

This plugin is a transform to remove unused lucide icon dependencies in React Native, without forcing the user to cherry pick methods manually. This lets you use lucide-react-native naturally (aka as documented) without worrying about bundling parts you're not using.

Example

Converts

1import { BookHeart, Search } from "lucide-react-native";
2
3function App() {
4  return (
5    <View>
6      <BookHeart />
7      <Search />
8    </View>
9  );
10}

Roughly to

1import BookHeart from "lucide-react-native/dist/esm/icons/book-heart";
2import Search from "lucide-react-native/dist/esm/icons/search";
3
4function App() {
5  return (
6    <View>
7      <BookHeart />
8      <Search />
9    </View>
10  );
11}

Limitations

• You must be using ES6 imports (both specifiers and default work) to load lucide-react-native.

FAQ

I receive TypeError: The plugin "lucide-react-native" didn’t export a Plugin instance
or, can I use this plugin with Babel v5?

Ensure your Babel version is 7.0.0 or higher. This plugin is only compatible with Babel 7.

Usage

Via babel.config.js (Recommended)

1{
2  "plugins": ["lucide-react-native"]
3}

or

1{
2  "plugins": [
3    [
4      "lucide-react-native",
5      {
6        "useES": true
7      }
8    ]
9  ]
10}

when useES is set to true, it will use lucide-react-native/dist/esm/ instead of lucide-react-native/dist/cjs/. Default: false.

---

Inspiration

This is inspired by babel-plugin-ramda