hendrik/lens
1
0 Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

Deployed c93ee4ea to master with MkDocs 1.1.2 and mike 0.5.5

Browse Source
This commit is contained in:
GitHub Action committed 2020-11-25 10:06:24 +00:00
1 parent 321f3801dd
commit f827629f8e
191 files changed
+3272 -3287
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

master/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html
+3 -17
View File
@@ -843,13 +843,6 @@
Optional id
</a>
</li>
<li class="md-nav__item">
<a href="#optional-routepath" class="md-nav__link">
Optional routePath
</a>
</li>
</ul>
@@ -882,16 +875,15 @@
<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-routepath">routePath</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/8753b2b1/src/extensions/registries/page-registry.ts#L36">src/extensions/registries/page-registry.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/c93ee4ea/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/8753b2b1/src/extensions/registries/page-registry.ts#L35">src/extensions/registries/page-registry.ts:35</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/c93ee4ea/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.
@@ -904,16 +896,10 @@ Pro-tip: registering pages in opposite order will make same effect without "exac
<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/8753b2b1/src/extensions/registries/page-registry.ts#L18">src/extensions/registries/page-registry.ts:18</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/c93ee4ea/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)
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-routepath"><code>Optional</code> routePath<a class="headerlink" href="#optional-routepath" title="Permanent link">#</a></h3>
<p>• <strong>routePath</strong>? : <em>string</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/8753b2b1/src/extensions/registries/page-registry.ts#L23">src/extensions/registries/page-registry.ts:23</a></em></p>
<p>Alias to page ID which assume to be used as path with possible :param placeholders</p>
<p><strong><code>deprecated</code></strong></p>