Skip to content

anubhavsrivastava/react-lineicons

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

react-lineicons

build status PRs Welcome GitHub issues HitCount

NPM

Simple react component for using lineicons in React application.

Check icons here

Installation

react-lineicons is available as an npm package.

npm install react-lineicons

or

yarn add react-lineicons

Usage

import React from "react";
import ReactDOM from "react-dom";
import LineIcon from "react-lineicons";

function App() {
  return <LineIcon name="spinner" />;
}

Options

Property Type Values Description
name String e.g. alarm the name of the icon, see lineicons for list of all available icons
tag String e.g. 'li' by default, Icon tag is i, which can be changed to any valid HTML element
size String 'lg', 'md', 'sm', 'xs' the size of the icon
style Object custom style object
effect String 'spin', 'tada', 'flashing', 'burst', 'fade-left', 'fade-right', 'fade-up', 'fade-down' Additional effect on icon

Any other prop would directly be applied as on the root element (useful for a11y).


Using the Pro version of LineIcons

This module only works with free version of lineicons. To use the Pro version, please use the download section from your lineicons dashboard.


Contribution

Suggestions and PRs are welcome!

Please create issue or open PR request for contribution.


License

Open Source Love

refer LICENSE file in this repository.