docs/guide/packages/lucide-react-native.md
React Native components for Lucide icons that work seamlessly across iOS and Android platforms. Built on top of react-native-svg, each icon renders as a native SVG component, providing consistent visual appearance and performance across mobile devices.
What you can accomplish:
First, ensure that you have react-native-svg (version between 12 and 15) installed. Then, install the package:
::: code-group
pnpm add lucide-react-native
yarn add lucide-react-native
npm install lucide-react-native
bun add lucide-react-native
:::
Each icon can be imported as a React component.
Additional props can be passed to adjust the icon:
import { Camera } from 'lucide-react-native';
// Usage
const App = () => {
return <Camera color="red" size={48} />;
};
export default App;
| name | type | default |
|---|---|---|
size | number | 24 |
color | string | currentColor |
strokeWidth | number | 2 |
absoluteStrokeWidth | boolean | false |
To customize the appearance of an icon, you can pass custom properties as props directly to the component. The component accepts all SVG attributes as props, which allows flexible styling of the SVG elements.
// Usage
const App = () => {
return <Camera fill="red" />;
};
Lucide Lab is a collection of icons that are not part of the Lucide main library.
They can be used by using the Icon component.
All props like regular Lucide icons can be passed to adjust the icon appearance.
Icon componentThis creates a single icon based on the iconNode passed and renders a Lucide icon component.
import { Icon } from 'lucide-react-native';
import { coconut } from '@lucide/lab';
const App = () => (
<Icon iconNode={coconut} />
);
It is possible to create one generic icon component to load icons, but it is not recommended.
::: warning
The example below imports all ES Modules, so exercise caution when using it. Importing all icons will significantly increase the build size of the application, negatively affecting its performance. This is especially important to keep in mind when using bundlers like Webpack, Rollup, or Vite.
:::
import * as icons from 'lucide-react-native/icons';
interface IconProps {
name: keyof typeof icons;
color?: string;
size?: number;
}
const Icon = ({ name, color, size }: IconProps) => {
const LucideIcon = icons[name];
return <LucideIcon color={color} size={size} />;
};
export default Icon;
import Icon from './Icon';
const App = () => {
return <Icon name="House" />;
};
export default App;