Angular Icon Button Overview
The Ignite UI for Angular Icon Button directive is intended to turn any icon into a fully functional button. The igxIconButton comes in three types - flat, outlined, and contained which is the default one.
Angular Icon Button Example
Getting Started with Ignite UI for Angular Icon Button
To get started with the Ignite UI for Angular Icon Button directive, first you need to install Ignite UI for Angular. In an existing Angular application, type the following command:
ng add igniteui-angular
For a complete introduction to the Ignite UI for Angular, read the getting started topic.
The next step is to import the IgxIconButtonDirective as a standalone dependency:
// home.component.ts
...
import { IgxIconButtonDirective } from 'igniteui-angular/directives';
// import { IgxIconButtonDirective } from '@infragistics/igniteui-angular'; for licensed package
@Component({
selector: 'app-home',
template: `
<button igxIconButton="outlined">
<igx-icon>home</igx-icon>
</button>`,
styleUrls: ['home.component.scss'],
standalone: true,
imports: [IgxIconButtonDirective]
})
export class HomeComponent {}
Now that you have the Ignite UI for Angular Icon Button directive imported, you can start using the igxIconButton directive on elements.
Angular Icon Button Types
Flat Icon Button
Use the igxIconButton directive to add a simple flat icon button in your component template:
<button igxIconButton="flat">
<igx-icon>edit</igx-icon>
</button>
Contained Icon Button
All you have to do to create a contained icon button is to change the value of the igxIconButton property. Note that if you do not choose a type, by default it will also be set to contained.
<button igxIconButton>
<igx-icon>favorite</igx-icon>
</button>
Outlined Icon Button
Analogically, we can switch to outlined type:
<button igxIconButton="outlined">
<igx-icon>more_vert</igx-icon>
</button>
Examples
Disabled Icon Button
If you want to disable an icon button, you can use the disabled property. In this sample we also demonstrate how to use icons from different families with the igxIconButton directive:
<button igxIconButton="flat" disabled>
<igx-icon family="fa" name="fa-home"></igx-icon>
</button>
SVG Icons
In addition to material icons, the igxIconButton directive also supports usage of SVG images as icons. To do so, first we should inject the IgxIconService dependency and then use the addSvgIcon method to import the SVG file in cache. For further information, you can read the SVG section in the icon topic.
constructor(private _iconService: IgxIconService) { }
public ngOnInit() {
// register custom SVG icon
this._iconService.addSvgIcon('rain', 'assets/images/card/icons/rain.svg', 'weather-icons');
}
<button igxIconButton>
<igx-icon family="weather-icons" name="rain"></igx-icon>
</button>
Size
Users can choose one of the three predefined igxIconButton sizes by using the --ig-size custom CSS property. By default, the size of the component is set medium.
As you can see from the sample above, we can also use the igxIconButton directive to turn elements like span and div into Ignite UI for Angular styled icon buttons.
Icon Button Styling
Icon Button Theme Property Map
When you modify a primary property, all related dependent properties are updated automatically:
Flat Icon Button
| Primary Property | Dependent Property | Description |
|---|---|---|
$foreground | $hover-foreground | Hovered icon color |
| $focus-foreground | Focused icon color | |
| $focus-hover-foreground | Focus + hover icon color | |
| $active-foreground | Active icon color | |
| $hover-background | Background on hover | |
| $focus-background | Background on focus | |
| $focus-hover-background | Background on focus + hover | |
| $active-background | Background on active |
Contained Icon Button
| Primary Property | Dependent Property | Description |
|---|---|---|
$background | $foreground | Icon color |
| $hover-background | Background on hover | |
| $focus-background | Background on focus | |
| $focus-foreground | Focused icon color | |
| $focus-hover-background | Background on focus + hover | |
| $active-background | Background on active | |
| $hover-foreground | Hovered icon color | |
| $focus-hover-foreground | Focus + hover icon color | |
| $active-foreground | Active icon color | |
| $shadow-color | Shadow on focus | |
| $focus-border-color | Focus border color | |
| $disabled-background | Disabled background | |
| $disabled-foreground | Disabled icon color |
Outlined Icon Button
| Primary Property | Dependent Property | Description |
|---|---|---|
$foreground | $hover-foreground | Hovered icon color |
| $focus-foreground | Focused icon color | |
| $focus-hover-foreground | Focus + hover icon color | |
| $active-foreground | Active icon color | |
| $hover-background | Background on hover | |
| $focus-background | Background on focus | |
| $focus-hover-background | Background on focus + hover | |
| $active-background | Background on active | |
| $border-color | Default border color | |
| $focus-border-color | Focus border color |
Flat Icon Button
| Primary Property | Dependent Property | Description |
|---|---|---|
$foreground | $hover-foreground | Icon color on hover |
| $focus-foreground | Icon color when focused | |
| $focus-hover-foreground | Icon color when focused and hovered | |
| $active-foreground | Icon color when active | |
| $hover-background | Background color on hover | |
| $focus-background | Background color on focus | |
| $focus-hover-background | Background color on focus and hover | |
| $active-background | Background color when active |
Contained Icon Button
| Primary Property | Dependent Property | Description |
|---|---|---|
$background | $foreground | Icon color |
| $hover-background | Background color on hover | |
| $focus-background | Background color on focus | |
| $focus-foreground | Icon color when focused | |
| $focus-hover-background | Background color on focus and hover | |
| $active-background | Background color when active | |
| $hover-foreground | Icon color on hover | |
| $focus-hover-foreground | Icon color when focused and hovered | |
| $active-foreground | Icon color when active | |
| $shadow-color | Shadow color on focus | |
| $focus-border-color | Border color on focus | |
| $disabled-background | Background color when disabled | |
| $disabled-foreground | Icon color when disabled |
Outlined Icon Button
| Primary Property | Dependent Property | Description |
|---|---|---|
$foreground | $hover-foreground | Icon color on hover |
| $focus-foreground | Icon color when focused | |
| $focus-hover-foreground | Icon color when focused and hovered | |
| $active-foreground | Icon color when active | |
| $hover-background | Background color on hover | |
| $focus-background | Background color on focus | |
| $focus-hover-background | Background color on focus and hover | |
| $active-background | Background color when active | |
| $border-color | Border color | |
| $focus-border-color | Border color on focus |
Flat Icon Button
| Primary Property | Dependent Property | Description |
|---|---|---|
$foreground | $hover-foreground | Icon color when hovered |
| $focus-foreground | Icon color when focused | |
| $focus-hover-foreground | Icon color when focused and hovered | |
| $active-foreground | Icon color when active | |
| $disabled-foreground | Icon color when disabled | |
| $shadow-color | The shadow color of the icon button |
Contained Icon Button
| Primary Property | Dependent Property | Description |
|---|---|---|
$background | $foreground | Icon color |
| $hover-background | Background color on hover | |
| $focus-background | Background color on focus | |
| $focus-foreground | Icon color when focused | |
| $focus-hover-background | Background color on focus and hover | |
| $active-background | Background color when active | |
| $hover-foreground | Icon color on hover | |
| $focus-hover-foreground | Icon color when focused and hovered | |
| $active-foreground | Icon color when active | |
| $shadow-color | Shadow color | |
| $focus-border-color | Border color on focus | |
| $disabled-background | Background color when disabled | |
| $disabled-foreground | Icon color when disabled |
Outlined Icon Button
| Primary Property | Dependent Property | Description |
|---|---|---|
$foreground | $hover-foreground | Icon color on hover |
| $focus-foreground | Icon color when focused | |
| $focus-hover-foreground | Icon color when focused and hovered | |
| $active-foreground | Icon color when active | |
| $hover-background | Background color on hover | |
| $focus-background | Background color on focus | |
| $focus-hover-background | Background color on focus and hover | |
| $active-background | Background color when active | |
| $border-color | Border color | |
| $focus-border-color | Border color on focus | |
| $shadow-color | Shadow color | |
| $disabled-foreground | Icon color when disabled | |
| $disabled-border-color | The border of the icon button when disabled |
Flat Icon Button
| Primary Property | Dependent Property | Description |
|---|---|---|
$foreground | $hover-foreground | Icon color on hover |
| $focus-foreground | Icon color when focused | |
| $focus-hover-foreground | Icon color when focused and hovered | |
| $active-foreground | Icon color when active | |
| $disabled-foreground | Icon color when disabled | |
| $hover-background | Background color on hover | |
| $focus-background | Background color on focus | |
| $focus-hover-background | Background color on focus and hover | |
| $active-background | Background color when active | |
| $focus-border-color | Border color on focus |
Contained Icon Button
| Primary Property | Dependent Property | Description |
|---|---|---|
$background | $foreground | Icon color |
| $hover-background | Background color on hover | |
| $focus-background | Background color on focus | |
| $focus-foreground | Icon color when focused | |
| $focus-hover-background | Background color on focus and hover | |
| $active-background | Background color when active | |
| $hover-foreground | Icon color on hover | |
| $focus-hover-foreground | Icon color when focused and hovered | |
| $active-foreground | Icon color when active | |
| $shadow-color | Shadow color | |
| $focus-border-color | Border color on focus | |
| $disabled-background | Background color when disabled | |
| $disabled-foreground | Icon color when disabled |
Outlined Icon Button
| Primary Property | Dependent Property | Description |
|---|---|---|
$foreground | $hover-foreground | Icon color on hover |
| $focus-foreground | Icon color when focused | |
| $focus-hover-foreground | Icon color when focused and hovered | |
| $active-foreground | Icon color when active | |
| $hover-background | Background color on hover | |
| $border-color | Border color | |
| $focus-border-color | Border color on focus |
Following the simplest approach, we use CSS variables to customize the appearance of the icon button:
[igxIconButton="contained"] {
--background: #011627;
--foreground: #fefefe;
--hover-foreground: #011627dc;
--hover-background: #ecaa53;
--focus-foreground: #011627dc;
--focus-background: #ecaa53;
--focus-border-color: #0116276c;
--active-foreground: #011627dc;
--active-background: #ecaa53;
}
Take a look at the icon-button-theme section for a complete list of available parameters for styling any type of icon button.
You can also choose to style only buttons of a specific type - flat, outlined or contained.
To do this, you can use the new type-specific theme functions: flat-icon-button-theme, outlined-icon-button-theme and contained-icon-button-theme
Here’s an example of using the contained-icon-button-theme function to define a custom theme in SCSS:
@use "igniteui-angular/theming" as *;
$custom-contained: contained-icon-button-theme(
$background: #ECAA53,
);
This will generate a fully themed contained icon button, including appropriate foreground and background colors for its various states like hover, focus, and active.
Styling with Tailwind
You can style the icon button using our custom Tailwind utility classes. Make sure to set up Tailwind first.
Along with the tailwind import in your global stylesheet, you can apply the desired theme utilities as follows:
@import "tailwindcss";
...
@use 'igniteui-theming/tailwind/utilities/material.css';
The utility file includes both light and dark theme variants.
- Use
light-*classes for the light theme. - Use
dark-*classes for the dark theme. - Append the component name after the prefix, e.g.,
light-icon-button,dark-icon-button.
Once applied, these classes enable dynamic theme calculations. From there, you can override the generated CSS variables using arbitrary properties. After the colon, provide any valid CSS color format (HEX, CSS variable, RGB, etc.).
You can find the full list of properties in the icon-button-theme. The syntax is as follows:
<button igxIconButton class="!light-icon-button ![--icon-color:#FF4E00]">
<igx-icon>edit</igx-icon>
</button>
Note
The exclamation mark(!) is required to ensure the utility class takes precedence. Tailwind applies styles in layers, and without marking these styles as important, they will get overridden by the component’s default theme.
At the end your icon buttons should look like this:
API References
Additional Resources
Our community is active and always welcoming to new ideas.
GitHub