ng-material-icons

0.0.3 • Public • Published
# ng-icons Library

The `ng-icons` library provides a simple Angular component for displaying Material Design Icons with various customization options.

## Installation

Install the library using npm:

```bash
npm install --save ng-icons
```

Usage

Import the Module

Import the NgIconsModule in your Angular module:

import { NgIconsModule } from "ng-icons";

@NgModule({
  imports: [NgIconsModule],
  // ...
})
export class YourModule {}

Add Icons to Your Component

Use the ng-icons component in your component templates:

<ng-icons iconName="Home"></ng-icons>

Customize Icons

You can customize the icon by providing additional input properties:

  • variant: Choose between 'outline' and 'solid'. Default is 'solid'.
  • buttonClick: Output event emitted when the button is clicked.

Example with customization:

<ng-icons iconName="Heart" variant="outline" (buttonClick)="handleClick()"></ng-icons>

Styling

Apply your own styles by targeting the generated classes:

  • outline-icon: Applied to the button when the variant is 'outline'.
  • solid-icon: Applied to the button when the variant is 'solid'.
/* Example styles for outline icons */
.outline-icon {
  border: 1px solid #ccc;
  padding: 5px;
}

/* Example styles for solid icons */
.solid-icon {
  background-color: #007bff;
  color: #fff;
  padding: 10px;
}

Contributing

We welcome contributions! If you find a bug or have a feature request, please open an issue. Pull requests are also appreciated.

License

This library is licensed under the MIT License - see the LICENSE file for details.


This README provides a basic structure for introducing your library
you can contact me to make changes for you use cases on mr.craft.code@gmail.com or github

Readme

Keywords

none

Package Sidebar

Install

npm i ng-material-icons

Weekly Downloads

1

Version

0.0.3

License

MITA

Unpacked Size

163 kB

Total Files

14

Last publish

Collaborators

  • ng-code