https://github.com/michaelbazos/angular-feather
A-la-carte integration of Feather Icons in Angular applications
https://github.com/michaelbazos/angular-feather
angular angular2 feather icon-set icon-system icons library
Last synced: 7 months ago
JSON representation
A-la-carte integration of Feather Icons in Angular applications
- Host: GitHub
- URL: https://github.com/michaelbazos/angular-feather
- Owner: michaelbazos
- License: mit
- Created: 2017-06-29T10:05:12.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-23T20:57:19.000Z (over 1 year ago)
- Last Synced: 2025-03-28T14:06:29.352Z (7 months ago)
- Topics: angular, angular2, feather, icon-set, icon-system, icons, library
- Language: TypeScript
- Homepage:
- Size: 3.42 MB
- Stars: 156
- Watchers: 9
- Forks: 35
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-angular - angular-feather - A-la-carte integration of Feather Icons in Angular (2+) applications. (Uncategorized / Uncategorized)
- awesome-angular - angular-feather - This package allows you to use [Feather Icons](https://github.com/feathericons/feather) in your Angular applications. (Table of contents / Third Party Components)
- fucking-awesome-angular - angular-feather - This package allows you to use <b><code> 25497⭐</code></b> <b><code> 1248🍴</code></b> [Feather Icons](https://github.com/feathericons/feather)) in your Angular applications. (Table of contents / Third Party Components)
- fucking-awesome-angular - angular-feather - This package allows you to use <b><code> 25100⭐</code></b> <b><code> 1222🍴</code></b> [Feather Icons](https://github.com/feathericons/feather)) in your Angular applications. (Table of contents / Third Party Components)
README
## angular-feather
### Description
This package allows you to use the [Feather Icons](https://github.com/colebemis/feather) in your angular applications. The icons are designed by Cole Bemis.
Import only the icons that you need.
### Demo
>> See live demo <<
(right-click, open in new tab)
### Usage
_1. Install the package_
```sh
npm install angular-feather
```
_2. Generate a module to host the icons you'll import_
```sh
ng generate module icons
```
_3. Import assets_
You need to import:
- FeatherModule, as it contains the `` component
- The SVGs that you need
We put this in IconsModule for modularity. See example below:
*file: icon.module.ts*
```ts
import { NgModule } from '@angular/core';
import { FeatherModule } from 'angular-feather';
import { Camera, Heart, Github } from 'angular-feather/icons';
// Select some icons (use an object, not an array)
const icons = {
Camera,
Heart,
Github
};
@NgModule({
imports: [
FeatherModule.pick(icons)
],
exports: [
FeatherModule
]
})
export class IconsModule { }
// NOTES:
// 1. We add FeatherModule to the 'exports', since the component will be used in templates of parent module
// 2. Don't forget to pick some icons using FeatherModule.pick({ ... })
```
_3. Use it in template_
After importing the _IconsModule_ in your feature or shared module, use the icons as follows:
```html
```
### Styling icons
```html
```
```css
.big {
height: 50px;
width: 50px;
}
.fill-red {
fill: red;
}
```
### Available icons
Refer to the table below for the list of all available icons.
| | Symbol to import | HTML template |
| --- | ---------------- | ------------------ |
|  | `Activity` | `` |
|  | `Airplay` | `` |
|  | `AlertCircle` | `` |
|  | `AlertOctagon` | `` |
|  | `AlertTriangle` | `` |
|  | `AlignCenter` | `` |
|  | `AlignJustify` | `` |
|  | `AlignLeft` | `` |
|  | `AlignRight` | `` |
|  | `Anchor` | `` |
|  | `Aperture` | `` |
|  | `Archive` | `` |
|  | `ArrowDownCircle` | `` |
|  | `ArrowDownLeft` | `` |
|  | `ArrowDownRight` | `` |
|  | `ArrowDown` | `` |
|  | `ArrowLeftCircle` | `` |
|  | `ArrowLeft` | `` |
|  | `ArrowRightCircle` | `` |
|  | `ArrowRight` | `` |
|  | `ArrowUpCircle` | `` |
|  | `ArrowUpLeft` | `` |
|  | `ArrowUpRight` | `` |
|  | `ArrowUp` | `` |
|  | `AtSign` | `` |
|  | `Award` | `` |
|  | `BarChart2` | `` |
|  | `BarChart` | `` |
|  | `BatteryCharging` | `` |
|  | `Battery` | `` |
|  | `BellOff` | `` |
|  | `Bell` | `` |
|  | `Bluetooth` | `` |
|  | `Bold` | `` |
|  | `BookOpen` | `` |
|  | `Book` | `` |
|  | `Bookmark` | `` |
|  | `Box` | `` |
|  | `Briefcase` | `` |
|  | `Calendar` | `` |
|  | `CameraOff` | `` |
|  | `Camera` | `` |
|  | `Cast` | `` |
|  | `CheckCircle` | `` |
|  | `CheckSquare` | `` |
|  | `Check` | `` |
|  | `ChevronDown` | `` |
|  | `ChevronLeft` | `` |
|  | `ChevronRight` | `` |
|  | `ChevronUp` | `` |
|  | `ChevronsDown` | `` |
|  | `ChevronsLeft` | `` |
|  | `ChevronsRight` | `` |
|  | `ChevronsUp` | `` |
|  | `Chrome` | `` |
|  | `Circle` | `` |
|  | `Clipboard` | `` |
|  | `Clock` | `` |
|  | `CloudDrizzle` | `` |
|  | `CloudLightning` | `` |
|  | `CloudOff` | `` |
|  | `CloudRain` | `` |
|  | `CloudSnow` | `` |
|  | `Cloud` | `` |
|  | `Code` | `` |
|  | `Codepen` | `` |
|  | `Codesandbox` | `` |
|  | `Coffee` | `` |
|  | `Columns` | `` |
|  | `Command` | `` |
|  | `Compass` | `` |
|  | `Copy` | `` |
|  | `CornerDownLeft` | `` |
|  | `CornerDownRight` | `` |
|  | `CornerLeftDown` | `` |
|  | `CornerLeftUp` | `` |
|  | `CornerRightDown` | `` |
|  | `CornerRightUp` | `` |
|  | `CornerUpLeft` | `` |
|  | `CornerUpRight` | `` |
|  | `Cpu` | `` |
|  | `CreditCard` | `` |
|  | `Crop` | `` |
|  | `Crosshair` | `` |
|  | `Database` | `` |
|  | `Delete` | `` |
|  | `Disc` | `` |
|  | `DivideCircle` | `` |
|  | `DivideSquare` | `` |
|  | `Divide` | `` |
|  | `DollarSign` | `` |
|  | `DownloadCloud` | `` |
|  | `Download` | `` |
|  | `Dribbble` | `` |
|  | `Droplet` | `` |
|  | `Edit2` | `` |
|  | `Edit3` | `` |
|  | `Edit` | `` |
|  | `ExternalLink` | `` |
|  | `EyeOff` | `` |
|  | `Eye` | `` |
|  | `Facebook` | `` |
|  | `FastForward` | `` |
|  | `Feather` | `` |
|  | `Figma` | `` |
|  | `FileMinus` | `` |
|  | `FilePlus` | `` |
|  | `FileText` | `` |
|  | `File` | `` |
|  | `Film` | `` |
|  | `Filter` | `` |
|  | `Flag` | `` |
|  | `FolderMinus` | `` |
|  | `FolderPlus` | `` |
|  | `Folder` | `` |
|  | `Framer` | `` |
|  | `Frown` | `` |
|  | `Gift` | `` |
|  | `GitBranch` | `` |
|  | `GitCommit` | `` |
|  | `GitMerge` | `` |
|  | `GitPullRequest` | `` |
|  | `Github` | `` |
|  | `Gitlab` | `` |
|  | `Globe` | `` |
|  | `Grid` | `` |
|  | `HardDrive` | `` |
|  | `Hash` | `` |
|  | `Headphones` | `` |
|  | `Heart` | `` |
|  | `HelpCircle` | `` |
|  | `Hexagon` | `` |
|  | `Home` | `` |
|  | `Image` | `` |
|  | `Inbox` | `` |
|  | `Info` | `` |
|  | `Instagram` | `` |
|  | `Italic` | `` |
|  | `Key` | `` |
|  | `Layers` | `` |
|  | `Layout` | `` |
|  | `LifeBuoy` | `` |
|  | `Link2` | `` |
|  | `Link` | `` |
|  | `Linkedin` | `` |
|  | `List` | `` |
|  | `Loader` | `` |
|  | `Lock` | `` |
|  | `LogIn` | `` |
|  | `LogOut` | `` |
|  | `Mail` | `` |
|  | `MapPin` | `` |
|  | `Map` | `` |
|  | `Maximize2` | `` |
|  | `Maximize` | `` |
|  | `Meh` | `` |
|  | `Menu` | `` |
|  | `MessageCircle` | `` |
|  | `MessageSquare` | `` |
|  | `MicOff` | `` |
|  | `Mic` | `` |
|  | `Minimize2` | `` |
|  | `Minimize` | `` |
|  | `MinusCircle` | `` |
|  | `MinusSquare` | `` |
|  | `Minus` | `` |
|  | `Monitor` | `` |
|  | `Moon` | `` |
|  | `MoreHorizontal` | `` |
|  | `MoreVertical` | `` |
|  | `MousePointer` | `` |
|  | `Move` | `` |
|  | `Music` | `` |
|  | `Navigation2` | `` |
|  | `Navigation` | `` |
|  | `Octagon` | `` |
|  | `Package` | `` |
|  | `Paperclip` | `` |
|  | `PauseCircle` | `` |
|  | `Pause` | `` |
|  | `PenTool` | `` |
|  | `Percent` | `` |
|  | `PhoneCall` | `` |
|  | `PhoneForwarded` | `` |
|  | `PhoneIncoming` | `` |
|  | `PhoneMissed` | `` |
|  | `PhoneOff` | `` |
|  | `PhoneOutgoing` | `` |
|  | `Phone` | `` |
|  | `PieChart` | `` |
|  | `PlayCircle` | `` |
|  | `Play` | `` |
|  | `PlusCircle` | `` |
|  | `PlusSquare` | `` |
|  | `Plus` | `` |
|  | `Pocket` | `` |
|  | `Power` | `` |
|  | `Printer` | `` |
|  | `Radio` | `` |
|  | `RefreshCcw` | `` |
|  | `RefreshCw` | `` |
|  | `Repeat` | `` |
|  | `Rewind` | `` |
|  | `RotateCcw` | `` |
|  | `RotateCw` | `` |
|  | `Rss` | `` |
|  | `Save` | `` |
|  | `Scissors` | `` |
|  | `Search` | `` |
|  | `Send` | `` |
|  | `Server` | `` |
|  | `Settings` | `` |
|  | `Share2` | `` |
|  | `Share` | `` |
|  | `ShieldOff` | `` |
|  | `Shield` | `` |
|  | `ShoppingBag` | `` |
|  | `ShoppingCart` | `` |
|  | `Shuffle` | `` |
|  | `Sidebar` | `` |
|  | `SkipBack` | `` |
|  | `SkipForward` | `` |
|  | `Slack` | `` |
|  | `Slash` | `` |
|  | `Sliders` | `` |
|  | `Smartphone` | `` |
|  | `Smile` | `` |
|  | `Speaker` | `` |
|  | `Square` | `` |
|  | `Star` | `` |
|  | `StopCircle` | `` |
|  | `Sun` | `` |
|  | `Sunrise` | `` |
|  | `Sunset` | `` |
|  | `Table` | `` |
|  | `Tablet` | `` |
|  | `Tag` | `` |
|  | `Target` | `` |
|  | `Terminal` | `` |
|  | `Thermometer` | `` |
|  | `ThumbsDown` | `` |
|  | `ThumbsUp` | `` |
|  | `ToggleLeft` | `` |
|  | `ToggleRight` | `` |
|  | `Tool` | `` |
|  | `Trash2` | `` |
|  | `Trash` | `` |
|  | `Trello` | `` |
|  | `TrendingDown` | `` |
|  | `TrendingUp` | `` |
|  | `Triangle` | `` |
|  | `Truck` | `` |
|  | `Tv` | `` |
|  | `Twitch` | `` |
|  | `Twitter` | `` |
|  | `Type` | `` |
|  | `Umbrella` | `` |
|  | `Underline` | `` |
|  | `Unlock` | `` |
|  | `UploadCloud` | `` |
|  | `Upload` | `` |
|  | `UserCheck` | `` |
|  | `UserMinus` | `` |
|  | `UserPlus` | `` |
|  | `UserX` | `` |
|  | `User` | `` |
|  | `Users` | `` |
|  | `VideoOff` | `` |
|  | `Video` | `` |
|  | `Voicemail` | `` |
|  | `Volume1` | `` |
|  | `Volume2` | `` |
|  | `VolumeX` | `` |
|  | `Volume` | `` |
|  | `Watch` | `` |
|  | `WifiOff` | `` |
|  | `Wifi` | `` |
|  | `Wind` | `` |
|  | `XCircle` | `` |
|  | `XOctagon` | `` |
|  | `XSquare` | `` |
|  | `X` | `` |
|  | `Youtube` | `` |
|  | `ZapOff` | `` |
|  | `Zap` | `` |
|  | `ZoomIn` | `` |
|  | `ZoomOut` | `` |
### FAQ
**1. Is there a way to pick all the icons at once?**
Yes, by importing `allIcons` from `'angular-feather/icons'`:
```ts
import { allIcons } from 'angular-feather/icons';
@NgModule({
imports: [
FeatherModule.pick(allIcons)
],
exports: [
FeatherModule
]
})
export class IconsModule { }
```
However, keep in mind that by doing this, all icons will end up in your application bundle. While this may not be much of an issue for prototyping, it is not recommended for any application that you plan to release.
### License
MIT © [Michael Bazos](mailto:micabazos@gmail.com)