Skip to content

Commit

Permalink
reduxjs#1031 Added metadata to provider markdown and updated the side…
Browse files Browse the repository at this point in the history
…bar (reduxjs#1034)

Added missing markdown document to sidebar and updated it's structure.
  • Loading branch information
sveinpg authored and markerikson committed Oct 6, 2018
1 parent 3cc42b7 commit e3ef521
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 14 deletions.
30 changes: 17 additions & 13 deletions docs/api/Provider.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
---
id: provider
title: Provider
sidebar_label: Provider
---

# `<Provider />`

## Overview

The `<Provider />` makes the Redux `store` available to any nested components that have been wrapped in the `connect()` function.
The `<Provider />` makes the Redux `store` available to any nested components that have been wrapped in the `connect()` function.

Since any React component in a React-Redux app can be connected, most applications will render a `<Provider>` at the top level, with the entire app’s component tree inside of it.

Expand All @@ -15,26 +21,26 @@ Note: If you really need to, you can manually pass `store` as a prop to a connec
`store` (Redux Store)
The single Redux `store` in your application.

`children` (ReactElement)
The root of your component hierarchy.
`children` (ReactElement)
The root of your component hierarchy.


### Example Usage

In the example below, the `<App />` component is our root-level component. This means it’s at the very top of our component hierarchy.
In the example below, the `<App />` component is our root-level component. This means it’s at the very top of our component hierarchy.

**Vanilla React Example**
**Vanilla React Example**

```js
import React from 'react';
import ReactDOM from 'react-dom';
import { Provider } from 'react-redux';

import { App } from './App';
import createStore from './createReduxStore';

const store = createStore();

ReactDOM.render(
<Provider store={store}>
<App />
Expand All @@ -51,14 +57,14 @@ In the example below, the `<App />` component is our root-level component. This
import ReactDOM from 'react-dom';
import { Provider } from 'react-redux';
import { Router, Route } from 'react-router-dom';

import { App } from './App';
import { Foo } from './Foo';
import { Bar } from './Bar';
import createStore from './createReduxStore';

const store = createStore();

ReactDOM.render(
<Provider store={store}>
<Router history={history}>
Expand All @@ -71,5 +77,3 @@ In the example below, the `<App />` component is our root-level component. This
document.getElementById('root')
)
```


4 changes: 3 additions & 1 deletion website/sidebars.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"docs": {
"Docs": ["getting-started", "api", "troubleshooting"]
"Introduction": ["getting-started"],
"API Reference": ["api", "api/provider"],
"Guides": ["troubleshooting"]
}
}

0 comments on commit e3ef521

Please sign in to comment.