Files
docs/react-openapi/wiki/03_admin_ui/index.html

804 lines
30 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../02_spec_extensions/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
<title>Admin UI - react-openapi</title>
<link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"JetBrains Mono"}</style>
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="blue-grey" data-md-color-accent="teal">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#admin-ui" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="react-openapi" class="md-header__button md-logo" aria-label="react-openapi" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 4v18h16v2H4c-1.1 0-2-.9-2-2V4zm11 3h5.5L15 1.5zM8 0h8l6 6v12c0 1.11-.89 2-2 2H8a2 2 0 0 1-2-2V2c0-1.11.89-2 2-2m9 16v-2H8v2zm3-4v-2H8v2z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
react-openapi
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Admin UI
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../01_overview/" class="md-tabs__link">
Overview
</a>
</li>
<li class="md-tabs__item">
<a href="../02_spec_extensions/" class="md-tabs__link">
Spec Extensions
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Admin UI
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="react-openapi" class="md-nav__button md-logo" aria-label="react-openapi" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 4v18h16v2H4c-1.1 0-2-.9-2-2V4zm11 3h5.5L15 1.5zM8 0h8l6 6v12c0 1.11-.89 2-2 2H8a2 2 0 0 1-2-2V2c0-1.11.89-2 2-2m9 16v-2H8v2zm3-4v-2H8v2z"/></svg>
</a>
react-openapi
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../01_overview/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../02_spec_extensions/" class="md-nav__link">
<span class="md-ellipsis">
Spec Extensions
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Admin UI
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Admin UI
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#components" class="md-nav__link">
<span class="md-ellipsis">
📦 Components
</span>
</a>
<nav class="md-nav" aria-label="📦 Components">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#field-renderer-dispatch" class="md-nav__link">
<span class="md-ellipsis">
Field renderer dispatch
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#hooks" class="md-nav__link">
<span class="md-ellipsis">
📦 Hooks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#three-ways-to-customise" class="md-nav__link">
<span class="md-ellipsis">
📦 Three ways to customise
</span>
</a>
<nav class="md-nav" aria-label="📦 Three ways to customise">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-per-resource-behaviour-specconfigurationresourceconfig" class="md-nav__link">
<span class="md-ellipsis">
1. Per-resource behaviour — specConfiguration.resourceConfig
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-profile-screens-specconfigurationprofilecomponents" class="md-nav__link">
<span class="md-ellipsis">
2. Profile screens — specConfiguration.profileComponents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-your-own-screens-hooks" class="md-nav__link">
<span class="md-ellipsis">
3. Your own screens — hooks
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#streaming" class="md-nav__link">
<span class="md-ellipsis">
📡 Streaming
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#auth" class="md-nav__link">
<span class="md-ellipsis">
🔐 Auth
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#related" class="md-nav__link">
<span class="md-ellipsis">
Related
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="admin-ui">Admin UI</h1>
<p>Everything on screen comes from the loaded spec. This page lists the pieces
you compose with, and the three ways to override the generated behaviour.</p>
<hr />
<h2 id="components">📦 Components</h2>
<table>
<thead>
<tr>
<th>Export</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>AppProvider</code></td>
<td>Loads and validates the spec, builds resource configs, initialises the axios client, provides context. Wrap the app with it.</td>
</tr>
<tr>
<td><code>Admin</code></td>
<td>Sidebar + nested routes for every resource. Takes <code>basePath</code>.</td>
</tr>
<tr>
<td><code>ProfileRoutes</code></td>
<td>Routes for <code>x-profile</code> view/edit/create operations.</td>
</tr>
<tr>
<td><code>ListCellRenderer</code></td>
<td>One list/table cell; honours FK display formats, inline refs, enums, booleans.</td>
</tr>
<tr>
<td><code>DetailFieldRenderer</code></td>
<td>Read-only label + value pair in the detail view.</td>
</tr>
<tr>
<td><code>FormFieldRenderer</code></td>
<td>Editable form field; dispatches to the concrete control.</td>
</tr>
<tr>
<td><code>FilterBar</code> / <code>SideMenu</code> / <code>Layout</code></td>
<td>Layout primitives used by <code>Admin</code>.</td>
</tr>
<tr>
<td><code>ValidationAlert</code></td>
<td>Spec validation errors/warnings surface.</td>
</tr>
<tr>
<td><code>SseStreamView</code></td>
<td>Live stream card: status, event counter, latest event, snackbar.</td>
</tr>
<tr>
<td><code>SseConnectionStatus</code></td>
<td>Green/red dot with Connected/Disconnected — reactive everywhere.</td>
</tr>
<tr>
<td><code>MultiEnumField</code>, <code>CurrencyField</code>, <code>FkMultiSelectField</code></td>
<td>Exported controls you can reuse in custom screens.</td>
</tr>
</tbody>
</table>
<h3 id="field-renderer-dispatch">Field renderer dispatch</h3>
<table>
<thead>
<tr>
<th>Condition</th>
<th>Form control</th>
<th>List / detail</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>x-fk</code>, not an array</td>
<td><code>FkSelectField</code></td>
<td>display-format cell</td>
</tr>
<tr>
<td><code>x-fk</code>, <code>type: array</code></td>
<td><code>FkMultiSelectField</code></td>
<td>chips</td>
</tr>
<tr>
<td><code>enum</code></td>
<td><code>EnumField</code></td>
<td>chip</td>
</tr>
<tr>
<td><code>type: boolean</code></td>
<td><code>BooleanField</code> (switch)</td>
<td>Yes/No chip</td>
</tr>
<tr>
<td><code>type: integer</code> / <code>number</code></td>
<td><code>NumberField</code></td>
<td>typography</td>
</tr>
<tr>
<td><code>format: date</code> / <code>date-time</code></td>
<td><code>DateField</code></td>
<td>typography</td>
</tr>
<tr>
<td><code>x-ui-type: image</code> / <code>x-upload</code></td>
<td>upload control</td>
<td>avatar / chip</td>
</tr>
<tr>
<td><code>$ref</code> without <code>x-fk</code></td>
<td>disabled JSON field</td>
<td><code>InlineRefField</code> chips</td>
</tr>
<tr>
<td>otherwise</td>
<td><code>StringField</code></td>
<td>typography</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="hooks">📦 Hooks</h2>
<div class="language-tsx highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span>
<span class="normal"><a href="#__codelineno-0-2">2</a></span>
<span class="normal"><a href="#__codelineno-0-3">3</a></span>
<span class="normal"><a href="#__codelineno-0-4">4</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="kd">const</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">config</span><span class="p">,</span><span class="w"> </span><span class="nx">resources</span><span class="p">,</span><span class="w"> </span><span class="nx">schemas</span><span class="p">,</span><span class="w"> </span><span class="nx">loading</span><span class="p">,</span><span class="w"> </span><span class="nx">errors</span><span class="p">,</span><span class="w"> </span><span class="nx">warnings</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">useAppContext</span><span class="p">();</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a><span class="kd">const</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">resource</span><span class="p">,</span><span class="w"> </span><span class="nx">components</span><span class="p">,</span><span class="w"> </span><span class="nx">list</span><span class="p">,</span><span class="w"> </span><span class="nx">get</span><span class="p">,</span><span class="w"> </span><span class="nx">create</span><span class="p">,</span><span class="w"> </span><span class="nx">update</span><span class="p">,</span><span class="w"> </span><span class="nx">remove</span><span class="p">,</span><span class="w"> </span><span class="nx">stream</span><span class="p">,</span><span class="w"> </span><span class="nx">loading</span><span class="p">,</span><span class="w"> </span><span class="nx">error</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="o">=</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a><span class="w"> </span><span class="nx">useResource</span><span class="p">(</span><span class="s2">&quot;pets&quot;</span><span class="p">);</span>
</span></code></pre></div></td></tr></table></div>
<ul>
<li><code>useAppContext()</code> — the whole derived model.</li>
<li><code>useResource(name)</code> — CRUD + optional <code>stream(handlers, pathParams?) →
{ close }</code> for <code>x-sse</code> resources; <code>components</code> holds the per-resource
filter widgets.</li>
<li><code>useItemSse(url, handlers)</code> — subscribe to one item's event stream.</li>
<li><code>useFkFieldOptions(...)</code> / <code>getApi()</code> — FK options and the configured
axios instance for custom calls.</li>
<li><code>sanitizePayload(payload, resolver)</code> — strips/normalises fields before
create/update.</li>
</ul>
<hr />
<h2 id="three-ways-to-customise">📦 Three ways to customise</h2>
<h3 id="1-per-resource-behaviour-specconfigurationresourceconfig">1. Per-resource behaviour — <code>specConfiguration.resourceConfig</code></h3>
<div class="language-tsx highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-1-1">1</a></span>
<span class="normal"><a href="#__codelineno-1-2">2</a></span>
<span class="normal"><a href="#__codelineno-1-3">3</a></span>
<span class="normal"><a href="#__codelineno-1-4">4</a></span>
<span class="normal"><a href="#__codelineno-1-5">5</a></span>
<span class="normal"><a href="#__codelineno-1-6">6</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1"></a><span class="p">&lt;</span><span class="nt">AppProvider</span><span class="w"> </span><span class="na">specConfiguration</span><span class="o">=</span><span class="p">{{</span>
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2"></a><span class="w"> </span><span class="nx">specUrl</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;/api/openapi.yaml&quot;</span><span class="p">,</span>
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3"></a><span class="w"> </span><span class="nx">resourceConfig</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4"></a><span class="w"> </span><span class="nx">invoices</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">filterOptions</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">mode</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;sidebar&quot;</span><span class="w"> </span><span class="p">},</span><span class="w"> </span><span class="nx">fieldTypes</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">amount</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;currency&quot;</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">},</span>
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5"></a><span class="w"> </span><span class="p">},</span>
</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6"></a><span class="p">}}</span><span class="w"> </span><span class="p">/&gt;</span>
</span></code></pre></div></td></tr></table></div>
<h3 id="2-profile-screens-specconfigurationprofilecomponents">2. Profile screens — <code>specConfiguration.profileComponents</code></h3>
<div class="language-tsx highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-2-1">1</a></span>
<span class="normal"><a href="#__codelineno-2-2">2</a></span>
<span class="normal"><a href="#__codelineno-2-3">3</a></span>
<span class="normal"><a href="#__codelineno-2-4">4</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1"></a><span class="p">&lt;</span><span class="nt">AppProvider</span><span class="w"> </span><span class="na">specConfiguration</span><span class="o">=</span><span class="p">{{</span>
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2"></a><span class="w"> </span><span class="nx">specUrl</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;/api/openapi.yaml&quot;</span><span class="p">,</span>
</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3"></a><span class="w"> </span><span class="nx">profileComponents</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">view</span><span class="o">:</span><span class="w"> </span><span class="kt">ProfileView</span><span class="p">,</span><span class="w"> </span><span class="nx">edit</span><span class="o">:</span><span class="w"> </span><span class="kt">ProfileEdit</span><span class="p">,</span><span class="w"> </span><span class="nx">create</span><span class="o">:</span><span class="w"> </span><span class="kt">ProfileCreate</span><span class="w"> </span><span class="p">},</span>
</span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4"></a><span class="p">}}</span><span class="w"> </span><span class="p">/&gt;</span>
</span></code></pre></div></td></tr></table></div>
<h3 id="3-your-own-screens-hooks">3. Your own screens — hooks</h3>
<div class="language-tsx highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-3-1">1</a></span>
<span class="normal"><a href="#__codelineno-3-2">2</a></span>
<span class="normal"><a href="#__codelineno-3-3">3</a></span>
<span class="normal"><a href="#__codelineno-3-4">4</a></span>
<span class="normal"><a href="#__codelineno-3-5">5</a></span>
<span class="normal"><a href="#__codelineno-3-6">6</a></span>
<span class="normal"><a href="#__codelineno-3-7">7</a></span>
<span class="normal"><a href="#__codelineno-3-8">8</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1"></a><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">useAppContext</span><span class="p">,</span><span class="w"> </span><span class="nx">SseStreamView</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s2">&quot;react-openapi&quot;</span><span class="p">;</span>
</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2"></a>
</span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3"></a><span class="kd">function</span><span class="w"> </span><span class="nx">MyStreamPage</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
</span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">resources</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">useAppContext</span><span class="p">();</span>
</span><span id="__span-3-5"><a id="__codelineno-3-5" name="__codelineno-3-5"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">res</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">resources</span><span class="p">.</span><span class="nx">find</span><span class="p">((</span><span class="nx">r</span><span class="p">)</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="nx">r</span><span class="p">.</span><span class="nx">name</span><span class="w"> </span><span class="o">===</span><span class="w"> </span><span class="s2">&quot;calls&quot;</span><span class="p">);</span>
</span><span id="__span-3-6"><a id="__codelineno-3-6" name="__codelineno-3-6"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="nx">res</span><span class="p">)</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="kc">null</span><span class="p">;</span>
</span><span id="__span-3-7"><a id="__codelineno-3-7" name="__codelineno-3-7"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="p">&lt;</span><span class="nt">SseStreamView</span><span class="w"> </span><span class="na">resource</span><span class="o">=</span><span class="p">{</span><span class="nx">res</span><span class="p">}</span><span class="w"> </span><span class="p">/&gt;;</span>
</span><span id="__span-3-8"><a id="__codelineno-3-8" name="__codelineno-3-8"></a><span class="p">}</span>
</span></code></pre></div></td></tr></table></div>
<hr />
<h2 id="streaming">📡 Streaming</h2>
<p><code>useResource("calls").stream({ onEvent, onError, onOpen })</code> returns a
subscription with <code>close()</code>. Reconnection is browser-native; components read
connection state from <code>SseConnectionStatus</code>.</p>
<hr />
<h2 id="auth">🔐 Auth</h2>
<p><code>getToken</code> is called per request and injected as <code>Authorization: Bearer</code>.
Auth endpoints are derived from the spec's <code>securitySchemes.bearerAuth</code>
extensions (see <a href="../02_spec_extensions/#security-auth">Spec Extensions</a>).</p>
<div class="admonition tip">
<p class="admonition-title">Combine with react-auth</p>
<p><code>react-auth</code> owns the login/register UI and the session;
<code>react-openapi</code> only needs a token. Feed <code>getToken: tokenStore.get</code> into
<code>specConfiguration</code> to share one session between the two.</p>
</div>
<hr />
<h2 id="related">Related</h2>
<ul>
<li><a href="../01_overview/">01 – Overview</a> · <a href="../02_spec_extensions/">02 – Spec Extensions</a></li>
</ul>
</article>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest", "navigation.tabs", "toc.integrate", "header.autohide", "content.code.select", "content.code.line_numbers", "content.tooltips"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>
</html>