Skip to content
This repository has been archived by the owner on Mar 11, 2024. It is now read-only.

Commit

Permalink
update react-components readme LoadingContainer references
Browse files Browse the repository at this point in the history
  • Loading branch information
SeanJCasey committed Aug 24, 2019
1 parent c3739e1 commit cf3a3e9
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions packages/react-components/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ For 1.x.x this is how you import the different components:

```
import { newContextComponents } from "@drizzle/react-components";
const { AccountData, ContractData, ContractForm } = newContextComponents;
const { AccountData, ContractData, ContractForm, LoadingContainer } = newContextComponents;
```

`LoadingContainer` is not provided with the new context components currently. Also note that you must pass in `drizzle` and `drizzleState` for each of these components.
Note that you must pass in `drizzle` and `drizzleState` for each of these components.

### Legacy Context Components

Expand All @@ -30,14 +30,16 @@ import {

Refer to the included [test apps](#test-apps) for usage examples.

### LoadingContainer (Legacy only)
### LoadingContainer

This component wraps your entire app (but within the DrizzleProvider) and will show a loading screen until Drizzle, and therefore web3 and your contracts, are initialized.
This component wraps your entire app (but within the DrizzleProvider) and will show a loading screen until Drizzle, and therefore web3 and your contracts, are initialized. If using `networkWhitelist` in your `drizzleOptions`, it will also detect if the provider is connected to a non-whitelisted network and display a warning message.

`loadingComp` (component) The component displayed while Drizzle initializes.

`errorComp` (component) The component displayed if Drizzle initialization fails.

`networkMismatchComp` (component) The component displayed if the provider is connected to a non-whitelisted network.

### AccountData

`accountIndex` (number, required) Index of account from which to retrieve balance.
Expand Down

0 comments on commit cf3a3e9

Please sign in to comment.