File size: 18,490 Bytes
9375fc1 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FetchView | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.FetchView.html">FetchView</a></li></ul><h1>Function FetchView</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>FetchView is a React component that provides a convenient way to handle asynchronous data fetching and rendering.</p>
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="fetchview" class="tsd-anchor"></a><span class="tsd-kind-call-signature">FetchView</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewp">P</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewa">A</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewb">B</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewc">C</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewd">D</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewe">E</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewf">F</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewg">G</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewh">H</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewi">I</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewj">J</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.react-declarative_components.IFetchViewProps.html" class="tsd-signature-type tsd-kind-type-alias">IFetchViewProps</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewp">P</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewa">A</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewb">B</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewc">C</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewd">D</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewe">E</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewf">F</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewg">G</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewh">H</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewi">I</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewj">J</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Element</span><a href="#fetchview" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="fetchviewp" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">P</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">unknown</span> = <span class="tsd-signature-type">object</span></span><div class="tsd-comment tsd-typography"><p>The type of the payload for the data fetching.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="fetchviewa" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">A</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of the first element in the array of data returned by the state function.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="fetchviewb" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">B</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of the second element in the array of data returned by the state function.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="fetchviewc" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">C</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of the third element in the array of data returned by the state function.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="fetchviewd" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of the fourth element in the array of data returned by the state function.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="fetchviewe" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">E</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of the fifth element in the array of data returned by the state function.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="fetchviewf" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">F</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of the sixth element in the array of data returned by the state function.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="fetchviewg" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">G</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of the seventh element in the array of data returned by the state function.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="fetchviewh" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">H</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of the eighth element in the array of data returned by the state function.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="fetchviewi" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">I</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of the ninth element in the array of data returned by the state function.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="fetchviewj" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">J</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of the tenth element in the array of data returned by the state function.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <a href="../types/types.react-declarative_components.IFetchViewProps.html" class="tsd-signature-type tsd-kind-type-alias">IFetchViewProps</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewp">P</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewa">A</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewb">B</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewc">C</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewd">D</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewe">E</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewf">F</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewg">G</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewh">H</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewi">I</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.FetchView.html#fetchviewj">J</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The props object containing the following properties:</p>
<ul>
<li>animation: The animation type for the component.</li>
<li>className: The CSS class name(s) for the component.</li>
<li>style: The inline style object for the component.</li>
<li>Loader: The component to render while data is being fetched.</li>
<li>Error: The component to render if an error occurs during data fetching.</li>
<li>onLoadEnd: A callback function to be called when data loading ends.</li>
<li>onLoadStart: A callback function to be called when data loading starts.</li>
<li>children: A function that receives the fetched data as arguments and returns the JSX to be rendered.</li>
<li>state: The function to transform the payload into an array of data.</li>
<li>payload: The payload for the data fetching.</li>
<li>otherProps: Any additional props to be passed to the underlying components.</li>
</ul>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4><ul>
<li>The rendered JSX for the FetchView component.</li>
</ul>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25708">types.d.ts:25708</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|