1.0.1 • Published 4 years ago

stencil-feather v1.0.1

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

Stencil Feather

Feather Icon web component using stencil.js for Vue, Angular & React to use icon as single icon or as a sprite. Feather Icons Demo

Installation

npm install feather-icons stencil-feather
npm start

In browser

<script src="/path/to/stencil-feather.js"></script><!-- Register automatically once loaded -->

Framework Integrations

For integrations in vue, react & angular see stenciljs

Vue

Import the stencil-feather into the 'main.js' stencil-feather component feather-icon should then be available in any of the Vue components

import { applyPolyfills, defineCustomElements } from 'stencil-feather/loader';

Vue.config.ignoredElements = [/feather-\w*/];

applyPolyfills().then(() => {
  defineCustomElements();
})

Angular

Import the stencil-feather into the 'main.ts' stencil-feather component feather-icon should then be available in any of the Angular components

import { defineCustomElements } from 'stencil-feather/loader';

platformBrowserDynamic().bootstrapModule(AppModule)
  .catch(err => console.log(err));
defineCustomElements();

React

Import the stencil-feather into the 'index.js' stencil-feather component feather-icon should then be available in any of the React components

import { applyPolyfills, defineCustomElements } from 'stencil-feather/loader';

applyPolyfills().then(() => {
  defineCustomElements();
});

Usage

Icons can be configured with inline props:

As an icon

<feather-icon name="anchor"></feather-icon>

As an sprite

<feather-sprite name="anchor"></feather-sprite>

Size

Add any font size as em, px or rems Default: 1em

  <feather-icon name="activity"></feather-icon> 
  <feather-icon name="activity" size="2em"></feather-icon> 
  <feather-icon name="activity" size="3em"></feather-icon>
  <feather-icon name="activity" size="4em"></feather-icon>
  <feather-icon name="activity" size="5em"></feather-icon>

Inputs

Property/AttributeType/Default/Description
nameType: string, Default: null, Name of Feather Icon
sizeType: string, Default: 1em, Add any font size as em, px or rems