Deployed 411b9a9a88 to master with MkDocs 1.2.3 and mike 1.1.2

This commit is contained in:
GitHub Action committed 2022-01-19 15:31:44 +00:00
1 parent cafbc64c83
commit aa19d970b7
18 files changed
+2191 -43

No files matched your search

@@ -791,6 +791,8 @@
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="catalogaddmenu">catalogAddMenu<a class="headerlink" href="#catalogaddmenu" title="Permanent link">#</a></h3>
<p>▸ <strong>catalogAddMenu</strong>(<code>context</code>): <code>void</code></p>
<p>This event will be emitted when the catalog add menu is opened and is the
way to added entries to that menu.</p>
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
<table>
<thead>
@@ -811,6 +813,8 @@
<hr />
<h3 id="contextmenuopen">contextMenuOpen<a class="headerlink" href="#contextmenuopen" title="Permanent link">#</a></h3>
<p>▸ <strong>contextMenuOpen</strong>(<code>entity</code>, <code>context</code>): <code>void</code></p>
<p>This event will be emitted when the context menu for an entity is declared
by this category is opened.</p>
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
<table>
<thead>
@@ -835,6 +839,8 @@
<hr />
<h3 id="load">load<a class="headerlink" href="#load" title="Permanent link">#</a></h3>
<p>▸ <strong>load</strong>(): <code>void</code></p>
<p>This event will be emitted when the category is loaded in the catalog
view.</p>
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
<p><code>void</code></p>
@@ -739,6 +739,13 @@
<nav class="md-nav" aria-label="Properties">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#displaycolumns" class="md-nav__link">
displayColumns
</a>
</li>
<li class="md-nav__item">
<a href="#group" class="md-nav__link">
group
@@ -784,17 +791,28 @@
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
<ul>
<li><a href="./#displaycolumns">displayColumns</a></li>
<li><a href="./#group">group</a></li>
<li><a href="./#names">names</a></li>
<li><a href="./#versions">versions</a></li>
</ul>
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="displaycolumns">displayColumns<a class="headerlink" href="#displaycolumns" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>displayColumns</strong>: <a href="../Renderer.Component.CategoryColumnRegistration/"><code>CategoryColumnRegistration</code></a>[]</p>
<p>These are the columns used for displaying entities when in the catalog.</p>
<p>If this is not provided then some default columns will be used, similar in
scope to the columns in the "Browse" view.</p>
<p>Even if you provide columns, a "Name" column will be provided as well with
<code>priority: 0</code>.</p>
<p>These columns will not be used in the "Browse" view.</p>
<hr />
<h3 id="group">group<a class="headerlink" href="#group" title="Permanent link">#</a></h3>
<p>• <strong>group</strong>: <code>string</code></p>
<p>The grouping for for the category. This MUST be a DNS label.</p>
<hr />
<h3 id="names">names<a class="headerlink" href="#names" title="Permanent link">#</a></h3>
<p>• <strong>names</strong>: <code>Object</code></p>
<p>This is the concerning the category</p>
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
<table>
<thead>
@@ -2194,12 +2194,16 @@
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="_nowrap">_nowrap<a class="headerlink" href="#_nowrap" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>_nowrap</strong>: <code>boolean</code></p>
<p><strong><code>internal</code></strong>
indicator, might come from parent <TableHead>, don't use this prop outside (!)</p>
<hr />
<h3 id="_sorting">_sorting<a class="headerlink" href="#_sorting" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>_sorting</strong>: <code>Partial</code>&lt;<a href="../../modules/Renderer.Component/#tablesortparams"><code>TableSortParams</code></a>></p>
<p><strong><code>internal</code></strong></p>
<hr />
<h3 id="checkbox">checkbox<a class="headerlink" href="#checkbox" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>checkbox</strong>: <code>boolean</code></p>
<p>render cell with a checkbox</p>
<hr />
<h3 id="children">children<a class="headerlink" href="#children" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>children</strong>: <code>ReactNode</code></p>
@@ -2208,6 +2212,7 @@
<hr />
<h3 id="classname">className<a class="headerlink" href="#classname" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>className</strong>: <code>string</code></p>
<p>Any css class names for this table cell. Only used if <code>title</code> is a "simple" react node</p>
<hr />
<h3 id="dangerouslysetinnerhtml">dangerouslySetInnerHTML<a class="headerlink" href="#dangerouslysetinnerhtml" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>dangerouslySetInnerHTML</strong>: <code>Object</code></p>
@@ -2231,9 +2236,11 @@
<hr />
<h3 id="id">id<a class="headerlink" href="#id" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>id</strong>: <code>string</code></p>
<p>used for configuration visibility of columns</p>
<hr />
<h3 id="ischecked">isChecked<a class="headerlink" href="#ischecked" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isChecked</strong>: <code>boolean</code></p>
<p>mark checkbox as checked or not</p>
<hr />
<h3 id="onabort">onAbort<a class="headerlink" href="#onabort" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>onAbort</strong>: <code>ReactEventHandler</code>&lt;<code>HTMLDivElement</code>></p>
@@ -3037,21 +3044,27 @@
<hr />
<h3 id="renderboolean">renderBoolean<a class="headerlink" href="#renderboolean" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>renderBoolean</strong>: <code>boolean</code></p>
<p>show "true" or "false" for all of the children elements are "typeof boolean"</p>
<hr />
<h3 id="scrollable">scrollable<a class="headerlink" href="#scrollable" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>scrollable</strong>: <code>boolean</code></p>
<p>content inside could be scrolled</p>
<hr />
<h3 id="showwithcolumn">showWithColumn<a class="headerlink" href="#showwithcolumn" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>showWithColumn</strong>: <code>string</code></p>
<p>id of the column which follow same visibility rules</p>
<hr />
<h3 id="sortby">sortBy<a class="headerlink" href="#sortby" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>sortBy</strong>: <code>string</code></p>
<p>column name, must be same as key in sortable object <Table sortable={}/></p>
<hr />
<h3 id="title">title<a class="headerlink" href="#title" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>title</strong>: <code>ReactNode</code></p>
<p>The actual value of the cell</p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="_sort">_sort<a class="headerlink" href="#_sort" title="Permanent link">#</a></h3>
<p>▸ <code>Optional</code> <strong>_sort</strong>(<code>sortBy</code>): <code>void</code></p>
<p><strong><code>internal</code></strong></p>
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
<table>
<thead>