Instant React Core

Core instant-react functionality, including components, forms, Redux modules, utilities and Firebase integration.

Table of Contents

• Installation

• Usage

• API

  • Components
    • Alert
    • AppBar
    • AppliedRoute
    • DatePicker
    • FileUploaded
    • FileUploading
    • ForgotPasswordPanel
    • ImageDialog
    • ImageList
    • LoadingPanel
    • Map
    • PageHeading
    • PageNotFound
    • Phone
    • ProgressButton
    • ScreenMessage
    • Sidebar
    • Signature
    • SignIn
    • SignInPanel
    • Snackbar
    • Thumbnail
    • TimePicker
    • UnauthenticatedRoute
    • UploadFiles
  • Forms
    • Address
    • AddressAutocomplete
    • AddressWithAutocomplete
    • Checkbox
    • DatePicker
    • Email
    • FullName
    • PhoneNumber
    • RadioGroup
    • Signature
    • TextField
    • TimePicker
    • UploadFiles
  • Layouts
    • UploadFiles
  • Redux
    • reducers
    • selectors
    • store
  • Utils
    • component
    • firebase
    • form
    • request

• Contributing

• License

Installation

You can install this package using npm:

$ npm install instant-react-core

Usage

Here is a quick example to get you started:

ES Modules

import Alert from 'instant-react-core/components/Alert';

function App() {
  return <Alert variant="success" />;
}

CommonJS Modules

const Alert = require('instant-react/components/Alert');

function App() {}
  return <Alert variant="success"/>
}

API

Components

Extends Material-UI components.

Alert

AppBar

AppliedRoute

DatePicker

FileUploaded

FileUploading

ForgotPasswordPanel

ImageDialog

ImageList

LoadingPanel

Map

PageHeading

PageNotFound

Phone

ProgressButton

ScreenMessage

Sidebar

Signature

SignIn

SignInPanel

Snackbar

Thumbnail

TimePicker

UnauthenticatedRoute

UploadFiles

Forms

Extends Redux Form fields.

Address

AddressAutocomplete

AddressWithAutocomplete

Checkbox

DatePicker

Email

FullName

PhoneNumber

RadioGroup

Signature

TextField

TimePicker

UploadFiles

Layouts

Default

Redux

Utilises Redux, Redux Thunk and Redux Localstorage

reducers

selectors

store

Utils

component

firebase

form

request

Contributing

We'd greatly appreciate any contribution you make.

License

MIT