Home Reference Source

References

components/controls/Button

summary
public	C Button A button control component that displays a button or a link.

components/controls/Icon

summary
public	C Icon A button control component that displays a button or a link.

components/layout/Container

summary
public	C Container A container layout component that sets document language based on Redux state and maintains the Redux width metric.

summary
public	F Header(props: Object): React.Component A header layout component that displays the logo/sidebar toggle.

summary
public	F HeaderShape(props: Object): React.Component A header shape component that displays the header curve svg.

summary
public	C Modal: React.Component A modal layout component that sets document language based on Redux state.

summary
public	F Navigation(props: Object): React.Component A navigation layout component that links to the main areas of the application.

summary
public	C NavigationItem

components/layout/Routes

summary
public	F Routes(props: Object): React.Component A component to handle all routes in the application.

components/layout/Styles

summary
public	F Styles(props: Object): React.Fragment A styles layout component that sets global styles based on Redux state.

components/views/ErrorView

summary
public	F ErrorView(props: Object): undefined[] An error page component that displays the relevant error.

components/views/HomeView

summary
public	F HomeView(props: Object): React.Fragment A home page component showcasing WIP components.

components/views/View

summary
public	C View A page wrapper component that can update the user's language from a route param.

lib/helpers

summary
public	F mockStore(mockState: Object): Object A helper to test Redux connected components by passing a mocked Redux store.

stores

summary
public	V persistor: Object The persistor object from redux-persist.
public	V store: Object The Redux store.

stores/settings

summary
public	V settingsDefaultState: Object The initial state of the Settings Redux store.

stores/settings/actions

summary
public	F storeSettings(data: Object): Object This function sends an action to store the new data to settingsReducer.
public	F updateSettings(data: Object): Object This function sends an action to be intercepted by watchUpdateSettings.

stores/settings/reducer

summary
public	F settingsReducer(state: Object, action: Object): Object The Settings reducer.

stores/settings/sagas

summary
public	F * updateSettingsSaga(action: Object) This generator function stores the action data yielded from watchUpdateSettings.
public	F * watchUpdateSettings() This generator function watchs for every updateSettings call.

stores/ui

summary
public	V uiDefaultState: Object The initial state of the UI Redux store.

stores/ui/actions

summary
public	F hideModal(): Object This function sends an action to be intercepted by watchHideModal.
public	F showModal(data: string): Object This function sends an action to be intercepted by watchShowModal.
public	F storeMetric(data: Object): Object This function sends an action to store the new data to uiReducer.
public	F storeUi(data: Object): Object This function sends an action to store the new data to uiReducer.
public	F updateMetric(data: Object): Object This function sends an action to be intercepted by watchUpdateMetric.
public	F updateUi(data: Object): Object This function sends an action to be intercepted by watchUpdateUi.

stores/ui/reducer

summary
public	F uiReducer(state: Object, action: Object): Object The UI reducer.

stores/ui/sagas

summary
public	F * hideModalSaga() This generator function hides the modal.
public	F * showModalSaga(action: Object) This generator function shows the modal with action data yielded from watchShowModal.
public	F * updateMetricSaga(action: Object) This generator function stores the action data yielded from watchUpdateMetric.
public	F * updateUiSaga(action: Object) This generator function stores the action data yielded from watchUpdateUi.
public	F * watchHideModal() This generator function watchs for the latest hideModal call.
public	F * watchShowModal() This generator function watchs for the latest showModal call.
public	F * watchUpdateMetric() This generator function watchs for the latest updateMetric call.
public	F * watchUpdateUi() This generator function watchs for every updateUi call.

Directories