Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#1031 Added metadata to provider markdown and updated the sidebar #1034

Merged
merged 1 commit into from
Oct 6, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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"]
}
}