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.

Sign up for GitHub

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

Jump to bottom

Add documentation for using boundActionCreators fixes #4029 #4042

Merged
merged 3 commits into from
Feb 15, 2018
Merged

Add documentation for using boundActionCreators fixes #4029 #4042

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81366c0
Add documentation for using boundActionCreators
ajayns Feb 14, 2018
b7c197e
Update bound-action-creators.js
KyleAMathews Feb 15, 2018
8456058
Fix
KyleAMathews Feb 15, 2018
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
18 changes: 18 additions & 0 deletions www/src/pages/docs/bound-action-creators.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,24 @@ class ActionCreatorsDocs extends React.Component {
and dispatch Redux actions when called) which you can use to
manipulate state on your site.
</p>
<p>
The object
{` `}
<code>boundActionCreators</code>
{` `}
contains the functions and these can be individually extracted by
using ES6 object destructuring.
</p>
<pre
dangerouslySetInnerHTML={{
__html: `
<code class=" language-javascript"><span class="token comment">// For function createNodeField</span>
exports<span class="token punctuation">.</span><span class="token function-variable function">onCreateNode</span> <span class="token operator">=</span> <span class="token punctuation">(</span><span class="token punctuation">{</span> node<span class="token punctuation">,</span> getNode<span class="token punctuation">,</span> boundActionCreators <span class="token punctuation">}</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
<span class="token keyword">const</span> <span class="token punctuation">{</span> createNodeField <span class="token punctuation">}</span> <span class="token operator">=</span> boundActionCreators
<span class="token punctuation">}</span></code>
`,
}}
/>
<h2 css={{ marginBottom: rhythm(1 / 2) }}>Functions</h2>
<ul css={{ ...scale(-1 / 5) }}>
{this.props.data.allDocumentationJs.edges.map(({ node }, i) => (
Expand Down