mirror of
https://github.com/lucide-icons/lucide.git
synced 2026-11-17 14:28:25 +00:00
docs(version-1): Version 1 website (#4142)
* Update images * Adjust color * update accessebility * Add matrix hero * Add typescript documentation * Add basics section to vue pages * Add svelte docs * Fix dynamic sidebar * Add animation? * Some adjustments * Adjust animation * Updates docs * Add scaledown animation * Add docs for vue types * Fix layout accessibility page * fix framework select * adjust easing home animation * Write docs for Vue * Adjust animation home * Adjust home hero animation * Finish svelte docs * Add solid pages * remove spiral animation component * Add group icons * Added solid docs * update preact docs * Adjust examples preact docs * Add snackplayer * Get new editor * Save this * Add examples * Adjust styling * setup custom sandpack * Add script * Format files * Make sandpack plugin work * migrate react docs * Fix svelte and solid examples * Migrate to solid packages * Add darkmode package logos * Fix bug in selector * migrate vue examples * migrate advanced vue items * migrate preact and svelte examples * Add astro docs * adding more docs on guide for lucide library * Fix home animation * Cleanup * Added resources page, with more details and content * Add hero badge for Version 1 * Fix vercel json * Update missing paths * Fix build? * Replace lucide-vue-next * Fix build * Add some docs * update markdown * Setup angular docs * Add basic angular docs * Adjust code examples * Update title and descriptions * Update accessibility link * Update title and description * Add og image * Fix alignment * Add migration guides * Adjust version 1 markdown file * Add migration guide to the main list * Minor fixes * Update docs * Apply feedback * Select icons * Add pointer events none * Fix package links homepage * Format code * Fix types * Fix focus * Fix build * Fix focus * Apply feedback * Adjust imports * Adjust imports * Fix search * Apply feedback * Fix import in font docs * Small fixes * docs(guide): added easter egg icon. stay tuned, guys 😉 * Add llm txt plugin * Adjust logo top * docs(version-1): upgraded @lucide/angular guide for v1 website (#4144) * docs(guide/angular): rewrite some angular documentation * docs(guide/angular): extens angular guide with combining icons & icon provider guides * docs(guide/angular): fix angular sandbox, still needs @lucide/angular release tho * docs(guide/angular): rework the getting started page a bit more, refactor some more prop=>input occurences * docs(guide/angular): context provider => provideLucideConfig * Update docs/guide/angular/migration.md Co-authored-by: Eric Fennis <eric.fennis@gmail.com> * Update docs/guide/angular/advanced/combining-icons.md Co-authored-by: Eric Fennis <eric.fennis@gmail.com> * Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs(guide/angular): rework a11y for better flow & pacing * docs(guide/angular): salvage original phrase, it has better flow * docs(guide/angular): some more a11y nitpicking * docs(guide/angular): reduce llm fatigue * docs(guides/angular): fix app component selector * docs(guides/angular): fix angular sandpacks * Add sandpack angular to improve tree-shakable stack * Update docs/guide/angular/getting-started.md * docs(guides/angular): fix user import in combinding icons guide * docs(guides/angular): fix nested SVG phrasing * Update docs/guide/angular/advanced/with-lucide-lab.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/guide/angular/advanced/filled-icons.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * docs(guides/angular): fix createLucideIcon guide * docs(guides/angular): upgrade all relevant angular sandpack demos --------- Co-authored-by: Eric Fennis <eric.fennis@gmail.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * fix(docs): add autogenerated OG images to gitignore * fix(docs): unify the case of "Lucide" & "Lucide Lab" over all docs and readmes * Fix build * Add next tag to all installation guides * Add top bar notification * Minor fixes * Update text * Add todos * Update og image * Adjust install command * Color top bar * fix(docs): ignore all OG images, expect general.png * fix(docs): fix the package list, hide @lucide/icons, downgrade angular logo, link to v0 guide, fix package title alignment * Update docs/.vitepress/theme/components/base/LayoutTop.vue Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/guide/react/advanced/dynamic-icon-component.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/.vitepress/sidebar/resources.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix code example * fix(docs): version 1 => Version 1 * feat(docs): add angular to new features in v1 * Fix next line issue * feat(docs): fix typo (code example_s_) * Fix deadlink * feat(docs): fix some more typos and irky grammar * feat(docs): fix lowercase lucide in sidebar 😅 * Update docs/guide/version-1.md Co-authored-by: Karsa <contact@karsa.org> --------- Co-authored-by: Karsa <contact@karsa.org> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
co-authored by
Copilot Autofix powered by AI
Karsa
parent
e715245d62
commit
484f2c9cd3
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: Accessibility - Angular
|
||||
description: Best practices for accessible icons in your Angular application.
|
||||
---
|
||||
|
||||
<script setup>
|
||||
import OverviewLink from '~/.vitepress/theme/components/base/OverviewLink.vue'
|
||||
</script>
|
||||
|
||||
# Accessibility
|
||||
|
||||
Lucide icons ship with `aria-hidden="true"` by default. In almost all cases this is exactly what you want.
|
||||
|
||||
## Should icons be accessible?
|
||||
|
||||
Most of the time, icons are used purely for decoration or visual reinforcement. Exposing decorative icons to assistive technologies can create unnecessary noise for screen reader users.
|
||||
|
||||
For a broader explanation of this, and other best practices on how to use icons accessibly in your application, please refer to our detailed guide on accessibility:
|
||||
|
||||
<OverviewLink href="/guide/accessibility" title="Accessible Icons" desc="Best practices for accessible icons in your application."/>
|
||||
|
||||
Only if an icon **conveys essential meaning on its own** should it be made accessible. The sections below explain how to do that in Angular.
|
||||
|
||||
## Making an Icon Accessible
|
||||
|
||||
To expose an icon to assistive technologies, provide an accessible name by binding the `title` input of the icon component.
|
||||
|
||||
This removes the `aria-hidden` attribute and makes the icon visible to screen readers.
|
||||
|
||||
```angular-html
|
||||
<svg lucideHouse title="This is my house" />
|
||||
```
|
||||
|
||||
Choose a label that clearly describes the meaning of the icon or the action it represents in the context of your application.
|
||||
|
||||
## Accessible Icon Buttons
|
||||
|
||||
When an icon is used inside a button, the accessible label should usually be applied to the button itself, and not the icon.
|
||||
|
||||
```angular-html
|
||||
<button aria-label="Go to home">
|
||||
<svg lucideHouse></svg>
|
||||
</button>
|
||||
```
|
||||
|
||||
This ensures assistive technologies describe the interactive element, rather than the decorative graphic inside it.
|
||||
@@ -0,0 +1,119 @@
|
||||
---
|
||||
title: Combining icons - Angular
|
||||
description: Learn how to combine multiple icons into a single icon nested SVG elements in your Angular application.
|
||||
---
|
||||
<script setup>
|
||||
import Sandpack from '~/.vitepress/theme/components/editors/SandpackAngular.vue'
|
||||
</script>
|
||||
|
||||
# Combining icons
|
||||
|
||||
You can combine multiple icons into a single icon by using SVG in SVG.
|
||||
This is useful for if you want to be creative and make your own custom icons by combining existing icons.
|
||||
|
||||
::: sandpack {template=angular showTabs=false editorHeight=400 editorWidthPercentage=60 dependencies="@lucide/angular"}
|
||||
|
||||
```ts /src/app/app.component.ts [active]
|
||||
import { Component, ViewEncapsulation } from "@angular/core";
|
||||
import { LucideScan, LucideUser } from "@lucide/angular";
|
||||
|
||||
@Component({
|
||||
selector: 'app',
|
||||
imports: [LucideScan, LucideUser],
|
||||
template: `
|
||||
<svg lucideScan [size]="48">
|
||||
<svg lucideUser
|
||||
[size]="12"
|
||||
x="6"
|
||||
y="6"
|
||||
[strokeWidth]="4"
|
||||
[absoluteStrokeWidth]="true"
|
||||
/>
|
||||
</svg>`,
|
||||
styleUrls: ['./app.component.css'],
|
||||
encapsulation: ViewEncapsulation.None,
|
||||
})
|
||||
export class App {
|
||||
}
|
||||
```
|
||||
:::
|
||||
|
||||
This is valid SVG and all SVG properties are supported on the icons.
|
||||
The `x` and `y` coordinates can be adjusted to position the icons as you like.
|
||||
|
||||
::: info Limitation
|
||||
When combining icons, you need to make sure that the `x` and `y` coordinates are within the `viewBox` of the outer icon (24x24).
|
||||
:::
|
||||
|
||||
## With custom SVG elements
|
||||
|
||||
You can also use SVG elements to create your own icons.
|
||||
|
||||
### Example with notification badge
|
||||
|
||||
For example, you can add a notification badge to an icon by using the `circle` SVG element.
|
||||
|
||||
|
||||
::: sandpack {template=angular showTabs=false editorHeight=400 editorWidthPercentage=60 dependencies="@lucide/angular"}
|
||||
|
||||
```ts /src/app/app.component.ts [active]
|
||||
import { Component, ViewEncapsulation, signal } from "@angular/core";
|
||||
import { LucideMail } from "@lucide/angular";
|
||||
|
||||
@Component({
|
||||
selector: 'app',
|
||||
imports: [LucideMail],
|
||||
template: `
|
||||
<svg lucideMail [size]="48">
|
||||
@if (hasUnreadMessages()) {
|
||||
<circle
|
||||
r="3"
|
||||
cx="21"
|
||||
cy="5"
|
||||
stroke="none"
|
||||
fill="#F56565"
|
||||
/>
|
||||
}
|
||||
</svg>`,
|
||||
styleUrls: ['./app.component.css'],
|
||||
encapsulation: ViewEncapsulation.None,
|
||||
})
|
||||
export class App {
|
||||
protected readonly hasUnreadMessages = signal<boolean>(true);
|
||||
}
|
||||
```
|
||||
:::
|
||||
|
||||
### Example with text element
|
||||
|
||||
You can also use the `text` SVG element to add text to your icon.
|
||||
|
||||
|
||||
::: sandpack {template=angular showTabs=false editorHeight=400 editorWidthPercentage=60 dependencies="@lucide/angular"}
|
||||
|
||||
```ts /src/app/app.component.ts [active]
|
||||
import { Component, ViewEncapsulation } from "@angular/core";
|
||||
import { LucideFile } from "@lucide/angular";
|
||||
|
||||
@Component({
|
||||
selector: 'app',
|
||||
imports: [LucideFile],
|
||||
template: `
|
||||
<svg lucideFile [size]="48">
|
||||
<text
|
||||
x="7.5"
|
||||
y="19"
|
||||
font-size="8"
|
||||
font-family="Verdana,sans-serif"
|
||||
stroke-width="1"
|
||||
>
|
||||
JS
|
||||
</text>
|
||||
</svg>`,
|
||||
styleUrls: ['./app.component.css'],
|
||||
encapsulation: ViewEncapsulation.None,
|
||||
})
|
||||
export class App {
|
||||
}
|
||||
```
|
||||
:::
|
||||
@@ -0,0 +1,65 @@
|
||||
---
|
||||
title: Filled Icons - Angular
|
||||
description: Fills are not officially supported, but can still be applied using standard SVG attributes. This may in some cases produce acceptable results.
|
||||
---
|
||||
<script setup>
|
||||
import Sandpack from '~/.vitepress/theme/components/editors/SandpackAngular.vue'
|
||||
</script>
|
||||
|
||||
# Filled Icons
|
||||
|
||||
Fills are not officially supported by Lucide.
|
||||
|
||||
However, since the icons are standard SVG elements, SVG attributes such as `fill` can still be applied. Depending on the icon, this may produce acceptable results.
|
||||
|
||||
## Example with stars:
|
||||
|
||||
::: sandpack {template=angular editorHeight=580 editorWidthPercentage=60 dependencies="@lucide/angular"}
|
||||
|
||||
```css /src/app/icon.css
|
||||
.star-rating {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.stars {
|
||||
display: flex;
|
||||
gap: 4px;
|
||||
}
|
||||
|
||||
.rating {
|
||||
position: absolute;
|
||||
top: 0;
|
||||
}
|
||||
```
|
||||
|
||||
```ts /src/app/app.component.ts [active]
|
||||
import { Component, ViewEncapsulation } from "@angular/core";
|
||||
import { LucideStar, LucideStarHalf } from "@lucide/angular";
|
||||
|
||||
@Component({
|
||||
selector: 'app',
|
||||
imports: [LucideStar, LucideStarHalf],
|
||||
template: `
|
||||
<div class="star-rating">
|
||||
<div class="stars">
|
||||
<svg lucideStar fill="#111" strokeWidth="0" />
|
||||
<svg lucideStar fill="#111" strokeWidth="0" />
|
||||
<svg lucideStar fill="#111" strokeWidth="0" />
|
||||
<svg lucideStar fill="#111" strokeWidth="0" />
|
||||
<svg lucideStar fill="#111" strokeWidth="0" />
|
||||
</div>
|
||||
<div class="stars rating">
|
||||
<svg lucideStar fill="yellow" strokeWidth="0" />
|
||||
<svg lucideStar fill="yellow" strokeWidth="0" />
|
||||
<svg lucideStarHalf fill="yellow" strokeWidth="0" />
|
||||
</div>
|
||||
</div>
|
||||
`,
|
||||
styleUrls: ['./app.component.css', './icon.css'],
|
||||
encapsulation: ViewEncapsulation.None,
|
||||
})
|
||||
export class App {
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
@@ -0,0 +1,184 @@
|
||||
---
|
||||
title: Global Styling - Angular
|
||||
description: Learn how to style all icons globally in your Angular application using CSS or the provideLucideConfig provider.
|
||||
---
|
||||
<script setup>
|
||||
import Sandpack from '~/.vitepress/theme/components/editors/SandpackAngular.vue'
|
||||
</script>
|
||||
|
||||
# Global Styling
|
||||
|
||||
Lucide icons can be customized using the inputs for [color](../basics/color.md), [size](../basics/sizing.md) and [stroke width](../basics/stroke-width.md).
|
||||
|
||||
To style all icons globally, you can either use CSS or configure global defaults using `provideLucideConfig`.
|
||||
|
||||
We recommend using CSS for global styling, as it is the most straightforward approach. However, CSS rules may override the `size`, `color`, and `strokeWidth` inputs on individual icons. If you need to keep those inputs configurable per icon, use `provideLucideConfig` instead.
|
||||
|
||||
## Configuring global defaults
|
||||
|
||||
Lucide Angular provides the `provideLucideConfig` provider to set default properties for all icons.
|
||||
|
||||
You can define global defaults (such as `size`, `color`, or `strokeWidth`) while still allowing individual icons to override them through inputs.
|
||||
|
||||
Register the provider in your application configuration or in a top-level component:
|
||||
|
||||
```ts
|
||||
import { ApplicationConfig } from '@angular/core';
|
||||
import { provideLucideConfig } from '@lucide/angular';
|
||||
|
||||
export const appConfig: ApplicationConfig = {
|
||||
providers: [
|
||||
provideLucideConfig({
|
||||
strokeWidth: 1.5
|
||||
}),
|
||||
]
|
||||
};
|
||||
```
|
||||
|
||||
## Style by using CSS
|
||||
|
||||
Styling icons globally can be done using CSS.
|
||||
|
||||
All Lucide icons include the `lucide` class. You can use this class in your styles to target every icon in your application.
|
||||
|
||||
- The **color** of the icons can be changed using the [`color`](https://developer.mozilla.org/en-US/docs/Web/CSS/color) property.
|
||||
- The **size** of the icons can be changed using [`width`](https://developer.mozilla.org/en-US/docs/Web/CSS/width) and [`height`](https://developer.mozilla.org/en-US/docs/Web/CSS/height).
|
||||
- The **stroke width** of the icons can be changed using [`stroke-width`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width).
|
||||
|
||||
::: sandpack {template=angular editorHeight=300 dependencies="@lucide/angular"}
|
||||
|
||||
```css /src/app/icon.css [active]
|
||||
.lucide {
|
||||
/* Change this! */
|
||||
color: #ffadff;
|
||||
width: 56px;
|
||||
height: 56px;
|
||||
stroke-width: 1px;
|
||||
}
|
||||
|
||||
.grid {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr 1fr 1fr;
|
||||
grid-template-rows: 1fr 1fr 1fr;
|
||||
gap: 6px;
|
||||
}
|
||||
```
|
||||
|
||||
```ts /src/app/app.component.ts
|
||||
import { Component, ViewEncapsulation } from "@angular/core";
|
||||
import {
|
||||
LucideCakeSlice,
|
||||
LucideCandy,
|
||||
LucideApple,
|
||||
LucideCookie,
|
||||
LucideMartini,
|
||||
LucideIceCream2,
|
||||
LucideSandwich,
|
||||
LucideWine,
|
||||
LucideDessert,
|
||||
} from "@lucide/angular";
|
||||
|
||||
@Component({
|
||||
selector: 'app',
|
||||
imports: [
|
||||
LucideCakeSlice,
|
||||
LucideCandy,
|
||||
LucideApple,
|
||||
LucideCookie,
|
||||
LucideMartini,
|
||||
LucideIceCream2,
|
||||
LucideSandwich,
|
||||
LucideWine,
|
||||
LucideDessert,
|
||||
],
|
||||
template: `<div class="grid">
|
||||
<svg lucideCakeSlice />
|
||||
<svg lucideCandy />
|
||||
<svg lucideApple />
|
||||
<svg lucideCookie />
|
||||
<svg lucideMartini />
|
||||
<svg lucideIceCream2 />
|
||||
<svg lucideSandwich />
|
||||
<svg lucideWine />
|
||||
<svg lucideDessert />
|
||||
</div>`,
|
||||
styleUrls: ['./app.component.css', './icon.css'],
|
||||
encapsulation: ViewEncapsulation.None,
|
||||
})
|
||||
export class App {
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
### Absolute stroke width
|
||||
|
||||
To keep the stroke width constant regardless of icon size, apply `vector-effect: non-scaling-stroke` to the icon's children. See [absolute-stroke-width](../basics/stroke-width.md#absolute-stroke-width) for more details.
|
||||
|
||||
::: sandpack {template=angular editorHeight=300 dependencies="@lucide/angular"}
|
||||
|
||||
```css /src/app/icon.css [active]
|
||||
.lucide {
|
||||
width: 48px;
|
||||
height: 48px;
|
||||
stroke-width: 1.5;
|
||||
}
|
||||
|
||||
.lucide * {
|
||||
vector-effect: non-scaling-stroke;
|
||||
}
|
||||
|
||||
.grid {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr 1fr 1fr;
|
||||
grid-template-rows: 1fr 1fr 1fr;
|
||||
gap: 6px;
|
||||
}
|
||||
```
|
||||
|
||||
```ts /src/app/app.component.ts
|
||||
import { Component, ViewEncapsulation } from "@angular/core";
|
||||
import {
|
||||
LucideTentTree,
|
||||
LucideCaravan,
|
||||
LucideFlameKindling,
|
||||
LucideMountainSnow,
|
||||
LucideTrees,
|
||||
LucideAxe,
|
||||
LucideMap,
|
||||
LucideCloudMoon,
|
||||
LucideSparkles,
|
||||
} from "@lucide/angular";
|
||||
|
||||
@Component({
|
||||
selector: 'app',
|
||||
imports: [
|
||||
LucideTentTree,
|
||||
LucideCaravan,
|
||||
LucideFlameKindling,
|
||||
LucideMountainSnow,
|
||||
LucideTrees,
|
||||
LucideAxe,
|
||||
LucideMap,
|
||||
LucideCloudMoon,
|
||||
LucideSparkles,
|
||||
],
|
||||
template: `<div class="grid">
|
||||
<svg lucideTentTree />
|
||||
<svg lucideCaravan />
|
||||
<svg lucideFlameKindling />
|
||||
<svg lucideMountainSnow />
|
||||
<svg lucideTrees />
|
||||
<svg lucideAxe />
|
||||
<svg lucideMap />
|
||||
<svg lucideCloudMoon />
|
||||
<svg lucideSparkles />
|
||||
</div>`,
|
||||
styleUrls: ['./app.component.css', './icon.css'],
|
||||
encapsulation: ViewEncapsulation.None,
|
||||
})
|
||||
export class App {
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
@@ -0,0 +1,139 @@
|
||||
---
|
||||
title: Icon provider - Angular
|
||||
description: Learn how to register icons globally using provideLucideIcons, including custom and legacy icons.
|
||||
---
|
||||
|
||||
# Icon provider
|
||||
|
||||
You can use the `LucideDynamicIcon` component to render icons by name. To use an icon by name, you must first register it with `provideLucideIcons`.
|
||||
|
||||
Make sure you are well acquainted with [how dependency injection in Angular works](https://angular.dev/guide/di).
|
||||
|
||||
## Registering icons
|
||||
|
||||
Use `provideLucideIcons` in your application providers to register icons.
|
||||
|
||||
```ts [app.config.ts]
|
||||
import { ApplicationConfig } from '@angular/core';
|
||||
import { provideLucideIcons, LucideSquareCheck, LucideCircleAlert } from '@lucide/angular';
|
||||
|
||||
export const appConfig: ApplicationConfig = {
|
||||
providers: [
|
||||
provideLucideIcons(
|
||||
LucideSquareCheck,
|
||||
LucideCircleAlert,
|
||||
),
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
You can then reference the registered icons by name:
|
||||
|
||||
```html [app.html]
|
||||
<svg lucideIcon="square-check"></svg>
|
||||
<svg lucideIcon="circle-alert"></svg>
|
||||
```
|
||||
|
||||
## How names are resolved
|
||||
|
||||
Each registered icon is stored by its icon name. For built-in Lucide icons, this is typically the kebab-case icon name.
|
||||
|
||||
For example, registering `LucideSquareCheck` makes it available as:
|
||||
|
||||
```html
|
||||
<svg lucideIcon="square-check"></svg>
|
||||
```
|
||||
|
||||
If an icon defines aliases, those aliases are also registered automatically.
|
||||
|
||||
## Registering custom icons
|
||||
|
||||
`provideLucideIcons` can also register custom icon data objects.
|
||||
|
||||
```ts [custom-icon.ts]
|
||||
import { LucideIconData } from '@lucide/angular';
|
||||
|
||||
export const MyCustomIcon: LucideIconData = {
|
||||
name: 'my-custom-icon',
|
||||
node: [
|
||||
['circle', { cx: 12, cy: 12, r: 8 }],
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
```ts [app.config.ts]
|
||||
import { ApplicationConfig } from '@angular/core';
|
||||
import { provideLucideIcons } from '@lucide/angular';
|
||||
import { MyCustomIcon } from './custom-icon';
|
||||
|
||||
export const appConfig: ApplicationConfig = {
|
||||
providers: [
|
||||
provideLucideIcons(MyCustomIcon),
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
```html [app.html]
|
||||
<svg lucideIcon="my-custom-icon"></svg>
|
||||
```
|
||||
|
||||
## Using legacy icon nodes
|
||||
|
||||
If you have icons in the legacy node format, such as custom icons matching `lucide-angular` or `@lucide/lab`, you can convert them using `lucideLegacyIcon`.
|
||||
|
||||
```ts [app.config.ts]
|
||||
import { ApplicationConfig } from '@angular/core';
|
||||
import { provideLucideIcons, lucideLegacyIcon } from '@lucide/angular';
|
||||
import { CirclePlayIcon } from 'lucide-angular';
|
||||
import { burger } from '@lucide/lab';
|
||||
|
||||
export const appConfig: ApplicationConfig = {
|
||||
providers: [
|
||||
provideLucideIcons(
|
||||
lucideLegacyIcon('circle-play', CirclePlayIcon, ['play-circle']),
|
||||
lucideLegacyIcon('burger', burger, ['hamburger']),
|
||||
),
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
You can then use both the primary name and any aliases:
|
||||
|
||||
```html [app.html]
|
||||
<svg lucideIcon="circle-play"></svg>
|
||||
<svg lucideIcon="play-circle"></svg>
|
||||
<svg lucideIcon="burger"></svg>
|
||||
<svg lucideIcon="hamburger"></svg>
|
||||
```
|
||||
|
||||
## Converting a map of legacy icons
|
||||
|
||||
If you already have a map of legacy icon nodes, use `lucideLegacyIconMap` to convert them into icon data objects.
|
||||
|
||||
```ts [app.config.ts]
|
||||
import { ApplicationConfig } from '@angular/core';
|
||||
import { provideLucideIcons, lucideLegacyIconMap, Circle } from '@lucide/angular';
|
||||
import { UserRoundX } from 'lucide-angular';
|
||||
import { burger } from '@lucide/lab';
|
||||
|
||||
export const appConfig: ApplicationConfig = {
|
||||
providers: [
|
||||
provideLucideIcons(
|
||||
Circle,
|
||||
...lucideLegacyIconMap({ UserRoundX, burger }),
|
||||
),
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
This converts the object keys to kebab-case icon names:
|
||||
|
||||
- `UserRoundX` → `user-round-x`
|
||||
- `burger` → `burger`
|
||||
|
||||
The original object key is also added as an alias, so both of these will work:
|
||||
|
||||
```html
|
||||
<svg lucideIcon="UserRoundX"></svg>
|
||||
<svg lucideIcon="user-round-x"></svg>
|
||||
```
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
title: Typescript - Angular
|
||||
description: All exported types from the `@lucide/angular` package and how to use them in your Angular project.
|
||||
---
|
||||
|
||||
# TypeScript
|
||||
|
||||
List of exported types from the `@lucide/angular` package.
|
||||
These can be used to type your components when using Lucide icons in a TypeScript Angular project
|
||||
|
||||
## Types
|
||||
|
||||
### `LucideIcon`
|
||||
|
||||
Represents a self-containing Lucide icon component type that has a static `icon` property. You can use this type in schemas that declare an icon property.
|
||||
|
||||
```ts
|
||||
export interface LucideIcon extends Type<LucideIconProps> {
|
||||
icon: LucideIconData;
|
||||
}
|
||||
```
|
||||
|
||||
### `LucideIconData`
|
||||
|
||||
A Lucide icon object that fully describes an icon to be displayed.
|
||||
|
||||
```ts
|
||||
export type LucideIconData = {
|
||||
name: string;
|
||||
node: LucideIconNode[];
|
||||
aliases?: string[];
|
||||
};
|
||||
```
|
||||
|
||||
## Type guards
|
||||
|
||||
### `isLucideIconData`
|
||||
|
||||
```ts
|
||||
export function isLucideIconData(icon: unknown): icon is LucideIconData {
|
||||
return true | false
|
||||
}
|
||||
```
|
||||
|
||||
### `isLucideIconComponent`
|
||||
|
||||
```ts
|
||||
export function isLucideIconComponent(icon: unknown): icon is LucideIcon {
|
||||
return true | false
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,122 @@
|
||||
---
|
||||
title: Lucide Lab - Angular
|
||||
description: Learn how to use icons from Lucide Lab in your Angular application.
|
||||
---
|
||||
<script setup>
|
||||
import Sandpack from '~/.vitepress/theme/components/editors/SandpackAngular.vue'
|
||||
</script>
|
||||
|
||||
# With Lucide Lab or custom icons
|
||||
|
||||
[Lucide Lab](https://github.com/lucide-icons/lucide-lab) is a collection of icons that are not part of the Lucide main library.
|
||||
|
||||
While they aren't provided as standalone components, they can be still be passed to the `LucideIcon` component the same way as official icons:
|
||||
|
||||
### Directly as LucideIconData
|
||||
|
||||
::: sandpack {template=angular showTabs=false editorHeight=400 editorWidthPercentage=60 dependencies="@lucide/angular,@lucide/lab"}
|
||||
|
||||
```ts /src/app/app.component.ts [active]
|
||||
import { Component, ViewEncapsulation, signal } from "@angular/core";
|
||||
import { LucideDynamicIcon, lucideLegacyIcon } from '@lucide/angular';
|
||||
import { coconut } from '@lucide/lab';
|
||||
|
||||
@Component({
|
||||
selector: 'app',
|
||||
template: `
|
||||
<svg [lucideIcon]="icon()"></svg>
|
||||
`,
|
||||
imports: [LucideDynamicIcon],
|
||||
styleUrls: ['./app.component.css'],
|
||||
encapsulation: ViewEncapsulation.None,
|
||||
})
|
||||
export class App {
|
||||
readonly icon = signal(lucideLegacyIcon('coconut', coconut));
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
|
||||
### As a provided icon by name
|
||||
|
||||
::: sandpack {template=angular editorHeight=400 editorWidthPercentage=60 dependencies="@lucide/angular,@lucide/lab"}
|
||||
|
||||
```ts /src/app/app.component.ts [active]
|
||||
import { Component, ViewEncapsulation } from "@angular/core";
|
||||
import { LucideDynamicIcon } from '@lucide/angular';
|
||||
|
||||
@Component({
|
||||
selector: 'app',
|
||||
template: `
|
||||
<svg lucideIcon="bat-ball"></svg>
|
||||
`,
|
||||
imports: [LucideDynamicIcon],
|
||||
styleUrls: ['./app.component.css'],
|
||||
encapsulation: ViewEncapsulation.None,
|
||||
})
|
||||
export class App {
|
||||
}
|
||||
```
|
||||
|
||||
```ts /src/app/app.config.ts
|
||||
import { ApplicationConfig } from '@angular/core';
|
||||
import { lucideLegacyIcon, provideLucideIcons } from '@lucide/angular';
|
||||
import { batBall } from '@lucide/lab';
|
||||
|
||||
export const appConfig: ApplicationConfig = {
|
||||
providers: [
|
||||
provideLucideIcons(
|
||||
lucideLegacyIcon('bat-ball', batBall)
|
||||
)
|
||||
]
|
||||
};
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
### Creating custom icon components
|
||||
|
||||
You can also create your own standalone icon components using `LucideIconBase`.
|
||||
|
||||
Be sure to use an SVG element selector, e.g. `svg[lucide{IconName}]`
|
||||
|
||||
::: sandpack {template=angular editorHeight=400 editorWidthPercentage=60 dependencies="@lucide/angular,@lucide/lab"}
|
||||
|
||||
```ts /src/icons/bottle-champagne.ts
|
||||
import {
|
||||
LucideIconBase,
|
||||
lucideIconTemplate,
|
||||
lucideLegacyIcon
|
||||
} from '@lucide/angular';
|
||||
import { Component, signal } from '@angular/core';
|
||||
import { bottleChampagne } from '@lucide/lab';
|
||||
|
||||
@Component({
|
||||
selector: 'svg[lucideBottleChampagne]',
|
||||
template: lucideIconTemplate,
|
||||
standalone: true,
|
||||
})
|
||||
export class LucideBottleChampagne extends LucideIconBase {
|
||||
static readonly icon = lucideLegacyIcon('bottle-champagne', bottleChampagne);
|
||||
protected override readonly icon = signal(LucideBottleChampagne.icon);
|
||||
}
|
||||
```
|
||||
|
||||
```ts /src/app/app.component.ts
|
||||
import { Component, ViewEncapsulation, signal } from "@angular/core";
|
||||
import { LucideDynamicIcon, lucideLegacyIcon } from '@lucide/angular';
|
||||
import { LucideBottleChampagne } from "../icons/bottle-champagne";
|
||||
|
||||
@Component({
|
||||
selector: 'app',
|
||||
template: `<svg lucideBottleChampagne></svg>`,
|
||||
imports: [LucideBottleChampagne],
|
||||
styleUrls: ['./app.component.css'],
|
||||
encapsulation: ViewEncapsulation.None,
|
||||
})
|
||||
export class App {
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
Reference in New Issue
Block a user