mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed be4e1aa15 to master with MkDocs 1.1.2 and mike 0.5.5
This commit is contained in:
1 parent
f78e28b146
commit
1b249ad6ce
200 files changed
+16068
-8475
No files matched your search
@@ -856,15 +856,15 @@
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#optional-exact" class="md-nav__link">
|
||||
Optional exact
|
||||
<a href="#optional-id" class="md-nav__link">
|
||||
Optional id
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#optional-id" class="md-nav__link">
|
||||
Optional id
|
||||
<a href="#optional-params" class="md-nav__link">
|
||||
Optional params
|
||||
</a>
|
||||
|
||||
</li>
|
||||
@@ -897,33 +897,23 @@
|
||||
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#components">components</a></li>
|
||||
<li><a href="./#optional-exact">exact</a></li>
|
||||
<li><a href="./#optional-id">id</a></li>
|
||||
<li><a href="./#optional-params">params</a></li>
|
||||
</ul>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="components">components<a class="headerlink" href="#components" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>components</strong>: <em><a href="../_interfaces_index_.pagecomponents/">PageComponents</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/11c611dab/src/extensions/registries/page-registry.ts#L31">src/extensions/registries/page-registry.ts:31</a></em></p>
|
||||
<hr />
|
||||
<h3 id="optional-exact"><code>Optional</code> exact<a class="headerlink" href="#optional-exact" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>exact</strong>? : <em>boolean</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/11c611dab/src/extensions/registries/page-registry.ts#L30">src/extensions/registries/page-registry.ts:30</a></em></p>
|
||||
<p>Strict route matching to provided page-id, read also: https://reactrouter.com/web/api/NavLink/exact-bool
|
||||
In case when more than one page registered at same extension "pageId" is required to identify different pages,
|
||||
It might be useful to provide <code>exact: true</code> in some cases to avoid overlapping routes.
|
||||
Without {exact:true} second page never matches since first page-id/route already includes partial route.</p>
|
||||
<p><strong><code>example</code></strong> const pages = [
|
||||
{id: "/users", exact: true},
|
||||
{id: "/users/:userId?"}
|
||||
]
|
||||
Pro-tip: registering pages in opposite order will make same effect without "exact".</p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/be4e1aa15/src/extensions/registries/page-registry.ts#L17">src/extensions/registries/page-registry.ts:17</a></em></p>
|
||||
<hr />
|
||||
<h3 id="optional-id"><code>Optional</code> id<a class="headerlink" href="#optional-id" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>id</strong>? : <em>string</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/11c611dab/src/extensions/registries/page-registry.ts#L18">src/extensions/registries/page-registry.ts:18</a></em></p>
|
||||
<p>Page ID or additional route path to indicate uniqueness within current extension registered pages
|
||||
Might contain special url placeholders, e.g. "/users/:userId?" (? - marks as optional param)
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/be4e1aa15/src/extensions/registries/page-registry.ts#L15">src/extensions/registries/page-registry.ts:15</a></em></p>
|
||||
<p>Page ID, part of extension's page url, must be unique within same extension
|
||||
When not provided, first registered page without "id" would be used for page-menus without target.pageId for same extension</p>
|
||||
<hr />
|
||||
<h3 id="optional-params"><code>Optional</code> params<a class="headerlink" href="#optional-params" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>params</strong>? : <em><a href="../_interfaces_index_.pageparams/">PageParams</a>‹string | ExtensionPageParamInit›</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/be4e1aa15/src/extensions/registries/page-registry.ts#L16">src/extensions/registries/page-registry.ts:16</a></em></p>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in new issue
Block a user