mirror of
https://github.com/lucide-icons/lucide.git
synced 2026-11-16 14:18:29 +00:00
* Add more music icons and another mic icon (#746)
* Revert "Add more music icons and another mic icon (#746)" (#750)
This reverts commit 57cba6ae0e.
* add scale Stroke width
* Added scaleStrokeWidth prop to all packages
* Add scaleStrokeWidth to types
* Rename scaleStrokeWidth to absoluteStrokeWidth
* Adds common API elements to the Angular package (#949)
* Almost complete rewrite of the Angular package
* Update tsconfig.spec.json
* fixes icon build export file name
* Updates Angular documentation with the new properties + provider injection
* Update lucide-angular.md
* refactored scaleStrokeWidth to be absoluteStrokeWidth to match other packages
* removed codelyzer from devDeps + added flexible angular core dependencies
* Deprecates createElement helper in favour of Renderer2 to support SSR
---------
Co-authored-by: Karsa <karsa@karsa.org>
* Add absoluteStrokeWidth in docs
* update snapshots
* Manual merge of main
* Fixed incorrectly merged pnpm-lock.yaml
* Fixes lucide-angular build
* [lucide-angular] Global configuration for properties + bugfix for legacy icon provider (#1012)
* Almost complete rewrite of the Angular package
* Update tsconfig.spec.json
* fixes icon build export file name
* Updates Angular documentation with the new properties + provider injection
* Update lucide-angular.md
* refactored scaleStrokeWidth to be absoluteStrokeWidth to match other packages
* removed codelyzer from devDeps + added flexible angular core dependencies
* Deprecates createElement helper in favour of Renderer2 to support SSR
* Added global configuration and fixed undefined bug in legacy icon provider. Also updated README.md
* Replaces removed line in README.md
* Fixes merge error
* Updates export template to use the non-deprecated type
* downgrade building to ng-cli@13
* downgrade to es2020
---------
Co-authored-by: Karsa <karsa@karsa.org>
* rename scaleStrokeWidth to absoluteStrokeWidth in readme
---------
Co-authored-by: it-is-not <72697755+it-is-not@users.noreply.github.com>
Co-authored-by: Karsa <contact@karsa.org>
Co-authored-by: Eric Fennis <eric@dreamteam.nl>
Co-authored-by: Karsa <karsa@karsa.org>
Co-authored-by: Eric Fennis <eric.fennis@nac41112.nedap.local>
110 lines
2.8 KiB
Markdown
110 lines
2.8 KiB
Markdown
# Lucide Angular
|
|
|
|
Implementation of the lucide icon library for Angular applications.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
yarn add lucide-angular
|
|
```
|
|
|
|
or
|
|
|
|
```bash
|
|
npm install lucide-angular
|
|
```
|
|
|
|
## How to use
|
|
|
|
### Step 1: Import `LucideAngularModule`
|
|
|
|
In any Angular module you wish to use Lucide icons in, you have to import `LucideAngularModule`, and pick any icons you wish to use:
|
|
|
|
```js
|
|
import { LucideAngularModule, File, Home, Menu, UserCheck } from 'lucide-angular';
|
|
|
|
@NgModule({
|
|
imports: [
|
|
LucideAngularModule.pick({File, Home, Menu, UserCheck})
|
|
]
|
|
})
|
|
export class AppModule { }
|
|
```
|
|
|
|
### Step 2: Use the icons in templates
|
|
|
|
Within your templates you may now use one of the following component tags to insert an icon:
|
|
|
|
```html
|
|
<lucide-angular name="file" class="my-icon"></lucide-angular>
|
|
<lucide-icon name="home" class="my-icon"></lucide-icon>
|
|
<i-lucide name="menu" class="my-icon"></i-lucide>
|
|
<span-lucide name="user-check" class="my-icon"></span-lucide>
|
|
```
|
|
|
|
### Props
|
|
|
|
You can pass additional props to adjust the icon appearance.
|
|
|
|
| name | type | default |
|
|
| --------------------- | --------- | ------------ |
|
|
| `size` | *number* | 24 |
|
|
| `color` | *string* | currentColor |
|
|
| `strokeWidth` | *number* | 2 |
|
|
| `absoluteStrokeWidth` | *boolean* | false |
|
|
|
|
```html
|
|
<i-lucide name="home" [size]="48" color="red" [strokeWidth]="1"></i-lucide>
|
|
```
|
|
|
|
### Global configuration
|
|
|
|
You can inject the `LucideIconConfig` service in your root component to globally configure the default property values as defined above.
|
|
|
|
### Styling using a custom CSS class
|
|
|
|
Any extra HTML attribute is ignored, but the `class` attribute
|
|
is passed onto the internal SVG image element and it can be used to style it:
|
|
|
|
```css
|
|
svg.my-icon {
|
|
width: 12px;
|
|
height: 12px;
|
|
stroke-width: 3;
|
|
}
|
|
```
|
|
|
|
## Injecting multiple icon providers
|
|
|
|
You may provide additional icons using the `LUCIDE_ICONS` injection token,
|
|
which accepts multiple providers of the interface `LucideIconsProviderInterface`
|
|
with the utility class `LucideIconsProvider` available for easier usage:
|
|
|
|
```js
|
|
import { LUCIDE_ICONS, LucideIconProvider } from 'lucide-angular';
|
|
import { MyIcon } from './icons/my-icon';
|
|
|
|
const myIcons = {MyIcon};
|
|
|
|
@NgModule({
|
|
providers: [
|
|
{provide: LUCIDE_ICONS, multi: true, useValue: new LucideIconProvider(myIcons)},
|
|
]
|
|
})
|
|
export class AppModule { }
|
|
```
|
|
|
|
To add custom icons, you will first need to convert them to an [svgson format](https://github.com/elrumordelaluz/svgson).
|
|
|
|
## Loading all icons
|
|
|
|
> :warning: You may also opt to import all icons if necessary using the following format but be aware that this will significantly increase your application build size.
|
|
|
|
```js
|
|
import { icons } from 'lucide-angular';
|
|
|
|
...
|
|
|
|
LucideAngularModule.pick(icons)
|
|
```
|