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 8753b2b1 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 09:56:43 +00:00
1 parent 3b90de8804
commit 321f3801dd
188 files changed
+3269 -3269
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
+4 -4
View File
@@ -887,11 +887,11 @@
<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/77ae3155/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/8753b2b1/src/extensions/registries/page-registry.ts#L36">src/extensions/registries/page-registry.ts:36</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/77ae3155/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/8753b2b1/src/extensions/registries/page-registry.ts#L35">src/extensions/registries/page-registry.ts:35</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,14 +904,14 @@ 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/77ae3155/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/8753b2b1/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/77ae3155/src/extensions/registries/page-registry.ts#L23">src/extensions/registries/page-registry.ts:23</a></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>