Smart Icon

How to use

Installation

This package use MatIcon from Angular Material. To use this package please install Angular Material first.

Go to your project, open the terminal and use the following command:

npm i @smartbit4all/icon

Then import it in the AppModule:

app.module.ts:

import { SmartIconModule, SmartIconService } from '@smartbit4all/icon';
...
@NgModule({
    declarations: [...]
    imports: [
        ...
        SmartIconModule,
    ],
    providers: [
        ...
	    SmartIconService,
    ]
    ...
})

Prerequisites

In order to use custom icons with this package you have to do the following steps:

Place the svg icons into a subfolder of the /assets

assets/customIcons/

• customAddIcon.svg
• customUserIcon.svg

Change the default colours in the svg to 'color'.

assets/customIcons/customAddIcon.svg

<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
    <path ... fill="color" stroke="color" />
</svg>

Create an enum which contains all the icons and their paths.

src/app/icons/customIcon.ts

export type CustomIcon = 'Add' | 'User';

export const CustomIcon = {
    Add: 'customAddIcon' as CustomIcon,
    User: 'customUserIcon' as CustomIcon
}

Set up the icon sets in the environment.ts. The property name of the object (in this scenario customIcons) has to match with the name of the folder that contains the svg files. The value has to be the enum which contains the name of the svg files.

src/environments.ts

import { CustomIcon } from 'src/app/icons/';

export const environment = {
    ...
    customIconSets: [{ customIcons: CustomIcon }],
};

Provide the icon sets for the SmartIconService.

src/app/app.component.ts

export class AppComponent {

    constructor(private smartIconService: SmartIconService) {
        this.smartIconService.iconSets(environment.customIconSets);
    }

}

Usage

example.component.html

<smart-icon
    [icon]="'Add'"
    [color]="'primary'"
></smart-icon>

Set the material styles for these:

custom-theme.scss

.mat-icon.mat-primary {
    stroke: blue;
    color: blue;
}
.mat-icon.mat-accent {
    stroke: red;
    color: red;
}
...

Version logs

@smartbit4all/icon v1.0.0

Type: Feature

The @smartbit4all/icon has been published.