Skip to content

lyef/lyef-pokemon

Repository files navigation

Lyef Pokemon

Build Status Badge size Badge gzip size NPM version

Pokemons

A react component to show any pokemon from different generations.

Demo

Live examples

Installation

$ npm install --save lyef-pokemon

Remember to import the styles on css/main.css folder to your project.

Basic Usage

import Pokemon from 'lyef-pokemon';

...
render() {
    return (
        <Pokemon name="pikachu" gen="black-white" label />
    );
}
...

Props

  • name (string) - pokemon name - required
  • gen (string) - generation ['sun-moon', 'xy', 'black-white', 'diamond-pearl', 'emerald', 'silver', 'green'] - defaults to xy
  • label (bool) - show pokemon name

Architecture

We've developed this component using the following boilerplate: lyef-react-component.

To know more about the architecture or if you want to contribute with this component: Contributing Documentation.

License

MIT License @ lyef