0.3.1 • Published 3 years ago

soccer-lineup v0.3.1

Weekly downloads
6
License
MIT
Repository
github
Last release
3 years ago

react-soccer-lineup

⚽ React Soccer Line up - A soccer pitch representation component for React ⚛️

NPM JavaScript Style Guide

Install

npm install --save react-soccer-lineup

Usage

import React, { Component } from 'react'

import SoccerLineUp from 'react-soccer-lineup'

class Example extends Component {

    render () {

        return (
            <SoccerLineUp
                size={ "small" }
                color={ "lightseagreen" }
                pattern={ "circles" }
            />
        )

    }
}

API

PropTypeRequiredDefault valueDescription
colorstringNo#588f58 #588f58The pitch background color
sizestringNo"normal"Pitch dimensions. Supported values: small, normal, big, responsive, fill
patternstringNo-The pattern applied to the pitch grass. Supported values: lines, squares, circles
homeTeamTeamNo-The left side team
awayTeamTeamNo-The right side team

Team

AttributeTypeRequiredDefault valueDescription
colorstringNo-The team players color
squadSquadYes-The team players by role

Squad

AttributeTypeRequiredDefault valueDescription
gkPlayerNo-The squad goalkeeper
dfPlayer[]No-The squad defenders
cdmPlayer[]No-The squad central defensive midfielders
cmPlayer[]No-The squad central midfielders
camPlayer[]No-The squad central attack midfielders
fwPlayer[]No-The squad forwards

Player

AttributeTypeRequiredDefault valueDescription
namestringNo-The displayed player name
numbernumberNo-The displayed player number

Live

Check a live example here.

License

MIT © giustini

0.3.1

3 years ago

0.3.0

3 years ago