@hugeicons/angular v1.0.4

@hugeicons/angular

HugeIcons Pro Angular Component Library - Beautiful and customizable icons for your Angular applications

What is HugeIcons?

HugeIcons is a comprehensive icon library designed for modern web and mobile applications. The free package includes 4,400+ carefully crafted icons in the Stroke Rounded style, while the pro version offers over 40,000 icons across 9 unique styles.

Key Highlights

• 4,400+ Free Icons: Extensive collection of Stroke Rounded icons covering essential UI elements, actions, and concepts
• Pixel Perfect: Every icon is crafted on a 24x24 pixel grid ensuring crisp, clear display at any size
• Customizable: Easily adjust colors, sizes, and styles to match your design needs
• Regular Updates: New icons added regularly to keep up with evolving design trends

📚 Looking for Pro Icons? Check out our comprehensive documentation at docs.hugeicons.com for detailed information about pro icons, styles, and advanced usage.

Table of Contents

• What is HugeIcons?
• Features
• Installation
• Usage
• Inputs
• Examples
  • Basic Usage
  • Custom Size and Color
  • Interactive Examples
• Performance
• Troubleshooting
• Browser Support
• Related Packages
• Pro Version
• License
• Related

Features

• 🎨 Customizable colors and sizes
• 💪 TypeScript support with full type definitions
• 🎯 Tree-shakeable for optimal bundle size
• 📦 Multiple bundle formats (ESM, CJS, UMD)
• ⚡ Lightweight and optimized
• 🔄 Alternate icon support for dynamic interactions

Installation

# Using npm
npm install @hugeicons/angular @hugeicons/core-free-icons

# Using yarn
yarn add @hugeicons/angular @hugeicons/core-free-icons

# Using pnpm
pnpm add @hugeicons/angular @hugeicons/core-free-icons

# Using bun
bun add @hugeicons/angular @hugeicons/core-free-icons

Usage

First, import the HugeiconsModule in your app.module.ts:

import { NgModule } from '@angular/core';
import { HugeiconsModule } from '@hugeicons/angular';

@NgModule({
  imports: [
    HugeiconsModule
  ],
  // ...
})
export class AppModule { }

Then use it in your component:

// your.component.ts
import { Component } from '@angular/core';
import { SearchIcon } from '@hugeicons/core-free-icons';

@Component({
  selector: 'app-your-component',
  template: `
    <hugeicons-icon
      [icon]="icon"
      [size]="24"
      color="currentColor"
      [strokeWidth]="1.5"
    ></hugeicons-icon>
  `
})
export class YourComponent {
  icon = SearchIcon;
}

Inputs

Note:

• The component accepts all standard SVG attributes which will be passed to the root SVG element.
• The size input accepts both numbers and strings, but strings will be parsed to numbers and must result in a positive number.
• Icon arrays are tuples of [elementName: string, attributes: Record<string, any>][] representing SVG elements.
• When absoluteStrokeWidth is true, the stroke width is scaled proportionally to the icon size (based on a 24px base size).

Examples

Basic Usage

// basic.component.ts
import { Component } from '@angular/core';
import { SearchIcon } from '@hugeicons/core-free-icons';

@Component({
  selector: 'app-basic',
  template: `
    <hugeicons-icon [icon]="icon"></hugeicons-icon>
  `
})
export class BasicComponent {
  icon = SearchIcon;
}

Custom Size and Color

// custom.component.ts
import { Component } from '@angular/core';
import { NotificationIcon } from '@hugeicons/core-free-icons';

@Component({
  selector: 'app-custom',
  template: `
    <hugeicons-icon
      [icon]="icon"
      [size]="32"
      color="#FF5733"
      [strokeWidth]="2"
      [absoluteStrokeWidth]="true"
    ></hugeicons-icon>
  `
})
export class CustomComponent {
  icon = NotificationIcon;
}

Interactive Examples

Search Bar with Clear Button

// search.component.ts
import { Component } from '@angular/core';
import { SearchIcon, CloseCircleIcon } from '@hugeicons/core-free-icons';

@Component({
  selector: 'app-search',
  template: `
    <div>
      <input
        [(ngModel)]="searchValue"
        type="text"
        placeholder="Search..."
      />
      <hugeicons-icon
        [icon]="SearchIcon"
        [altIcon]="CloseCircleIcon"
        [showAlt]="searchValue.length > 0"
        (click)="clearSearch()"
      ></hugeicons-icon>
    </div>
  `
})
export class SearchComponent {
  searchValue = '';
  SearchIcon = SearchIcon;
  CloseCircleIcon = CloseCircleIcon;

  clearSearch(): void {
    if (this.searchValue.length > 0) {
      this.searchValue = '';
    }
  }
}

Theme Toggle

// theme-toggle.component.ts
import { Component } from '@angular/core';
import { SunIcon, MoonIcon } from '@hugeicons/core-free-icons';

@Component({
  selector: 'app-theme-toggle',
  template: `
    <button (click)="toggleTheme()">
      <hugeicons-icon
        [icon]="SunIcon"
        [altIcon]="MoonIcon"
        [showAlt]="isDark"
      ></hugeicons-icon>
    </button>
  `
})
export class ThemeToggleComponent {
  isDark = false;
  SunIcon = SunIcon;
  MoonIcon = MoonIcon;

  toggleTheme(): void {
    this.isDark = !this.isDark;
  }
}

Performance

• Tree-shaking: The package is fully tree-shakeable, ensuring only the icons you use are included in your final bundle
• Optimized SVGs: All icons are optimized for size and performance
• Code Splitting: Icons can be easily code-split when using dynamic imports

Troubleshooting

Common Issues

1. Icons not showing up?

   • Make sure you've installed both @hugeicons/angular and @hugeicons/core-free-icons
   • Check that the HugeiconsModule is properly imported in your module
   • Verify that icon names are correctly imported

2. TypeScript errors?

   • Ensure your tsconfig.json includes the necessary type definitions
   • Check that you're using the latest version of the package

3. Bundle size concerns?

   • Use named imports instead of importing the entire icon set
   • Implement code splitting for different sections of your app

Browser Support

The library supports all modern browsers.

Related Packages

• @hugeicons/react - React component
• @hugeicons/vue - Vue component
• @hugeicons/svelte - Svelte component
• @hugeicons/react-native - React Native component

Pro Version

🌟 Want access to 36,000+ icons and 9 unique styles? Check out our Pro Version and visit docs.hugeicons.com for comprehensive documentation.

Available Pro Styles

• Stroke Styles
  • Stroke Rounded (@hugeicons-pro/core-stroke-rounded)
  • Stroke Sharp (@hugeicons-pro/core-stroke-sharp)
  • Stroke Standard (@hugeicons-pro/core-stroke-standard)
• Solid Styles
  • Solid Rounded (@hugeicons-pro/core-solid-rounded)
  • Solid Sharp (@hugeicons-pro/core-solid-sharp)
  • Solid Standard (@hugeicons-pro/core-solid-standard)
• Special Styles
  • Bulk Rounded (@hugeicons-pro/core-bulk-rounded)
  • Duotone Rounded (@hugeicons-pro/core-duotone-rounded)
  • Twotone Rounded (@hugeicons-pro/core-twotone-rounded)

License

This project is licensed under the MIT License.

Related

• @hugeicons/core-free-icons - Free icon package
• HugeIcons Website - Browse all available icons