Home Reference Source

Function

Static Public Summary
public

An error page component that displays the relevant error.
public

Header(props: Object): React.Component

A header layout component that displays the logo/sidebar toggle.
public

HeaderShape(props: Object): React.Component

A header shape component that displays the header curve svg.
public

HomeView(props: Object): React.Fragment

A home page component showcasing WIP components.
public

Navigation(props: Object): React.Component

A navigation layout component that links to the main areas of the application.
public

Routes(props: Object): React.Component

A component to handle all routes in the application.
public

Styles(props: Object): React.Fragment

A styles layout component that sets global styles based on Redux state.
public

This function sends an action to be intercepted by watchHideModal.
public

This generator function hides the modal.
public

mockStore(mockState: Object): Object

A helper to test Redux connected components by passing a mocked Redux store.
public

settingsReducer(state: Object, action: Object): Object

The Settings reducer.
public

This function sends an action to be intercepted by watchShowModal.
public

* showModalSaga(action: Object)

This generator function shows the modal with action data yielded from watchShowModal.
public

This function sends an action to store the new data to uiReducer.
public

This function sends an action to store the new data to settingsReducer.
public

This function sends an action to store the new data to uiReducer.
public

uiReducer(state: Object, action: Object): Object

The UI reducer.
public

This function sends an action to be intercepted by watchUpdateMetric.
public

This generator function stores the action data yielded from watchUpdateMetric.
public

This function sends an action to be intercepted by watchUpdateSettings.
public

This generator function stores the action data yielded from watchUpdateSettings.
public

This function sends an action to be intercepted by watchUpdateUi.
public

* updateUiSaga(action: Object)

This generator function stores the action data yielded from watchUpdateUi.
public

This generator function watchs for the latest hideModal call.
public

This generator function watchs for the latest showModal call.
public

This generator function watchs for the latest updateMetric call.
public

This generator function watchs for every updateSettings call.
public

This generator function watchs for every updateUi call.

Static Public

public ErrorView(props: Object): undefined[] source 

import {ErrorView} from 'pokedex-net-client/src/components/views/ErrorView/index.js'

An error page component that displays the relevant error.

Params:

NameTypeAttributeDescription
props Object

React Component props.
props.error string

The error to display.
props.lang string

Language identifier mapped from Redux store.

Return:

undefined[]

public Header(props: Object): React.Component source 

import {Header} from 'pokedex-net-client/src/components/layout/Header/index.js'

A header layout component that displays the logo/sidebar toggle.

Params:

NameTypeAttributeDescription
props Object

React Component props.
props.headerHeight string

The header height metric mapped from Redux store.
props.sidebarOpen string

???
props.updateUi string

???

Return:

React.Component

public HeaderShape(props: Object): React.Component source 

import {HeaderShape} from 'pokedex-net-client/src/components/layout/Header/HeaderShape/index.js'

A header shape component that displays the header curve svg.

Params:

NameTypeAttributeDescription
props Object

React Component props.
props.headerHeight string

The header height metric mapped from Redux store.
props.lang string

Language identifier mapped from Redux store.
props.windowWidth string

The window width metric mapped from Redux store.

Return:

React.Component

public HomeView(props: Object): React.Fragment source 

import {HomeView} from 'pokedex-net-client/src/components/views/HomeView/index.js'

A home page component showcasing WIP components.

Params:

NameTypeAttributeDescription
props Object

React Component props.
props.lang string

Language identifier mapped from Redux store.

Return:

React.Fragment

public Navigation(props: Object): React.Component source 

import {Navigation} from 'pokedex-net-client/src/components/layout/Navigation/index.js'

A navigation layout component that links to the main areas of the application.

Params:

NameTypeAttributeDescription
props Object

React Component props.
props.headerHeight string

Header height mapped from Redux store.
props.lang string

???
props.sidebarOpen string

???
props.sidebarWidth string

???
props.windowWidth string

???

Return:

React.Component

public Routes(props: Object): React.Component source 

import {Routes} from 'pokedex-net-client/src/components/layout/Routes/index.js'

A component to handle all routes in the application.

Params:

NameTypeAttributeDescription
props Object

React Component props.
props.location string

Location object from React Router.

Return:

React.Component

public Styles(props: Object): React.Fragment source 

import {Styles} from 'pokedex-net-client/src/components/layout/Styles/index.js'

A styles layout component that sets global styles based on Redux state.

Params:

NameTypeAttributeDescription
props Object

React Component props.
props.theme string

Theme identifier mapped from Redux store.

Return:

React.Fragment

public hideModal(): Object source 

import {hideModal} from 'pokedex-net-client/src/stores/ui/actions/index.js'

This function sends an action to be intercepted by watchHideModal.

Return:

Object

Redux action

public * hideModalSaga() source 

import {hideModalSaga} from 'pokedex-net-client/src/stores/ui/sagas/index.js'

This generator function hides the modal.

Emit:

storeUi

public mockStore(mockState: Object): Object source 

import {mockStore} from 'pokedex-net-client/src/lib/helpers/index.js'

A helper to test Redux connected components by passing a mocked Redux store.

Params:

NameTypeAttributeDescription
mockState Object

A mock Redux state.

Return:

Object

A mocked Redux store.

public settingsReducer(state: Object, action: Object): Object source 

import settingsReducer from 'pokedex-net-client/src/stores/settings/reducer/index.js'

The Settings reducer.

Params:

NameTypeAttributeDescription
state Object
  • optional
  • default: settingsDefaultState

Redux state
action Object

Redux action

Return:

Object

Updated Redux state

public showModal(data: string): Object source 

import {showModal} from 'pokedex-net-client/src/stores/ui/actions/index.js'

This function sends an action to be intercepted by watchShowModal.

Params:

NameTypeAttributeDescription
data string

A string with the value to update in the store.

Return:

Object

Redux action

public * showModalSaga(action: Object) source 

import {showModalSaga} from 'pokedex-net-client/src/stores/ui/sagas/index.js'

This generator function shows the modal with action data yielded from watchShowModal.

Params:

NameTypeAttributeDescription
action Object

Redux action

Emit:

storeUi

public storeMetric(data: Object): Object source 

import {storeMetric} from 'pokedex-net-client/src/stores/ui/actions/index.js'

This function sends an action to store the new data to uiReducer.

Params:

NameTypeAttributeDescription
data Object

An object with the key/value pair to store in the store.

Return:

Object

Redux action

public storeSettings(data: Object): Object source 

import {storeSettings} from 'pokedex-net-client/src/stores/settings/actions/index.js'

This function sends an action to store the new data to settingsReducer.

Params:

NameTypeAttributeDescription
data Object

An object with the key/value pair to store in the store.

Return:

Object

Redux action

public storeUi(data: Object): Object source 

import {storeUi} from 'pokedex-net-client/src/stores/ui/actions/index.js'

This function sends an action to store the new data to uiReducer.

Params:

NameTypeAttributeDescription
data Object

An object with the key/value pair to store in the store.

Return:

Object

Redux action

public uiReducer(state: Object, action: Object): Object source 

import uiReducer from 'pokedex-net-client/src/stores/ui/reducer/index.js'

The UI reducer.

Params:

NameTypeAttributeDescription
state Object
  • optional
  • default: uiDefaultState

Redux state
action Object

Redux action

Return:

Object

Updated Redux state

public updateMetric(data: Object): Object source 

import {updateMetric} from 'pokedex-net-client/src/stores/ui/actions/index.js'

This function sends an action to be intercepted by watchUpdateMetric.

Params:

NameTypeAttributeDescription
data Object

An object with the key/value pair to update in the store.

Return:

Object

Redux action

public * updateMetricSaga(action: Object) source 

import {updateMetricSaga} from 'pokedex-net-client/src/stores/ui/sagas/index.js'

This generator function stores the action data yielded from watchUpdateMetric.

Params:

NameTypeAttributeDescription
action Object

Redux action

Emit:

storeMetric

public updateSettings(data: Object): Object source 

import {updateSettings} from 'pokedex-net-client/src/stores/settings/actions/index.js'

This function sends an action to be intercepted by watchUpdateSettings.

Params:

NameTypeAttributeDescription
data Object

An object with the key/value pair to update in the store.

Return:

Object

Redux action

public * updateSettingsSaga(action: Object) source 

import {updateSettingsSaga} from 'pokedex-net-client/src/stores/settings/sagas/index.js'

This generator function stores the action data yielded from watchUpdateSettings.

Params:

NameTypeAttributeDescription
action Object

Redux action

Emit:

storeSettings

public updateUi(data: Object): Object source 

import {updateUi} from 'pokedex-net-client/src/stores/ui/actions/index.js'

This function sends an action to be intercepted by watchUpdateUi.

Params:

NameTypeAttributeDescription
data Object

An object with the key/value pair to update in the store.

Return:

Object

Redux action

public * updateUiSaga(action: Object) source 

import {updateUiSaga} from 'pokedex-net-client/src/stores/ui/sagas/index.js'

This generator function stores the action data yielded from watchUpdateUi.

Params:

NameTypeAttributeDescription
action Object

Redux action

Emit:

storeUi

public * watchHideModal() source 

import {watchHideModal} from 'pokedex-net-client/src/stores/ui/sagas/index.js'

This generator function watchs for the latest hideModal call.

Emit:

hideModalSaga

public * watchShowModal() source 

import {watchShowModal} from 'pokedex-net-client/src/stores/ui/sagas/index.js'

This generator function watchs for the latest showModal call.

Emit:

showModalSaga

public * watchUpdateMetric() source 

import {watchUpdateMetric} from 'pokedex-net-client/src/stores/ui/sagas/index.js'

This generator function watchs for the latest updateMetric call.

Emit:

updateMetricSaga

public * watchUpdateSettings() source 

import {watchUpdateSettings} from 'pokedex-net-client/src/stores/settings/sagas/index.js'

This generator function watchs for every updateSettings call.

Emit:

updateSettingsSaga

public * watchUpdateUi() source 

import {watchUpdateUi} from 'pokedex-net-client/src/stores/ui/sagas/index.js'

This generator function watchs for every updateUi call.

Emit:

updateUiSaga