Files
lucide/packages/lab/README.md

134 lines
2.0 KiB
Markdown

# Lucide Lab
## Installation
```sh
npm install @lucide/lab
```
```sh
yarn add @lucide/lab
```
```sh
pnpm install @lucide/lab
```
> [!NOTE]
> Requires Lucide core package to be installed in your project. For more info visit [lucide installation guide](https://lucide.dev/guide/installation).
## Usage
### React
```jsx
import { burger } from '@lucide/lab';
import { Icon } from 'lucide-react';
function App() {
return (
<div>
<Icon iconNode={burger} />
</div>
);
}
```
### Vue
```vue
<script setup>
import { burger } from '@lucide/lab';
import { Icon } from '@lucide/vue';
</script>
<template>
<div>
<Icon :iconNode="burger" />
</div>
</template>
```
### Angular
```angular
// app.module.ts
import { LucideAngularModule } from 'lucide-angular';
import { atSignCircle } from '@lucide/lab';
@NgModule({
imports: [
LucideAngularModule.pick({ AtSignCircle: atSignCircle })
],
})
// app.component.html
<lucide-icon name = "AtSignCircle" > </lucide-icon>
```
### Svelte
```svelte
<script>
import { Icon } from '@lucide/svelte';
import { burger, sausage } from '@lucide/lab';
</script>
<Icon iconNode={burger} />
<Icon iconNode={sausage} color="red"/>
```
### Solid
```jsx
import { burger } from '@lucide/lab';
import { Icon } from 'lucide-solid';
function App() {
return (
<div>
<Icon iconNode={burger} />
</div>
);
}
```
### Preact
```jsx
import { burger } from '@lucide/lab';
import { Icon } from 'lucide-preact';
function App() {
return (
<div>
<Icon iconNode={burger} />
</div>
);
}
```
### React Native
```jsx
import { burger } from '@lucide/lab';
import { Icon } from 'lucide-react-native';
function App() {
return (
<div>
<Icon iconNode={burger} />
</div>
);
}
```
## Community
Join the community on our [Discord](https://discord.gg/EH6nSts) server!
## License
Lucide is totally free for commercial and personal use; this software is licensed under the [ISC License](https://github.com/lucide-icons/lucide/blob/main/LICENSE).