Giter Club home page Giter Club logo

angular-icons's Introduction

angular-icons

A collection of icon libraries to use in your angular apps

GitHub version

Usage

The following icon libraries are supported by Angular Icons:

  • Iconic
  • Open Iconic
  • Ionicons
  • Material Icons

You can include an icon from one of the above libraries by using the provided directives:

  • ba-iconic
  • ba-open-iconic
  • ba-ionicon
  • ba-material-icon

Each of the directives has an icon attribute which can be used to easily load an icon:

  • <ba-iconic icon="thumb"></ba-iconic>
  • <ba-open-iconic icon="thumb-up"></ba-open-iconic>
  • <ba-ionicon icon="ios-thumbs-up"></ba-ionicon>
  • <ba-material-icon icon="thumb-up"></ba-material-icon>

Styling of the icons is provided as part of Angular Base Apps.

angularIcons.iconic (Module)

Iconic (Service)

You can use the IconicProvider to configure the default path to the iconic assets. The following methods exist:

  • setAssetPath(path) - sets the full path to the icons
    • useful if hosting the icons locally or if using a non-supported CDN
  • setCdn(cdn) - sets the CDN to use for the icons
    • the icons are hosted on the following CDNs: npmcdn (default), jsdelivr

ba-iconic (Directive)

A directive used to load an icon from Iconic. The directive has the following supported attributes:

  • icon-dir: changes the directory for the icons (default specified by Iconic service)
  • src: full path to the icon (including svg extension)
  • size: use the values small, medium, or large to size the icon (by default all iconic icons are responsive and will fill to fit their entire container)
  • dyn-icon: use this attribute to define the name of the icon using an expression
  • dyn-icon-attrs: use this attribute to define the icon attributes using an object

Each icon from iconic may also provide a set of attributes to further customize the icon. For instance the data-direction attribute can be used for the chevron icon to specify the direction of the chevron.

angularIcons.openIconic (Module)

OpenIconic (Service)

You can use the OpenIconicProvider to configure the default path to the open iconic assets. The following methods exist:

  • setAssetPath(path) - sets the full path to the icons
    • useful if hosting the icons locally or if using a non-supported CDN
  • setCdn(cdn) - sets the CDN to use for the icons
    • the icons are hosted on the following CDNs: npmcdn (default), jsdelivr

ba-open-iconic (Directive)

A directive used to load an icon from Open Iconic.

angularIcons.ionicons (Module)

Ionicons (Service)

You can use the IoniconsProvider to configure the default path to the ionicons assets. The following methods exist:

  • setAssetPath(path) - sets the full path to the icons
    • useful if hosting the icons locally or if using a non-supported CDN
  • setCdn(cdn) - sets the CDN to use for the icons
    • the icons are hosted on the following CDNs: npmcdn (default), jsdelivr

ba-ionicon (Directive)

A directive used to load an icon from Ionicon.

angularIcons.materialIcons (Module)

MaterialIcons (Service)

You can use the MaterialIconsProvider to configure the default path to the material icons assets. The following methods exist:

  • setAssetPath(path) - sets the full path to the icons
    • useful if hosting the icons locally or if using a non-supported CDN
  • setCdn(cdn) - sets the CDN to use for the icons
    • the icons are hosted on the following CDNs: npmcdn (default), jsdelivr

ba-material-icon (Directive)

A directive used to load an icon from Material Icons.

angular-icons's People

Contributors

soumak77 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.