mirror of
https://github.com/strapi/strapi.git
synced 2025-08-19 06:08:50 +00:00
357 lines
72 KiB
HTML
357 lines
72 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en-US">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
|
|
<title>Helpers | Strapi Docs</title>
|
||
|
|
<meta name="description" content="API creation made simple, secure and fast.">
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="preload" href="/documentation/assets/css/styles.a8210063.css" as="style"><link rel="preload" href="/documentation/assets/js/app.a8210063.js" as="script"><link rel="preload" href="/documentation/assets/js/69.3f4ed952.js" as="script"><link rel="prefetch" href="/documentation/assets/js/28.9b077c15.js"><link rel="prefetch" href="/documentation/assets/css/1.styles.77d89b12.css"><link rel="prefetch" href="/documentation/assets/js/1.77d89b12.js"><link rel="prefetch" href="/documentation/assets/css/2.styles.08038ddb.css"><link rel="prefetch" href="/documentation/assets/js/2.08038ddb.js"><link rel="prefetch" href="/documentation/assets/js/3.4d92d5e3.js"><link rel="prefetch" href="/documentation/assets/js/4.385ae6a0.js"><link rel="prefetch" href="/documentation/assets/js/5.edd21cb3.js"><link rel="prefetch" href="/documentation/assets/js/6.fd6e4b24.js"><link rel="prefetch" href="/documentation/assets/js/7.e1f45fa9.js"><link rel="prefetch" href="/documentation/assets/js/8.dc78e1c2.js"><link rel="prefetch" href="/documentation/assets/js/9.fd6a21e6.js"><link rel="prefetch" href="/documentation/assets/js/10.f9e7d997.js"><link rel="prefetch" href="/documentation/assets/js/11.bfb9de0f.js"><link rel="prefetch" href="/documentation/assets/js/12.124227d1.js"><link rel="prefetch" href="/documentation/assets/js/13.d8092700.js"><link rel="prefetch" href="/documentation/assets/js/14.7cfd4cb8.js"><link rel="prefetch" href="/documentation/assets/js/15.55a20f7c.js"><link rel="prefetch" href="/documentation/assets/js/16.5c84c402.js"><link rel="prefetch" href="/documentation/assets/js/17.1c93d494.js"><link rel="prefetch" href="/documentation/assets/js/18.e1f1758f.js"><link rel="prefetch" href="/documentation/assets/js/19.8d1b00cd.js"><link rel="prefetch" href="/documentation/assets/js/20.856d7bdd.js"><link rel="prefetch" href="/documentation/assets/js/21.6f851286.js"><link rel="prefetch" href="/documentation/assets/js/22.7ddb4e1d.js"><link rel="prefetch" href="/documentation/assets/js/23.15e5a0c3.js"><link rel="prefetch" href="/documentation/assets/js/24.6fdf34d0.js"><link rel="prefetch" href="/documentation/assets/js/25.21c9a549.js"><link rel="prefetch" href="/documentation/assets/js/26.6608295c.js"><link rel="prefetch" href="/documentation/assets/js/27.2c9596ea.js"><link rel="prefetch" href="/documentation/assets/js/29.8ea8ecc1.js"><link rel="prefetch" href="/documentation/assets/js/30.5d2829b8.js"><link rel="prefetch" href="/documentation/assets/js/31.fad00a3a.js"><link rel="prefetch" href="/documentation/assets/js/32.a6900221.js"><link rel="prefetch" href="/documentation/assets/js/33.bbfb3084.js"><link rel="prefetch" href="/documentation/assets/js/34.0eb2f8aa.js"><link rel="prefetch" href="/documentation/assets/js/35.76c29241.js"><link rel="prefetch" href="/documentation/assets/js/36.dfcc07a1.js"><link rel="prefetch" href="/documentation/assets/js/37.173a8112.js"><link rel="prefetch" href="/documentation/assets/js/38.b86fac79.js"><link rel="prefetch" href="/documentation/assets/js/39.a7d50afe.js"><link rel="prefetch" href="/documentation/assets/js/40.0415492d.js"><link rel="prefetch" href="/documentation/assets/js/41.5ef681df.js"><link rel="prefetch" href="/documentation/assets/js/42.fdd80522.js"><link rel="prefetch" href="/documentation/assets/js/43.03b496f2.js"><link rel="prefetch" href="/documentation/assets/js/44.3f55a367.js"><link rel="prefetch" href="/documentation/assets/js/45.6746c3dc.js"><link rel="prefetch" href="/documentation/assets/js/46.ff6bc353.js"><link rel="prefetch" href="/documentation/assets/js/47.53b7147a.js"><link rel="prefetch" href="/documentation/assets/js/48.31a883aa.js"><link rel="prefetch" href="/documentation/assets/js/49.18bd1a60.js"><link rel="prefetch" href="/documentation/assets/js/50.9b6079cd.js"><link rel="prefetch" href="/documentation/assets/js/51.b67aee1b.js"><link rel="prefetch" href="/documentation/assets/js/52.62bc63b6.js"><link rel="prefetch" href="/documentation/assets/js/53.2c567c55.js"><link rel="prefetch" href="/documentation/assets/js/54.6cc10d25.js"><link rel="prefetch" href="/docum
|
||
|
|
<link rel="stylesheet" href="/documentation/assets/css/styles.a8210063.css"><link rel="stylesheet" href="/documentation/assets/css/1.styles.77d89b12.css"><link rel="stylesheet" href="/documentation/assets/css/2.styles.08038ddb.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/documentation/" class="home-link router-link-active"><!----> <span class="site-name">
|
||
|
|
Strapi Docs
|
||
|
|
</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"> <a href="https://github.com/strapi/strapi" target="_blank" rel="noopener noreferrer" class="repo-link">
|
||
|
|
GitHub
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav></div></header> <div class="sidebar-mask"></div> <div class="sidebar"><nav class="nav-links"> <a href="https://github.com/strapi/strapi" target="_blank" rel="noopener noreferrer" class="repo-link">
|
||
|
|
GitHub
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav> <div><select class="version-selector"><option value="/3.x.x/" selected="selected">Version 3.x.x</option><option value="/1.x.x/">Version 1.x.x</option></select></div> <ul class="sidebar-links"><li><div class="sidebar-group first"><p class="sidebar-heading open"><span>UsefulLinks</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/documentation/3.x.x/" class="sidebar-link">Introduction</a></li><li><a href="https://strapi.io" class="sidebar-link">Strapi Website</a></li><li><a href="https://github.com/strapi/strapi" class="sidebar-link">GitHub Repository</a></li><li><a href="https://github.com/strapi/strapi/blob/master/CONTRIBUTING.md" class="sidebar-link">Contribution Guide</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Getting started</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/documentation/3.x.x/getting-started/installation.html" class="sidebar-link">Installation</a></li><li><a href="/documentation/3.x.x/getting-started/quick-start.html" class="sidebar-link">Quick start</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Globals</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/documentation/3.x.x/api-reference/reference.html" class="sidebar-link">API Reference</a></li><li><a href="/documentation/3.x.x/cli/CLI.html" class="sidebar-link">Command Line Interface (CLI)</a></li><li><a href="/documentation/3.x.x/concepts/concepts.html" class="sidebar-link">Concepts</a></li><li><a href="/documentation/3.x.x/configurations/configurations.html" class="sidebar-link">Configurations</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Guides</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/documentation/3.x.x/guides/authentication.html" class="sidebar-link">Authentication</a></li><li><a href="/documentation/3.x.x/guides/controllers.html" class="sidebar-link">Controllers</a></li><li><a href="/documentation/3.x.x/guides/deployment.html" class="sidebar-link">Deployment</a></li><li><a href="/documentation/3.x.x/guides/email.html" class="sidebar-link">Email</a></li><li><a href="/documentation/3.x.x/guides/filters.html" class="sidebar-link">Filters</a></li><li><a href="/documentation/3.x.x/guides/graphql.html" class="sidebar-link">GraphQL</a></li><li><a href="/documentation/3.x.x/guides/i18n.html" class="sidebar-link">Internationalization</a></li><li><a href="/documentation/3.x.x/guides/models.html" class="sidebar-link">Models</a></li><li><a href="/documentation/3.x.x/guides/policies.html" class="sidebar-link">Policies</a></li><li><a href="/documentation/3.x.x/guides/public-assets.html" class="sidebar-link">Public Assets</a></li><li><a href="/documentation/3.x.x/guides/requests.html" class="sidebar-link">Request</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Advanced</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/documentation/3.x.x/advanced/customize-admin.html" class="sidebar-link">Admin panel</a></li><li><a href="/documentation/3.x.x/advanced/hooks.html" class="sidebar-link">Hooks</a></li><li><a href="/documentation/3.x.x/advanced/logging.html" class="sidebar-link">Logging</a></li><li><a href="/documentation/3.x.x/advanced/middlewares.html" class="sidebar-link">Middlewares</a></li><li><a href="/documentation/3.x.x/advanced/usage-tracking.html" class="sidebar-link">Usage tracking</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Help</span> <!----></p> <ul class="sidebar-group-items"><li><a href="https://github.com/stra
|
||
|
|
|
||
|
|
<span class="token comment">// ...</span>
|
||
|
|
<span class="token comment">//</span>
|
||
|
|
auth<span class="token punctuation">.</span><span class="token function">setToken</span><span class="token punctuation">(</span><span class="token string">'12345'</span><span class="token punctuation">,</span> <span class="token boolean">true</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// This will set 1234 in the browser's localStorage associated with the key: jwtToken</span>
|
||
|
|
</code></pre></div><h2 id="colors"><a href="#colors" aria-hidden="true" class="header-anchor">#</a> Colors</h2> <p>This function allows to darken a color.</p> <h3 id="usage"><a href="#usage" aria-hidden="true" class="header-anchor">#</a> Usage</h3> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">import</span> <span class="token punctuation">{</span> darken <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'utils/colors'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">const</span> linkColor <span class="token operator">=</span> <span class="token function">darken</span><span class="token punctuation">(</span><span class="token string">'#f5f5f5'</span><span class="token punctuation">,</span> <span class="token number">1.5</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// Will darken #F5F5F5 by 1.5% which gives #f2f2f2.</span>
|
||
|
|
</code></pre></div><h2 id="get-url-query-parameters"><a href="#get-url-query-parameters" aria-hidden="true" class="header-anchor">#</a> Get URL Query Parameters</h2> <p>The helpers allows to retrieve the query parameters in the URL.</p> <h3 id="example"><a href="#example" aria-hidden="true" class="header-anchor">#</a> Example</h3> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">import</span> getQueryParameters <span class="token keyword">from</span> <span class="token string">'utils/getQueryParameters'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">const</span> <span class="token constant">URL</span> <span class="token operator">=</span> <span class="token string">'/create?source=users-permissions'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">const</span> source <span class="token operator">=</span> <span class="token function">getQueryParameters</span><span class="token punctuation">(</span><span class="token constant">URL</span><span class="token punctuation">,</span> <span class="token string">'source'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>source<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// users-permissions</span>
|
||
|
|
|
||
|
|
</code></pre></div><h2 id="request-helper"><a href="#request-helper" aria-hidden="true" class="header-anchor">#</a> Request helper</h2> <p>A request helper is available to handle all requests inside a plugin.</p> <p>It takes three arguments:</p> <ul><li><code>requestUrl</code>: The url we want to fetch.</li> <li><code>options</code>: Please refer to this <a href="https://github.com/github/fetch" target="_blank" rel="noopener noreferrer">documentation<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a>.</li> <li><code>true</code>: This third argument is optional. If true is passed the response will be sent only if the server has restarted check out the <a href="#example-with-server-autoreload-watcher">example</a>.</li></ul> <h3 id="usage-2"><a href="#usage-2" aria-hidden="true" class="header-anchor">#</a> Usage</h3> <p><strong>Path -</strong> <code>/plugins/my-plugin/admin/src/containers/**/sagas.js</code>.</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">import</span> <span class="token punctuation">{</span> call<span class="token punctuation">,</span> fork<span class="token punctuation">,</span> put<span class="token punctuation">,</span> takeLatest <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'redux-saga/effects'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token comment">// Our request helper</span>
|
||
|
|
<span class="token keyword">import</span> request <span class="token keyword">from</span> <span class="token string">'utils/request'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> dataFetchSucceeded<span class="token punctuation">,</span> dataFetchError <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'./actions'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> <span class="token constant">DATA_FETCH</span> <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'./constants'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">function</span><span class="token operator">*</span> <span class="token function">fetchData</span><span class="token punctuation">(</span>action<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">try</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">const</span> opts <span class="token operator">=</span> <span class="token punctuation">{</span>
|
||
|
|
method<span class="token punctuation">:</span> <span class="token string">'GET'</span><span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">}</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">const</span> requestUrl <span class="token operator">=</span> <span class="token template-string"><span class="token string">`/my-plugin/</span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span>action<span class="token punctuation">.</span>endPoint<span class="token interpolation-punctuation punctuation">}</span></span><span class="token string">`</span></span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">const</span> data <span class="token operator">=</span> <span class="token keyword">yield</span> <span class="token function">call</span><span class="token punctuation">(</span>request<span class="token punctuation">,</span> requestUrl<span class="token punctuation">,</span> opts<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">yield</span> <span class="token function">put</span><span class="token punctuation">(</span><span class="token function">dataFetchSucceeded</span><span class="token punctuation">(</span>data<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span> <span class="token keyword">catch</span><span class="token punctuation">(</span>error<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">yield</span> <span class="token function">put</span><span class="token punctuation">(</span><span class="token function">dataFetchError</span><span class="token punctuation">(</span>error<span class="token punctuation">)</span><span class="token punctuation">)</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token comment">// Individual exports for testing</span>
|
||
|
|
<span class="token keyword">function</span><span class="token operator">*</span> <span class="token function">defaultSaga</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">yield</span> <span class="token function">fork</span><span class="token punctuation">(</span>takeLatest<span class="token punctuation">,</span> <span class="token constant">DATA_FETCH</span><span class="token punctuation">,</span> fetchData<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">default</span> defaultSaga<span class="token punctuation">;</span>
|
||
|
|
</code></pre></div><h3 id="simple-example"><a href="#simple-example" aria-hidden="true" class="header-anchor">#</a> Simple example</h3> <p>Let's say that we have a container that fetches Content Type configurations depending on URL change.</p> <h4 id="routing-declaration"><a href="#routing-declaration" aria-hidden="true" class="header-anchor">#</a> Routing declaration:</h4> <p>Here we want to create a route <code>/content-type/:contentTypeName</code> for the <code>ContentTypePage</code> container.</p> <p><strong>Path —</strong> <code>./plugins/my-plugin/admin/src/container/App/index.js</code>.</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">import</span> React <span class="token keyword">from</span> <span class="token string">'react'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> connect <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'react-redux'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> bindActionCreators<span class="token punctuation">,</span> compose <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'redux'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> createStructuredSelector <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'reselect'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> Switch<span class="token punctuation">,</span> Route<span class="token punctuation">,</span> withRouter <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'react-router-dom'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> PropTypes <span class="token keyword">from</span> <span class="token string">'prop-types'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> pluginId <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'app'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">import</span> ContentTypePage <span class="token keyword">from</span> <span class="token string">'containers/ContentTypePage'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> styles <span class="token keyword">from</span> <span class="token string">'./styles.scss'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">class</span> <span class="token class-name">App</span> <span class="token keyword">extends</span> <span class="token class-name">React<span class="token punctuation">.</span>Component</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token function">render</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">return</span> <span class="token punctuation">(</span>
|
||
|
|
<span class="token operator"><</span>div className<span class="token operator">=</span><span class="token punctuation">{</span><span class="token template-string"><span class="token string">`</span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span>pluginId<span class="token interpolation-punctuation punctuation">}</span></span><span class="token string"> </span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span>styles<span class="token punctuation">.</span>app<span class="token interpolation-punctuation punctuation">}</span></span><span class="token string">`</span></span><span class="token punctuation">}</span><span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span>Switch<span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span>Route exact path<span class="token operator">=</span><span class="token string">"/plugins/my-plugin/content-type/:contentTypeName"</span> component<span class="token operator">=</span><span class="token punctuation">{</span>ContentTypePage<span class="token punctuation">}</span> <span class="token operator">/</span><span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span><span class="token operator">/</span>Switch<span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span><span class="token operator">/</span>div<span class="token operator">></span>
|
||
|
|
<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
App<span class="token punctuation">.</span>contextTypes <span class="token operator">=</span> <span class="token punctuation">{</span>
|
||
|
|
router<span class="token punctuation">:</span> PropTypes<span class="token punctuation">.</span>object<span class="token punctuation">.</span>isRequired<span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">}</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">function</span> <span class="token function">mapDispatchToProps</span><span class="token punctuation">(</span>dispatch<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">return</span> <span class="token function">bindActionCreators</span><span class="token punctuation">(</span>
|
||
|
|
<span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||
|
|
dispatch
|
||
|
|
<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token keyword">const</span> mapStateToProps <span class="token operator">=</span> <span class="token function">createStructuredSelector</span><span class="token punctuation">(</span><span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">const</span> withConnect <span class="token operator">=</span> <span class="token function">connect</span><span class="token punctuation">(</span>mapStateToProps<span class="token punctuation">,</span> mapDispatchToProps<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token function">compose</span><span class="token punctuation">(</span>
|
||
|
|
withConnect<span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">)</span><span class="token punctuation">(</span>App<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
</code></pre></div><hr> <h4 id="constants-declaration"><a href="#constants-declaration" aria-hidden="true" class="header-anchor">#</a> Constants declaration:</h4> <p>Let's declare the needed constants to handle fetching data:</p> <p><strong>Path —</strong> <code>./plugins/my-plugin/admin/src/containers/ContentTypePage/constants.js</code>.</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">export</span> <span class="token keyword">const</span> <span class="token constant">DATA_FETCH</span> <span class="token operator">=</span> <span class="token string">'myPlugin/ContentTypePage/DATA_FETCH'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">const</span> <span class="token constant">DATA_FETCH_ERROR</span> <span class="token operator">=</span> <span class="token string">'myPlugin/ContentTypePage/DATA_FETCH_ERROR'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">const</span> <span class="token constant">DATA_FETCH_SUCCEEDED</span> <span class="token operator">=</span> <span class="token string">'myPlugin/ContentTypePage/DATA_FETCH_SUCCEEDED'</span><span class="token punctuation">;</span>
|
||
|
|
</code></pre></div><hr> <h4 id="actions-declaration"><a href="#actions-declaration" aria-hidden="true" class="header-anchor">#</a> Actions declaration:</h4> <p>Let's declare our actions.</p> <p><strong>Path —</strong> <code>./plugins/my-plugin/admin/src/containers/ContentTypePage/actions.js</code>.</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">import</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token constant">DATA_FETCH</span><span class="token punctuation">,</span>
|
||
|
|
<span class="token constant">DATA_FETCH_ERROR</span><span class="token punctuation">,</span>
|
||
|
|
<span class="token constant">DATA_FETCH_SUCCEEDED</span><span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'./constants'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">function</span> <span class="token function">dataFetch</span><span class="token punctuation">(</span>contentTypeName<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">return</span> <span class="token punctuation">{</span>
|
||
|
|
type<span class="token punctuation">:</span> <span class="token constant">DATA_FETCH</span><span class="token punctuation">,</span>
|
||
|
|
contentTypeName<span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">}</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">function</span> <span class="token function">dataFetchError</span><span class="token punctuation">(</span>errorMessage<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">return</span> <span class="token punctuation">{</span>
|
||
|
|
type<span class="token punctuation">:</span> <span class="token constant">DATA_FETCH_ERROR</span><span class="token punctuation">,</span>
|
||
|
|
errorMessage<span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">}</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">function</span> <span class="token function">dataFetchSucceeded</span><span class="token punctuation">(</span>data<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token comment">// data will look like { data: { name: 'User', description: 'Some description' } }</span>
|
||
|
|
<span class="token keyword">return</span> <span class="token punctuation">{</span>
|
||
|
|
type<span class="token punctuation">:</span> <span class="token constant">DATA_FETCH_SUCCEEDED</span><span class="token punctuation">,</span>
|
||
|
|
data<span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">}</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
</code></pre></div><hr> <h4 id="reducer-setup"><a href="#reducer-setup" aria-hidden="true" class="header-anchor">#</a> Reducer setup:</h4> <p>Please refer to the <a href="https://facebook.github.io/immutable-js/docs/#/" target="_blank" rel="noopener noreferrer">Immutable documentation<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> for informations about data structure.</p> <p><strong>Path —</strong> <code>./plugins/my-plugin/admin/src/containers/ContentTypePage/reducer.js</code>.</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">import</span> <span class="token punctuation">{</span> fromJS<span class="token punctuation">,</span> Map <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'immutable'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token constant">DATA_FETCH</span><span class="token punctuation">,</span>
|
||
|
|
<span class="token constant">DATA_FETCH_ERROR</span><span class="token punctuation">,</span>
|
||
|
|
<span class="token constant">DATA_FETCH_SUCCEEDED</span>
|
||
|
|
<span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'./constants'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">const</span> initialState <span class="token operator">=</span> <span class="token function">fromJS</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
|
||
|
|
contentTypeName<span class="token punctuation">,</span>
|
||
|
|
error<span class="token punctuation">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span>
|
||
|
|
errorMessage<span class="token punctuation">:</span> <span class="token string">''</span><span class="token punctuation">,</span>
|
||
|
|
data<span class="token punctuation">:</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">function</span> <span class="token function">contentTypePageReducer</span><span class="token punctuation">(</span>state <span class="token operator">=</span> initialState<span class="token punctuation">,</span> action<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">switch</span> <span class="token punctuation">(</span>action<span class="token punctuation">.</span>type<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">case</span> <span class="token constant">DATA_FETCH</span><span class="token punctuation">:</span>
|
||
|
|
<span class="token keyword">return</span> state<span class="token punctuation">.</span><span class="token keyword">set</span><span class="token punctuation">(</span><span class="token string">'contentTypeName'</span><span class="token punctuation">,</span> action<span class="token punctuation">.</span>contentTypeName<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">case</span> <span class="token constant">DATA_FETCH_ERROR</span><span class="token punctuation">:</span>
|
||
|
|
<span class="token keyword">return</span> state
|
||
|
|
<span class="token punctuation">.</span><span class="token keyword">set</span><span class="token punctuation">(</span><span class="token string">'error'</span><span class="token punctuation">,</span> <span class="token boolean">true</span><span class="token punctuation">)</span>
|
||
|
|
<span class="token punctuation">.</span><span class="token keyword">set</span><span class="token punctuation">(</span><span class="token string">'errorMessage'</span><span class="token punctuation">,</span> action<span class="token punctuation">.</span>errorMessage<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">case</span> <span class="token constant">DATA_FETCH_SUCCEEDED</span><span class="token punctuation">:</span>
|
||
|
|
<span class="token keyword">return</span> state
|
||
|
|
<span class="token punctuation">.</span><span class="token keyword">set</span><span class="token punctuation">(</span><span class="token string">'error'</span><span class="token punctuation">,</span> <span class="token boolean">false</span><span class="token punctuation">)</span>
|
||
|
|
<span class="token punctuation">.</span><span class="token keyword">set</span><span class="token punctuation">(</span><span class="token string">'data'</span><span class="token punctuation">,</span> <span class="token function">Map</span><span class="token punctuation">(</span>action<span class="token punctuation">.</span>data<span class="token punctuation">.</span>data<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">default</span><span class="token punctuation">:</span>
|
||
|
|
<span class="token keyword">return</span> state<span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">default</span> contentTypePageReducer<span class="token punctuation">;</span>
|
||
|
|
</code></pre></div><hr> <h4 id="selectors-setup"><a href="#selectors-setup" aria-hidden="true" class="header-anchor">#</a> Selectors setup:</h4> <p><strong>Path —</strong> <code>./plugins/my-plugin/admin/src/containers/ContentTypePage/selectors.js</code>.</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">import</span> <span class="token punctuation">{</span> createSelector <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'reselect'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token comment">/**
|
||
|
|
* Direct selector to the contentTypePage state domain
|
||
|
|
*/</span>
|
||
|
|
<span class="token keyword">const</span> <span class="token function-variable function">selectContentTypePageDomain</span> <span class="token operator">=</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=></span> state <span class="token operator">=></span> state<span class="token punctuation">.</span><span class="token keyword">get</span><span class="token punctuation">(</span><span class="token string">'contentTypePage'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token comment">/**
|
||
|
|
* Other specific selectors
|
||
|
|
*/</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class="token comment">/**
|
||
|
|
* Default selector used by ContentTypePage
|
||
|
|
*/</span>
|
||
|
|
|
||
|
|
<span class="token keyword">const</span> <span class="token function-variable function">selectContentTypePage</span> <span class="token operator">=</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token function">createSelector</span><span class="token punctuation">(</span>
|
||
|
|
<span class="token function">selectContentTypePageDomain</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">(</span>substate<span class="token punctuation">)</span> <span class="token operator">=></span> substate<span class="token punctuation">.</span><span class="token function">toJS</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
|
|
<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">const</span> <span class="token function-variable function">makeSelectContentTypeName</span> <span class="token operator">=</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token function">createSelector</span><span class="token punctuation">(</span>
|
||
|
|
<span class="token function">selectContentTypePageDomain</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">(</span>substate<span class="token punctuation">)</span> <span class="token operator">=></span> substate<span class="token punctuation">.</span><span class="token keyword">get</span><span class="token punctuation">(</span><span class="token string">'contentTypeName'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">)</span>
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">default</span> selectContentTypePage<span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">export</span> <span class="token punctuation">{</span> makeSelectContentTypeName<span class="token punctuation">,</span> selectContentTypePageDomain <span class="token punctuation">}</span><span class="token punctuation">;</span>
|
||
|
|
</code></pre></div><hr> <h4 id="handling-route-change"><a href="#handling-route-change" aria-hidden="true" class="header-anchor">#</a> Handling route change:</h4> <p><strong>Path —</strong> <code>./plugins/my-plugin/admin/src/containers/ContentTypePage/index.js</code>.</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">import</span> React <span class="token keyword">from</span> <span class="token string">'react'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> connect <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'react-redux'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> createStructuredSelector <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'reselect'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> bindActionCreators<span class="token punctuation">,</span> compose <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'redux'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> NavLink <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'react-router-dom'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> PropTypes <span class="token keyword">from</span> <span class="token string">'prop-types'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> map <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'lodash'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token comment">// Utils to create the container's store</span>
|
||
|
|
<span class="token keyword">import</span> injectSaga <span class="token keyword">from</span> <span class="token string">'utils/injectSaga'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> injectReducer <span class="token keyword">from</span> <span class="token string">'utils/injectReducer'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> dataFetch <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'./actions'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> selectContentTypePage <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'./selectors'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> saga <span class="token keyword">from</span> <span class="token string">'./sagas'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> reducer <span class="token keyword">from</span> <span class="token string">'./reducer'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> styles <span class="token keyword">from</span> <span class="token string">'./styles.scss'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">class</span> <span class="token class-name">ContentTypePage</span> <span class="token keyword">extends</span> <span class="token class-name">React<span class="token punctuation">.</span>Component</span> <span class="token punctuation">{</span> <span class="token comment">// eslint-disable-line react/prefer-stateless-function</span>
|
||
|
|
<span class="token function">constructor</span><span class="token punctuation">(</span>props<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">super</span><span class="token punctuation">(</span>props<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">this</span><span class="token punctuation">.</span>links <span class="token operator">=</span> <span class="token punctuation">[</span>
|
||
|
|
<span class="token punctuation">{</span>
|
||
|
|
to<span class="token punctuation">:</span> <span class="token string">'plugin/my-plugin/content-type/product'</span><span class="token punctuation">,</span>
|
||
|
|
info<span class="token punctuation">:</span> <span class="token string">'Product'</span><span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">{</span>
|
||
|
|
to<span class="token punctuation">:</span> <span class="token string">'plugin/my-plugin/content-type/user'</span><span class="token punctuation">,</span>
|
||
|
|
info<span class="token punctuation">:</span> <span class="token string">'User'</span><span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">]</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token function">componentDidMount</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">this</span><span class="token punctuation">.</span>props<span class="token punctuation">.</span><span class="token function">dataFetch</span><span class="token punctuation">(</span><span class="token keyword">this</span><span class="token punctuation">.</span>props<span class="token punctuation">.</span>match<span class="token punctuation">.</span>params<span class="token punctuation">.</span>contentTypeName<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token function">componentWillReceiveProps</span><span class="token punctuation">(</span>nextProps<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">if</span> <span class="token punctuation">(</span>nextProps<span class="token punctuation">.</span>match<span class="token punctuation">.</span>params<span class="token punctuation">.</span>contentTypeName <span class="token operator">!==</span> <span class="token keyword">this</span><span class="token punctuation">.</span>props<span class="token punctuation">.</span>match<span class="token punctuation">.</span>params<span class="token punctuation">.</span>contentTypeName<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">this</span><span class="token punctuation">.</span>props<span class="token punctuation">.</span><span class="token function">dataFetch</span><span class="token punctuation">(</span>nextProps<span class="token punctuation">.</span>match<span class="token punctuation">.</span>params<span class="token punctuation">.</span>contentTypeName<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token function">render</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">return</span> <span class="token punctuation">(</span>
|
||
|
|
<span class="token operator"><</span>div className<span class="token operator">=</span><span class="token punctuation">{</span>styles<span class="token punctuation">.</span>contentTypePage<span class="token punctuation">}</span><span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span>div<span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span>ul<span class="token operator">></span>
|
||
|
|
<span class="token punctuation">{</span><span class="token function">map</span><span class="token punctuation">(</span><span class="token keyword">this</span><span class="token punctuation">.</span>links<span class="token punctuation">,</span> <span class="token punctuation">(</span>link<span class="token punctuation">,</span> key<span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">(</span>
|
||
|
|
<span class="token operator"><</span>li key<span class="token operator">=</span><span class="token punctuation">{</span>key<span class="token punctuation">}</span><span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span>NavLink to<span class="token operator">=</span><span class="token punctuation">{</span>link<span class="token punctuation">.</span>to<span class="token punctuation">}</span><span class="token operator">></span><span class="token punctuation">{</span>link<span class="token punctuation">.</span>info<span class="token punctuation">}</span><span class="token operator"><</span><span class="token operator">/</span>NavLink<span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span><span class="token operator">/</span>li<span class="token operator">></span>
|
||
|
|
<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">}</span>
|
||
|
|
<span class="token operator"><</span><span class="token operator">/</span>ul<span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span><span class="token operator">/</span>div<span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span>div<span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span>h1<span class="token operator">></span><span class="token punctuation">{</span><span class="token keyword">this</span><span class="token punctuation">.</span>props<span class="token punctuation">.</span>data<span class="token punctuation">.</span>name<span class="token punctuation">}</span><span class="token operator"><</span><span class="token operator">/</span>h1<span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span>p<span class="token operator">></span><span class="token punctuation">{</span><span class="token keyword">this</span><span class="token punctuation">.</span>props<span class="token punctuation">.</span>data<span class="token punctuation">.</span>description<span class="token punctuation">}</span><span class="token operator"><</span><span class="token operator">/</span>p<span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span><span class="token operator">/</span>div<span class="token operator">></span>
|
||
|
|
<span class="token operator"><</span><span class="token operator">/</span>div<span class="token operator">></span>
|
||
|
|
<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token keyword">const</span> mapStateToProps <span class="token operator">=</span> <span class="token function">selectContentTypePage</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">function</span> <span class="token function">mapDispatchToProps</span><span class="token punctuation">(</span>dispatch<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">return</span> <span class="token function">bindActionCreators</span><span class="token punctuation">(</span>
|
||
|
|
<span class="token punctuation">{</span>
|
||
|
|
dataFetch<span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||
|
|
dispatch<span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
ContentTypePage<span class="token punctuation">.</span>propTypes <span class="token operator">=</span> <span class="token punctuation">{</span>
|
||
|
|
data<span class="token punctuation">:</span> PropTypes<span class="token punctuation">.</span>object<span class="token punctuation">.</span>isRequired<span class="token punctuation">,</span>
|
||
|
|
dataFetch<span class="token punctuation">:</span> PropTypes<span class="token punctuation">.</span>func<span class="token punctuation">.</span>isRequired<span class="token punctuation">,</span>
|
||
|
|
match<span class="token punctuation">:</span> PropTypes<span class="token punctuation">.</span>object<span class="token punctuation">.</span>isRequired<span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">}</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">const</span> withConnect <span class="token operator">=</span> <span class="token function">connect</span><span class="token punctuation">(</span>mapStateToProps<span class="token punctuation">,</span> mapDispatchToProps<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">const</span> withSaga <span class="token operator">=</span> <span class="token function">injectSaga</span><span class="token punctuation">(</span><span class="token punctuation">{</span> key<span class="token punctuation">:</span> <span class="token string">'contentTypePage'</span><span class="token punctuation">,</span> saga <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">const</span> withReducer <span class="token operator">=</span> <span class="token function">injectReducer</span><span class="token punctuation">(</span><span class="token punctuation">{</span> key<span class="token punctuation">:</span> <span class="token string">'contentTypePage'</span><span class="token punctuation">,</span> reducer <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token function">compose</span><span class="token punctuation">(</span>
|
||
|
|
withReducer<span class="token punctuation">,</span>
|
||
|
|
withSaga<span class="token punctuation">,</span>
|
||
|
|
withConnect<span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">)</span><span class="token punctuation">(</span>ContentTypePage<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
</code></pre></div><hr> <h4 id="fetching-data"><a href="#fetching-data" aria-hidden="true" class="header-anchor">#</a> Fetching data:</h4> <p>The <code>sagas.js</code> file is in charge of fetching data.</p> <p><strong>Path —</strong> <code>./plugins/my-plugin/admin/src/containers/ContentTypePage/sagas.js</code>.</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">import</span> <span class="token punctuation">{</span> <span class="token constant">LOCATION_CHANGE</span> <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'react-router-redux'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> takeLatest<span class="token punctuation">,</span> call<span class="token punctuation">,</span> take<span class="token punctuation">,</span> put<span class="token punctuation">,</span> fork<span class="token punctuation">,</span> cancel<span class="token punctuation">,</span> select <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'redux-saga/effects'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> request <span class="token keyword">from</span> <span class="token string">'utils/request'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span>
|
||
|
|
dataFetchError<span class="token punctuation">,</span>
|
||
|
|
dataFetchSucceeded<span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'./actions'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> <span class="token constant">DATA_FETCH</span> <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'./constants'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> makeSelectContentTypeName <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'./selectors'</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">function</span><span class="token operator">*</span> <span class="token function">fetchData</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">try</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">const</span> opts <span class="token operator">=</span> <span class="token punctuation">{</span> method<span class="token punctuation">:</span> <span class="token string">'GET'</span> <span class="token punctuation">}</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token comment">// To make a POST request { method: 'POST', body: {Object} }</span>
|
||
|
|
|
||
|
|
<span class="token keyword">const</span> endPoint <span class="token operator">=</span> <span class="token keyword">yield</span> <span class="token function">select</span><span class="token punctuation">(</span><span class="token function">makeSelectContentTypeName</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">const</span> requestUrl <span class="token operator">=</span> <span class="token template-string"><span class="token string">`my-plugin/**/</span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span>endPoint<span class="token interpolation-punctuation punctuation">}</span></span><span class="token string">`</span></span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token comment">// Fetching data with our request helper</span>
|
||
|
|
<span class="token keyword">const</span> data <span class="token operator">=</span> <span class="token keyword">yield</span> <span class="token function">call</span><span class="token punctuation">(</span>request<span class="token punctuation">,</span> requestUrl<span class="token punctuation">,</span> opts<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">yield</span> <span class="token function">put</span><span class="token punctuation">(</span><span class="token function">dataFetchSucceeded</span><span class="token punctuation">(</span>data<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span> <span class="token keyword">catch</span><span class="token punctuation">(</span>error<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">yield</span> <span class="token function">put</span><span class="token punctuation">(</span><span class="token function">dataFetchError</span><span class="token punctuation">(</span>error<span class="token punctuation">.</span>message<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token keyword">function</span><span class="token operator">*</span> <span class="token function">defaultSaga</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">const</span> loadDataWatcher <span class="token operator">=</span> <span class="token keyword">yield</span> <span class="token function">fork</span><span class="token punctuation">(</span>takeLatest<span class="token punctuation">,</span> <span class="token constant">DATA_FETCH</span><span class="token punctuation">,</span> fetchData<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">yield</span> <span class="token function">take</span><span class="token punctuation">(</span><span class="token constant">LOCATION_CHANGE</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">yield</span> <span class="token function">cancel</span><span class="token punctuation">(</span>loadDataWatcher<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">default</span> defaultSaga<span class="token punctuation">;</span>
|
||
|
|
</code></pre></div><hr> <h3 id="example-with-server-autoreload-watcher"><a href="#example-with-server-autoreload-watcher" aria-hidden="true" class="header-anchor">#</a> Example with server autoReload watcher</h3> <p>Let's say that you want to develop a plugin that needs server restart on file change (like the settings-manager plugin) and you want to be aware of that to display some stuff..., you just have to send a third argument: <code>true</code> to our request helper and it will ping a dedicated route and send the response when the server has restarted.</p> <p><strong>Path —</strong> <code>./plugins/my-plugin/admin/src/containers/**/sagas.js</code>.</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">import</span> <span class="token punctuation">{</span> takeLatest<span class="token punctuation">,</span> call<span class="token punctuation">,</span> take<span class="token punctuation">,</span> put<span class="token punctuation">,</span> fork<span class="token punctuation">,</span> cancel<span class="token punctuation">,</span> select <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'redux-saga/effects'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> request <span class="token keyword">from</span> <span class="token string">'utils/request'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span>
|
||
|
|
submitSucceeded<span class="token punctuation">,</span>
|
||
|
|
submitError<span class="token punctuation">,</span>
|
||
|
|
<span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'./actions'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">import</span> <span class="token punctuation">{</span> <span class="token constant">SUBMIT</span> <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'./constants'</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token comment">// Other useful imports like selectors...</span>
|
||
|
|
<span class="token comment">// ...</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">function</span><span class="token operator">*</span> <span class="token function">postData</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">try</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">const</span> body <span class="token operator">=</span> <span class="token punctuation">{</span> data<span class="token punctuation">:</span> <span class="token string">'someData'</span> <span class="token punctuation">}</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">const</span> opts <span class="token operator">=</span> <span class="token punctuation">{</span> method<span class="token punctuation">:</span> <span class="token string">'POST'</span><span class="token punctuation">,</span> body <span class="token punctuation">}</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token keyword">const</span> requestUrl <span class="token operator">=</span> <span class="token template-string"><span class="token string">`**yourUrl**`</span></span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">const</span> response <span class="token operator">=</span> <span class="token keyword">yield</span> <span class="token function">call</span><span class="token punctuation">(</span>request<span class="token punctuation">,</span> requestUrl<span class="token punctuation">,</span> opts<span class="token punctuation">,</span> <span class="token boolean">true</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
|
||
|
|
<span class="token keyword">if</span> <span class="token punctuation">(</span>response<span class="token punctuation">.</span>ok<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">yield</span> <span class="token function">put</span><span class="token punctuation">(</span><span class="token function">submitSucceeded</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span> <span class="token keyword">else</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">yield</span> <span class="token function">put</span><span class="token punctuation">(</span><span class="token function">submitError</span><span class="token punctuation">(</span><span class="token string">'An error occurred'</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
<span class="token punctuation">}</span> <span class="token keyword">catch</span><span class="token punctuation">(</span>error<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">yield</span> <span class="token function">put</span><span class="token punctuation">(</span><span class="token function">submitError</span><span class="token punctuation">(</span>error<span class="token punctuation">.</span>message<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token keyword">function</span><span class="token operator">*</span> <span class="token function">defaultSaga</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||
|
|
<span class="token keyword">yield</span> <span class="token function">fork</span><span class="token punctuation">(</span>takeLatest<span class="token punctuation">,</span> <span class="token constant">SUBMIT</span><span class="token punctuation">,</span> postData<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
|
<span class="token comment">// ...</span>
|
||
|
|
<span class="token punctuation">}</span>
|
||
|
|
|
||
|
|
<span class="token keyword">export</span> <span class="token keyword">default</span> defaultSaga<span class="token punctuation">;</span>
|
||
|
|
</code></pre></div></div> <div class="page-edit"><div class="edit-link"><a href="https://github.com/strapi/strapi/edit/master/docs/3.x.x/plugin-development/utils.md" target="_blank" rel="noopener noreferrer">Improve this page</a> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></div> <!----></div> <!----> </div></div></div>
|
||
|
|
<script src="/documentation/assets/js/69.3f4ed952.js" defer></script><script src="/documentation/assets/js/app.a8210063.js" defer></script>
|
||
|
|
</body>
|
||
|
|
</html>
|