Skip to content

a16n-dev/lucide-nativewind

Repository files navigation

Lucide Icons for React Native with NativeWind

npm NPM Downloads GitHub

A drop in replacement for lucide-react-native to work with NativeWind. It provides Lucide icons with an additional className prop to allow for easy integration with NativeWind.

Installation

You can use either npm or yarn:

Using npm:

npm install lucide-nativewind

Using yarn:

yarn add lucide-nativewind

Usage

lucide-nativewind is built with ES modules so it's completely tree-shakable. Each icon can be imported as a react component.

All icons can be imported the same as if using the lucide-react-native package

- import { ArrowLeftCircleIcon } from 'lucide-react-native';
+ import { ArrowLeftCircleIcon } from 'lucide-nativewind';

Custom Icons

Custom icons can be wrapped with iconWithClassName to add the className prop.

import { iconWithClassName } from 'lucide-nativewind';
import MyCustomIcon from './MyCustomIcon';

const MyCustomIconWithClassName = iconWithClassName(MyCustomIcon);

Versioning

The version is automatically kept in sync with lucide-react-native

Contributing

All contributions welcome. Contributions/requests for new/updated icons should be directed to the lucide project: https://github.com/lucide-icons/lucide

FAQs

What icons are available?

All lucide icons are available, and this package will be updated whenever new icons are added to lucide. This package is not intended to add any additional or custom icons.

About

Lucide icons that work across react and react native, with nativewind (classname) support

Resources

License

Stars

Watchers

Forks