npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@smartbit4all/icon

v1.0.2

Published

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

Downloads

24

Readme

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.