Skip to content

Component Documentation

Jessica Spratley edited this page Mar 1, 2017 · 8 revisions

#Components

##Text

Props allowed:

  • className: a class defined in styles.css
  • color: one of {black,white}
  • size: font-size=number
  • tag: tag="p" (optional)

##Icons Icons are taken from Font Awesome

Props allowed:

  • name: name= name of the font-awesome icon

##Buttons

Props allowed:

  • className: a class defined in styles.css
  • onClick: onClick= function that runs when the button is clicked
  • icon: icon= the name of the font-awesome icon for the button (optional)
  • color: one of {purple} (add more as more buttons needed)
  • An option to make the button bigger or wider? tbd

##TextInput

Props allowed:

  • className: a class defined in styles.css
  • width
  • height
  • placeholder

##Navbar

  • Defines the main navbar used in the app

##HorizontalLine

Props allowed:

  • className: a class defined in styles.css
  • width
  • margin-bottom
  • margin-top
  • color: just {'black'} for now (leave blank for default light gray)

#Instructions for adding to documentation:

  • Add the component to the list
  • Document allowed prop types and how to use them

Clone this wiki locally