@ng-icons/iconsax 26.4.0

package/README.md

@@ -0,0 +1,264 @@
+<img width="600" alt="logo" src="https://github.com/ng-icons/ng-icons/assets/20795331/8781b0a9-2c8a-4a7f-9afd-13e47d14cffe">
+
+# Ng Icons
+
+The all-in-one icon library for Angular. This allows you to use icons from multiple icon sets with a single icon component.
+Containing over 35,500 icons for you to use in your projects.
+
+Currently, we support the following libraries:
+
+- [Bootstrap Icons](https://icons.getbootstrap.com/)
+- [Heroicons](https://heroicons.com/)
+- [Ionicons](https://ionic.io/ionicons)
+- [Material Icons](https://fonts.google.com/icons?selected=Material+Icons)
+- [Material File Icons](https://github.com/PKief/vscode-material-icon-theme)
+- [CSS.gg](https://css.gg/)
+- [Feather Icons](https://feathericons.com/)
+- [Jam Icons](https://jam-icons.com/)
+- [Octicons](https://github.com/primer/octicons)
+- [Radix UI Icons](https://icons.modulz.app/)
+- [Tabler Icons](https://tabler-icons.io/)
+- [Akar Icons](https://akaricons.com/)
+- [Iconoir](https://iconoir.com/)
+- [Cryptocurrency Icons](http://cryptoicons.co/)
+- [Simple Icons](https://simpleicons.org/)
+- [Typicons](https://www.s-ings.com/typicons/)
+- [Dripicons](https://github.com/amitjakhu/dripicons)
+- [UX Aspects](https://uxaspects.github.io/UXAspects/)
+- [Circum Icons](https://circumicons.com/)
+- [Remix Icon](https://remixicon.com/)
+- [Font Awesome](https://fontawesome.com/)
+- [Iconsax](https://iconsax.io/)
+
+Got suggestions for additional iconsets? Create an issue and we can consider adding them!
+
+## Supported Versions
+
+| Angular Version | Ng Icon Version |
+| --------------- | --------------- |
+| 11.x.x          | 12.x.x          |
+| 12.x.x          | 12.x.x - 13.x.x |
+| 13.x.x          | 13.x.x - 17.x.x |
+| 14.x.x          | 17.x.x - 22.x.x |
+| 15.x.x          | 23.x.x - 24.x.x |
+| 16.x.x          | 25.x.x          |
+| 17.x.x          | 26.x.x          |
+
+> **Note**: Ng Icons relies on modern browser features and is designed to work on evergreen browsers. We do not support older browsers such as IE11.
+
+## Installation
+
+You must install the `@ng-icons/core` package, however you only need to install the iconset libraries you intend to use.
+
+E.g:
+
+```bash
+npm i @ng-icons/core @ng-icons/heroicons ...
+```
+
+or
+
+```bash
+yarn add @ng-icons/core @ng-icons/heroicons ...
+```
+
+## Packages
+
+The following packages are available:
+
+| Package                          | License                               |
+| -------------------------------- | ------------------------------------- |
+| `@ng-icons/core`                 | MIT                                   |
+| `@ng-icons/bootstrap-icons`      | MIT                                   |
+| `@ng-icons/heroicons`            | MIT                                   |
+| `@ng-icons/ionicons`             | MIT                                   |
+| `@ng-icons/material-icons`       | Apache 2.0                            |
+| `@ng-icons/material-file-icons`  | MIT                                   |
+| `@ng-icons/css.gg`               | MIT                                   |
+| `@ng-icons/feather-icons`        | MIT                                   |
+| `@ng-icons/jam-icons`            | MIT                                   |
+| `@ng-icons/octicons`             | MIT                                   |
+| `@ng-icons/radix-icons`          | MIT                                   |
+| `@ng-icons/tabler-icons`         | MIT                                   |
+| `@ng-icons/akar-icons`           | MIT                                   |
+| `@ng-icons/iconoir`              | MIT                                   |
+| `@ng-icons/cryptocurrency-icons` | CC0-1.0                               |
+| `@ng-icons/simple-icons`         | CC0-1.0                               |
+| `@ng-icons/typicons`             | CC-BY-SA-4.0                          |
+| `@ng-icons/dripicons`            | CC-BY-SA-4.0                          |
+| `@ng-icons/ux-aspects`           | Apache 2.0                            |
+| `@ng-icons/circum-icons`         | MPL-2.0                               |
+| `@ng-icons/remixicon`            | Apache 2.0                            |
+| `@ng-icons/font-awesome`         | CC BY 4.0                             |
+| `@ng-icons/iconsax`              | [Custom](https://iconsax.io/#license) |
+
+## Usage
+
+Import the `NgIconsModule` and register the icons you wish to use:
+
+```ts
+import { NgIconsModule } from '@ng-icons/core';
+import { featherAirplay } from '@ng-icons/feather-icons';
+import { heroUsers } from '@ng-icons/heroicons/outline';
+
+@NgModule({
+  imports: [BrowserModule, NgIconsModule.withIcons({ featherAirplay, heroUsers })],
+})
+export class AppModule {}
+```
+
+You can register icons in multiple modules, this allows icons to be lazy loaded in child modules.
+
+You can then use the icon in your templates:
+
+```html
+<ng-icon name="featherAirplay"></ng-icon>
+```
+
+| Name        | Type                 | Description                                                                        |
+| ----------- | -------------------- | ---------------------------------------------------------------------------------- |
+| size        | `string`             | Define the size of the icon. This defaults to the current font size.               |
+| color       | `string`             | Define the color of the icon. This defaults to the current text color.             |
+| strokeWidth | `string` \| `number` | Define the stroke-width of the icon. This only works on iconsets that use strokes. |
+
+### Standalone Components
+
+As of version 18.0.0 Ng Icons nows supports standalone components. You can import icons using the `provideIcons` function which can be placed anywhere you can register providers. The optimal location
+would be in the `@Component` providers array.
+
+You can also import the component directly by importing `NgIconComponent` or the `NG_ICON_DIRECTIVES` constant.
+
+```ts
+import { NgIconComponent, provideIcons } from '@ng-icons/core';
+import { featherAirplay } from '@ng-icons/feather-icons';
+import { heroUsers } from '@ng-icons/heroicons/outline';
+
+@Component({
+  standalone: true,
+  imports: [NgIconComponent],
+  providers: [provideIcons({ featherAirplay, heroUsers })],
+})
+export class AppComponent {}
+```
+
+### Global Configuration
+
+You can configure the default size of icons by providing a `NgIconsConfig` object to the `provideNgIconsConfig`:
+
+#### NgModule
+
+```ts
+import { NgIconsModule, provideNgIconsConfig } from '@ng-icons/core';
+import { featherAirplay } from '@ng-icons/feather-icons';
+
+@NgModule({
+  imports: [BrowserModule, NgIconsModule.withIcons({ featherAirplay, heroUsers })],
+  providers: [
+    provideNgIconsConfig({
+      size: '1.5em',
+      color: 'red',
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+#### Standalone
+
+```ts
+import { NgIconComponent, provideIcons, provideNgIconsConfig } from '@ng-icons/core';
+
+bootstrapApplication(AppComponent, {
+  providers: [
+    provideNgIconsConfig({
+      size: '1.5em',
+    }),
+  ],
+});
+```
+
+### Dynamically Loading Icons
+
+The most common way to load icons is simply by registering them individually, however you may want to load icons lazily from a URL, or generate an SVG programatically on the fly. This can be achived using an icon loader. Icon loaders are a function that receives the name of the requested icon, and can return an `Observable<string>`, `Promise<string>` or a `string` containing the SVG to render. Within this function you can do whatever you need to retrieve an icon.
+
+The function is also run within the injection context, this allows you to inject dependencies as you need such as the `HttpClient`.
+
+```ts
+bootstrapApplication(AppComponent, {
+  providers: [
+    provideNgIconLoader(name => {
+      const http = inject(HttpClient);
+      return http.get(`/assets/icons/${name}.svg`);
+    }),
+  ],
+});
+```
+
+Additionally add caching to your loader to prevent multiple requests for the same icon.
+
+```ts
+bootstrapApplication(AppComponent, {
+  providers: [
+    provideNgIconLoader(name => {...}, withCaching()),
+  ],
+});
+```
+
+## Experimental Features
+
+### Variable Icon Fonts
+
+We have added support for variable icon fonts. This is currently only supported by the [Material Symbols](https://github.com/marella/material-symbols/tree/main/material-symbols#readme) iconset.
+
+To enable this feature you must install the icon font and load the `material-symbols` stylesheet. Unlike the static SVG icons, Ng Icons does not bundle the icon font, you must load it yourself.
+
+To use it you must register the variable fonts you want to use. The default iconset will be the first one registered.
+
+```ts
+import { provideNgGlyphs } from '@ng-icons/core';
+import { withMaterialSymbolsOutlined, withMaterialSymbolsRounded } from '@ng-icons/material-symbols';
+
+bootstrapApplication(AppComponent, {
+  providers: [provideNgGlyphs(withMaterialSymbolsOutlined(), withMaterialSymbolsRounded())],
+});
+```
+
+You can then use the following in your HTML:
+
+```html
+<ng-glyph name="settings" />
+```
+
+The following inputs are available on `ng-glyph`:
+
+| Name        | Type                 | Description                                                                                             |
+| ----------- | -------------------- | ------------------------------------------------------------------------------------------------------- |
+| name        | `string`             | Define the name of the icon.                                                                            |
+| glyphset    | `string`             | Define the glyphset to use. This defaults to the first registered glyphset.                             |
+| size        | `string` \| `number` | Define the size of the icon as a pixel value or as a CSS value. This defaults to the current text size. |
+| opticalSize | `number`             | Define the optical size of the icon in `px`. This defaults to `20`                                      |
+| color       | `string`             | Define the color of the icon. This defaults to the current text color.                                  |
+| weight      | `number`             | Define the weight of the icon. This defaults to `400`.                                                  |
+| grade       | `number`             | Define the grade of the icon. This defaults to `0`.                                                     |
+| fill        | `boolean`            | Define if the icon should be filled. This defaults to `false`.                                          |
+
+The default values for `size`, `weight`, `grade` and `fill` can be configured using the `provideNgGlyphsConfig` function.
+
+```ts
+import { provideNgGlyphsConfig } from '@ng-icons/core';
+
+bootstrapApplication(AppComponent, {
+  providers: [
+    provideNgGlyphsConfig({
+      size: 24,
+      weight: 400,
+      grade: 0,
+      fill: false,
+    }),
+  ],
+});
+```
+
+This feature is experimental and does not follow the same versioning as the rest of the library. Breaking changes may be introduced at any time.
+
+We appreciate any feedback you have on this feature.

package/bold/README.md

@@ -0,0 +1,3 @@
+# @ng-icons/iconsax/bold
+
+Secondary entry point of `@ng-icons/iconsax`. It can be used by importing from `@ng-icons/iconsax/bold`.