Skip to content

Commit

Permalink
Merge branch 'master' into v3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Yannick authored Jan 27, 2018
2 parents 189a594 + c003679 commit 34d96e0
Showing 1 changed file with 75 additions and 0 deletions.
75 changes: 75 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,10 +231,32 @@ The CreateAccount Component is located at
```

### Attributes
The CreateAccount Component accepts the following attributes

Attribute | Type | Usage
--- | --- | ---
createAccount | function | Function that handles creating the user account and sends them to [Overview Component](#overview-component).

## DatePicker Component
### Usage
The DatePicker Component consists of the following
* Label
* Input (date)
* You choose the date

### Location
The DatePicker Component is located at
```
src/components/datePicker/
```
### Attributes
The DatePicker Component accepts the following attributes

Attribute | Type | Usage
--- | --- | ---
label | string | What should the label of the input field be.
handleState | function | Saves what the date should be.

## Edit Component
### Usage
The Edit Component consists of the following
Expand Down Expand Up @@ -338,6 +360,59 @@ Filter | string | What should the filter be.
Text | string | What text should the button display.
HandleFilter | function | function that handles the filtering.

## Footer Component
### Usage
The Footer Component consists of the following
* Overview (icon)
* When clicked on Overview it will send them to [Overview Component](#overview-component).
* Request (icon)
* When clicked on Request it will send them to [Request Component](#request-component).
* Account (icon)
* When clicked on Account it will send them to [Account Component](#account-component).
* Notifications (icon)
* When clicked on Notifications it will send them to [Notifications Component](#notifications-component).

### Location
The Footer Component is located at
```
src/components/footer/
```
### Attributes
The Footer Component accepts the following attributes

Attribute | Type | Usage
--- | --- | ---
--- | --- | ---

## FormItem Component
### Usage
The FormItem Component consists of the following
* Label (measurement type)
* Select
* Option
* Value
* Acidity
* Salinity
* Tempature
* Label (value)
* Input (number)
* Remove Button
* Value
* Remove item

### Location
The FormItem is located at
```
src/components/formItem/
```
### Attributes
The FormItem Component accepts the following attributes

Attribute | Type | Usage
--- | --- | ---
Item| string | Used to get the value that was selected.
Value | string | What should the default value of the input field be.

## Header Component
### Usage
The Header component consists of the following
Expand Down

0 comments on commit 34d96e0

Please sign in to comment.