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 9ba92cb072 to master with MkDocs 1.4.2 and mike 1.1.2

Browse Source
This commit is contained in:
GitHub Action 2022-12-02 15:40:14 +00:00
parent beb305b9a9
commit a7d4d7c7e5
15 changed files with 583 additions and 432 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
master/extensions/api/classes/Main.Ipc/index.html
View File

@ -918,7 +918,7 @@
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
<p>IpcRegistrar.__@IpcPrefix@74173</p>
<p>IpcRegistrar.__@IpcPrefix@74218</p>
<hr />
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code>&lt;<code>LensExtensionDependencies</code>></p>

25
master/extensions/api/classes/Main.LensExtension/index.html
View File

@ -1069,12 +1069,12 @@
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
<p>LensExtension.__@Disposers@30717</p>
<p>LensExtension.__@Disposers@30934</p>
<hr />
<h3 id="lensextensiondependencies">[lensExtensionDependencies]<a class="headerlink" href="#lensextensiondependencies" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>[lensExtensionDependencies]</strong>: <code>LensMainExtensionDependencies</code></p>
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
<p>LensExtension.__@lensExtensionDependencies@30720</p>
<p>LensExtension.__@lensExtensionDependencies@30937</p>
<hr />
<h3 id="appmenus">appMenus<a class="headerlink" href="#appmenus" title="Permanent link">#</a></h3>
<p>• <strong>appMenus</strong>: <code>MenuRegistration</code>[] = <code>[]</code></p>
@ -1191,22 +1191,7 @@ cluster-specific information that can be made available in the shell environment
<p>LensExtension.disable</p>
<hr />
<h3 id="enable">enable<a class="headerlink" href="#enable" title="Permanent link">#</a></h3>
<p>▸ <strong>enable</strong>(<code>register</code>): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>register</code></td>
<td align="left">(<code>ext</code>: <a href="./"><code>LensExtension</code></a>) =&gt; <code>Promise</code>&lt;<code>Disposer</code>[]></td>
</tr>
</tbody>
</table>
<p>▸ <strong>enable</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
@ -1225,7 +1210,7 @@ folder name.</p>
<hr />
<h3 id="navigate">navigate<a class="headerlink" href="#navigate" title="Permanent link">#</a></h3>
<p>▸ <strong>navigate</strong>(<code>pageId?</code>, <code>params?</code>, <code>frameId?</code>): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
@ -1267,7 +1252,7 @@ folder name.</p>
<hr />
<h3 id="removecatalogsource">removeCatalogSource<a class="headerlink" href="#removecatalogsource" title="Permanent link">#</a></h3>
<p>▸ <strong>removeCatalogSource</strong>(<code>id</code>): <code>void</code></p>
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>

2
master/extensions/api/classes/Renderer.Ipc/index.html
View File

@ -918,7 +918,7 @@
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
<p>IpcRegistrar.__@IpcPrefix@74173</p>
<p>IpcRegistrar.__@IpcPrefix@74218</p>
<hr />
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code>&lt;<code>LensExtensionDependencies</code>></p>

25
master/extensions/api/classes/Renderer.LensExtension/index.html
View File

@ -1213,12 +1213,12 @@
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
<p>LensExtension.__@Disposers@30717</p>
<p>LensExtension.__@Disposers@30934</p>
<hr />
<h3 id="lensextensiondependencies">[lensExtensionDependencies]<a class="headerlink" href="#lensextensiondependencies" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>[lensExtensionDependencies]</strong>: <code>LensRendererExtensionDependencies</code></p>
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
<p>LensExtension.__@lensExtensionDependencies@30720</p>
<p>LensExtension.__@lensExtensionDependencies@30937</p>
<hr />
<h3 id="additionalcategorycolumns">additionalCategoryColumns<a class="headerlink" href="#additionalcategorycolumns" title="Permanent link">#</a></h3>
<p>• <strong>additionalCategoryColumns</strong>: <a href="../../interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/"><code>AdditionalCategoryColumnRegistration</code></a>[] = <code>[]</code></p>
@ -1403,22 +1403,7 @@
<p>LensExtension.disable</p>
<hr />
<h3 id="enable">enable<a class="headerlink" href="#enable" title="Permanent link">#</a></h3>
<p>▸ <strong>enable</strong>(<code>register</code>): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>register</code></td>
<td align="left">(<code>ext</code>: <a href="./"><code>LensExtension</code></a>) =&gt; <code>Promise</code>&lt;<code>Disposer</code>[]></td>
</tr>
</tbody>
</table>
<p>▸ <strong>enable</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
@ -1442,7 +1427,7 @@ called when the extension is created within a cluster frame.</p>
<p>The default implementation is to return <code>true</code></p>
<p><strong><code>Deprecated</code></strong></p>
<p>Switch to using "enabled" or "visible" properties in each registration together with <code>activeCluster</code></p>
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
@ -1462,7 +1447,7 @@ called when the extension is created within a cluster frame.</p>
<hr />
<h3 id="navigate">navigate<a class="headerlink" href="#navigate" title="Permanent link">#</a></h3>
<p>▸ <strong>navigate</strong>(<code>pageId?</code>, <code>params?</code>): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>

11
master/extensions/api/interfaces/Renderer.Component.BaseIconProps/index.html
View File

@ -758,6 +758,13 @@
big
</a>
</li>
<li class="md-nav__item">
<a href="#data-testid" class="md-nav__link">
data-testid
</a>
</li>
<li class="md-nav__item">
@ -868,6 +875,7 @@
<ul>
<li><a href="./#active">active</a></li>
<li><a href="./#big">big</a></li>
<li><a href="./#data-testid">data-testid</a></li>
<li><a href="./#disabled">disabled</a></li>
<li><a href="./#focusable">focusable</a></li>
<li><a href="./#href">href</a></li>
@ -889,6 +897,9 @@
<p>• <code>Optional</code> <strong>big</strong>: <code>boolean</code></p>
<p>A pre-defined icon-size</p>
<hr />
<h3 id="data-testid">data-testid<a class="headerlink" href="#data-testid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>data-testid</strong>: <code>string</code></p>
<hr />
<h3 id="disabled">disabled<a class="headerlink" href="#disabled" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>disabled</strong>: <code>boolean</code></p>
<hr />

93
master/extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/index.html
View File

@ -772,6 +772,13 @@
cx
</a>
</li>
<li class="md-nav__item">
<a href="#getclassnames" class="md-nav__link">
getClassNames
</a>
</li>
<li class="md-nav__item">
@ -898,6 +905,7 @@
<li><a href="./#classname">className</a></li>
<li><a href="./#clearvalue">clearValue</a></li>
<li><a href="./#cx">cx</a></li>
<li><a href="./#getclassnames">getClassNames</a></li>
<li><a href="./#getstyles">getStyles</a></li>
<li><a href="./#getvalue">getValue</a></li>
<li><a href="./#hasvalue">hasValue</a></li>
@ -938,64 +946,107 @@
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
<p>PlaceholderProps.cx</p>
<hr />
<h3 id="getclassnames">getClassNames<a class="headerlink" href="#getclassnames" title="Permanent link">#</a></h3>
<p>• <strong>getClassNames</strong>: &lt;Key>(<code>propertyName</code>: <code>Key</code>, <code>props</code>: <code>StylesProps</code>&lt;<code>NamespaceSelectFilterOption</code>, <code>true</code>, <code>GroupBase</code>&lt;<code>NamespaceSelectFilterOption</code>>>[<code>Key</code>]) =&gt; <code>undefined</code> | <code>string</code></p>
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
<p>▸ &lt;<code>Key</code>>(<code>propertyName</code>, <code>props</code>): <code>undefined</code> | <code>string</code></p>
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>Key</code></td>
<td align="left">extends keyof <code>StylesProps</code>&lt;<code>Option</code>, <code>IsMulti</code>, <code>Group</code>></td>
</tr>
</tbody>
</table>
<h5 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h5>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>propertyName</code></td>
<td align="left"><code>Key</code></td>
</tr>
<tr>
<td align="left"><code>props</code></td>
<td align="left"><code>StylesProps</code>&lt;<code>NamespaceSelectFilterOption</code>, <code>true</code>, <code>GroupBase</code>&lt;<code>NamespaceSelectFilterOption</code>>>[<code>Key</code>]</td>
</tr>
</tbody>
</table>
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
<p><code>undefined</code> | <code>string</code></p>
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
<p>PlaceholderProps.getClassNames</p>
<hr />
<h3 id="getstyles">getStyles<a class="headerlink" href="#getstyles" title="Permanent link">#</a></h3>
<p>• <strong>getStyles</strong>: <code>GetStyles</code>&lt;<code>NamespaceSelectFilterOption</code>, <code>true</code>, <code>GroupBase</code>&lt;<code>NamespaceSelectFilterOption</code>>></p>
<p>Get the styles of a particular part of the select. Pass in the name of the
property as the first argument, and the current props as the second argument.
See the <code>styles</code> object for the properties available.</p>
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
<p>PlaceholderProps.getStyles</p>
<hr />
<h3 id="getvalue">getValue<a class="headerlink" href="#getvalue" title="Permanent link">#</a></h3>
<p>• <strong>getValue</strong>: () =&gt; <code>Options</code>&lt;<code>NamespaceSelectFilterOption</code>></p>
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
<p>▸ (): <code>Options</code>&lt;<code>NamespaceSelectFilterOption</code>></p>
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
<p><code>Options</code>&lt;<code>NamespaceSelectFilterOption</code>></p>
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
<p>PlaceholderProps.getValue</p>
<hr />
<h3 id="hasvalue">hasValue<a class="headerlink" href="#hasvalue" title="Permanent link">#</a></h3>
<p>• <strong>hasValue</strong>: <code>boolean</code></p>
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
<p>PlaceholderProps.hasValue</p>
<hr />
<h3 id="innerprops">innerProps<a class="headerlink" href="#innerprops" title="Permanent link">#</a></h3>
<p>• <strong>innerProps</strong>: <code>DetailedHTMLProps</code>&lt;<code>HTMLAttributes</code>&lt;<code>HTMLDivElement</code>>, <code>HTMLDivElement</code>></p>
<p>props passed to the wrapping element for the group.</p>
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
<p>PlaceholderProps.innerProps</p>
<hr />
<h3 id="isdisabled">isDisabled<a class="headerlink" href="#isdisabled" title="Permanent link">#</a></h3>
<p>• <strong>isDisabled</strong>: <code>boolean</code></p>
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
<p>PlaceholderProps.isDisabled</p>
<hr />
<h3 id="isfocused">isFocused<a class="headerlink" href="#isfocused" title="Permanent link">#</a></h3>
<p>• <strong>isFocused</strong>: <code>boolean</code></p>
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
<p>PlaceholderProps.isFocused</p>
<hr />
<h3 id="ismulti">isMulti<a class="headerlink" href="#ismulti" title="Permanent link">#</a></h3>
<p>• <strong>isMulti</strong>: <code>boolean</code></p>
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<p>PlaceholderProps.isMulti</p>
<hr />
<h3 id="isrtl">isRtl<a class="headerlink" href="#isrtl" title="Permanent link">#</a></h3>
<p>• <strong>isRtl</strong>: <code>boolean</code></p>
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<p>PlaceholderProps.isRtl</p>
<hr />
<h3 id="options">options<a class="headerlink" href="#options" title="Permanent link">#</a></h3>
<p>• <strong>options</strong>: <code>OptionsOrGroups</code>&lt;<code>NamespaceSelectFilterOption</code>, <code>GroupBase</code>&lt;<code>NamespaceSelectFilterOption</code>>></p>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<p>PlaceholderProps.options</p>
<hr />
<h3 id="selectoption">selectOption<a class="headerlink" href="#selectoption" title="Permanent link">#</a></h3>
<p>• <strong>selectOption</strong>: (<code>newValue</code>: <code>NamespaceSelectFilterOption</code>) =&gt; <code>void</code></p>
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
<p>▸ (<code>newValue</code>): <code>void</code></p>
<h5 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h5>
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
<table>
<thead>
<tr>
@ -1010,21 +1061,21 @@ See the <code>styles</code> object for the properties available.</p>
</tr>
</tbody>
</table>
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<p>PlaceholderProps.selectOption</p>
<hr />
<h3 id="selectprops">selectProps<a class="headerlink" href="#selectprops" title="Permanent link">#</a></h3>
<p>• <strong>selectProps</strong>: <code>Props</code>&lt;<code>NamespaceSelectFilterOption</code>, <code>true</code>, <code>GroupBase</code>&lt;<code>NamespaceSelectFilterOption</code>>></p>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<p>PlaceholderProps.selectProps</p>
<hr />
<h3 id="setvalue">setValue<a class="headerlink" href="#setvalue" title="Permanent link">#</a></h3>
<p>• <strong>setValue</strong>: (<code>newValue</code>: <code>MultiValue</code>&lt;<code>NamespaceSelectFilterOption</code>>, <code>action</code>: <code>SetValueAction</code>, <code>option?</code>: <code>NamespaceSelectFilterOption</code>) =&gt; <code>void</code></p>
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
<p>▸ (<code>newValue</code>, <code>action</code>, <code>option?</code>): <code>void</code></p>
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
<table>
<thead>
<tr>
@ -1047,14 +1098,14 @@ See the <code>styles</code> object for the properties available.</p>
</tr>
</tbody>
</table>
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
<p>PlaceholderProps.setValue</p>
<hr />
<h3 id="theme">theme<a class="headerlink" href="#theme" title="Permanent link">#</a></h3>
<p>• <strong>theme</strong>: <code>Theme</code></p>
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
<p>PlaceholderProps.theme</p>

425
master/extensions/api/interfaces/Renderer.Component.IconProps/index.html
View File

File diff suppressed because it is too large Load Diff

59
master/extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/index.html
View File

@ -793,6 +793,13 @@
customizeTableRowProps
</a>
</li>
<li class="md-nav__item">
<a href="#data-testid" class="md-nav__link">
data-testid
</a>
</li>
<li class="md-nav__item">
@ -1049,6 +1056,7 @@
<li><a href="./#customizeheader">customizeHeader</a></li>
<li><a href="./#customizeremovedialog">customizeRemoveDialog</a></li>
<li><a href="./#customizetablerowprops">customizeTableRowProps</a></li>
<li><a href="./#data-testid">data-testid</a></li>
<li><a href="./#dependentstores">dependentStores</a></li>
<li><a href="./#detailsitem">detailsItem</a></li>
<li><a href="./#failedtoloadmessage">failedToLoadMessage</a></li>
@ -1147,12 +1155,17 @@
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
<p>Omit.customizeTableRowProps</p>
<hr />
<h3 id="data-testid">data-testid<a class="headerlink" href="#data-testid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>data-testid</strong>: <code>string</code></p>
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
<p>Omit.data-testid</p>
<hr />
<h3 id="dependentstores">dependentStores<a class="headerlink" href="#dependentstores" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>dependentStores</strong>: <code>SubscribableStore</code>[]</p>
<hr />
<h3 id="detailsitem">detailsItem<a class="headerlink" href="#detailsitem" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>detailsItem</strong>: <code>K</code></p>
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
<p>Omit.detailsItem</p>
<hr />
<h3 id="failedtoloadmessage">failedToLoadMessage<a class="headerlink" href="#failedtoloadmessage" title="Permanent link">#</a></h3>
@ -1160,18 +1173,18 @@
<p>Message to display when a store failed to load</p>
<p><strong><code>Default</code></strong></p>
<p>"Failed to load items"</p>
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
<p>Omit.failedToLoadMessage</p>
<hr />
<h3 id="filtercallbacks">filterCallbacks<a class="headerlink" href="#filtercallbacks" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>filterCallbacks</strong>: <code>ItemsFilters</code>&lt;<code>K</code>></p>
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
<p>Omit.filterCallbacks</p>
<hr />
<h3 id="filteritems">filterItems<a class="headerlink" href="#filteritems" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>filterItems</strong>: <code>ItemsFilter</code>&lt;<code>K</code>>[]</p>
<p><strong><code>Deprecated</code></strong></p>
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
<p>Omit.filterItems</p>
<hr />
<h3 id="getitems">getItems<a class="headerlink" href="#getitems" title="Permanent link">#</a></h3>
@ -1183,32 +1196,32 @@
<hr />
<h3 id="hasdetailsview">hasDetailsView<a class="headerlink" href="#hasdetailsview" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>hasDetailsView</strong>: <code>boolean</code></p>
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<p>Omit.hasDetailsView</p>
<hr />
<h3 id="headerclassname">headerClassName<a class="headerlink" href="#headerclassname" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>headerClassName</strong>: <code>IClassName</code></p>
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<p>Omit.headerClassName</p>
<hr />
<h3 id="hidefilters">hideFilters<a class="headerlink" href="#hidefilters" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>hideFilters</strong>: <code>boolean</code></p>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<p>Omit.hideFilters</p>
<hr />
<h3 id="isconfigurable">isConfigurable<a class="headerlink" href="#isconfigurable" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isConfigurable</strong>: <code>boolean</code></p>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<p>Omit.isConfigurable</p>
<hr />
<h3 id="isready">isReady<a class="headerlink" href="#isready" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isReady</strong>: <code>boolean</code></p>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<p>Omit.isReady</p>
<hr />
<h3 id="isselectable">isSelectable<a class="headerlink" href="#isselectable" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isSelectable</strong>: <code>boolean</code></p>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
<p>Omit.isSelectable</p>
<hr />
<h3 id="items">items<a class="headerlink" href="#items" title="Permanent link">#</a></h3>
@ -1235,7 +1248,7 @@
</table>
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
<p>Omit.onDetails</p>
<hr />
<h3 id="renderfooter">renderFooter<a class="headerlink" href="#renderfooter" title="Permanent link">#</a></h3>
@ -1259,12 +1272,12 @@
</table>
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
<p><code>ReactNode</code></p>
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
<p>Omit.renderFooter</p>
<hr />
<h3 id="renderheadertitle">renderHeaderTitle<a class="headerlink" href="#renderheadertitle" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>renderHeaderTitle</strong>: <code>RenderHeaderTitle</code>&lt;<code>K</code>, <code>false</code>></p>
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
<p>Omit.renderHeaderTitle</p>
<hr />
<h3 id="renderitemmenu">renderItemMenu<a class="headerlink" href="#renderitemmenu" title="Permanent link">#</a></h3>
@ -1292,7 +1305,7 @@
</table>
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
<p><code>ReactNode</code></p>
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
<p>Omit.renderItemMenu</p>
<hr />
<h3 id="rendertablecontents">renderTableContents<a class="headerlink" href="#rendertablecontents" title="Permanent link">#</a></h3>
@ -1316,32 +1329,32 @@
</table>
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
<p>(<code>ReactNode</code> | <a href="../Renderer.Component.TableCellProps/"><code>TableCellProps</code></a>)[]</p>
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
<p>Omit.renderTableContents</p>
<hr />
<h3 id="rendertableheader">renderTableHeader<a class="headerlink" href="#rendertableheader" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>renderTableHeader</strong>: (<code>undefined</code> | <code>null</code> | <a href="../Renderer.Component.TableCellProps/"><code>TableCellProps</code></a>)[]</p>
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
<p>Omit.renderTableHeader</p>
<hr />
<h3 id="searchfilters">searchFilters<a class="headerlink" href="#searchfilters" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>searchFilters</strong>: <code>SearchFilter</code>&lt;<code>K</code>>[]</p>
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
<p>Omit.searchFilters</p>
<hr />
<h3 id="showheader">showHeader<a class="headerlink" href="#showheader" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>showHeader</strong>: <code>boolean</code></p>
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
<p>Omit.showHeader</p>
<hr />
<h3 id="sortingcallbacks">sortingCallbacks<a class="headerlink" href="#sortingcallbacks" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>sortingCallbacks</strong>: <a href="../../modules/Renderer.Component/#tablesortcallbacks"><code>TableSortCallbacks</code></a>&lt;<code>K</code>></p>
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
<p>Omit.sortingCallbacks</p>
<hr />
<h3 id="spinnertestid">spinnerTestId<a class="headerlink" href="#spinnertestid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>spinnerTestId</strong>: <code>string</code></p>
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
<p>Omit.spinnerTestId</p>
<hr />
<h3 id="store">store<a class="headerlink" href="#store" title="Permanent link">#</a></h3>
@ -1354,17 +1367,17 @@
<hr />
<h3 id="tableid">tableId<a class="headerlink" href="#tableid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>tableId</strong>: <code>string</code></p>
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
<p>Omit.tableId</p>
<hr />
<h3 id="tableprops">tableProps<a class="headerlink" href="#tableprops" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>tableProps</strong>: <code>Partial</code>&lt;<a href="../Renderer.Component.TableProps/"><code>TableProps</code></a>&lt;<code>K</code>>></p>
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
<p>Omit.tableProps</p>
<hr />
<h3 id="virtual">virtual<a class="headerlink" href="#virtual" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>virtual</strong>: <code>boolean</code></p>
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
<p>Omit.virtual</p>

41
master/extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/index.html
View File

@ -814,6 +814,13 @@
closeOnScroll
</a>
</li>
<li class="md-nav__item">
<a href="#data-testid" class="md-nav__link">
data-testid
</a>
</li>
<li class="md-nav__item">
@ -1000,6 +1007,7 @@
<li><a href="./#closeonclickitem">closeOnClickItem</a></li>
<li><a href="./#closeonclickoutside">closeOnClickOutside</a></li>
<li><a href="./#closeonscroll">closeOnScroll</a></li>
<li><a href="./#data-testid">data-testid</a></li>
<li><a href="./#editable">editable</a></li>
<li><a href="./#htmlfor">htmlFor</a></li>
<li><a href="./#id">id</a></li>
@ -1062,22 +1070,27 @@
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#closeonscroll">closeOnScroll</a></p>
<hr />
<h3 id="data-testid">data-testid<a class="headerlink" href="#data-testid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>data-testid</strong>: <code>string</code></p>
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#data-testid">data-testid</a></p>
<hr />
<h3 id="editable">editable<a class="headerlink" href="#editable" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>editable</strong>: <code>boolean</code></p>
<hr />
<h3 id="htmlfor">htmlFor<a class="headerlink" href="#htmlfor" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>htmlFor</strong>: <code>string</code></p>
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#htmlfor">htmlFor</a></p>
<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>
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#id">id</a></p>
<hr />
<h3 id="isopen">isOpen<a class="headerlink" href="#isopen" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isOpen</strong>: <code>boolean</code></p>
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#isopen">isOpen</a></p>
<hr />
<h3 id="object">object<a class="headerlink" href="#object" title="Permanent link">#</a></h3>
@ -1089,12 +1102,12 @@
<p>▸ (): <code>void</code></p>
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#onopen">onOpen</a></p>
<hr />
<h3 id="position">position<a class="headerlink" href="#position" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>position</strong>: <a href="../Renderer.Component.MenuPosition/"><code>MenuPosition</code></a></p>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#position">position</a></p>
<hr />
<h3 id="removable">removable<a class="headerlink" href="#removable" title="Permanent link">#</a></h3>
@ -1108,29 +1121,29 @@
<p>Provide your own remove <code>&lt;MenuItem&gt;</code> as part of the <code>children</code> passed to this component</p>
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
<p><code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#removeaction">removeAction</a></p>
<hr />
<h3 id="removeconfirmationmessage">removeConfirmationMessage<a class="headerlink" href="#removeconfirmationmessage" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>removeConfirmationMessage</strong>: <code>ReactNode</code> | () =&gt; <code>ReactNode</code></p>
<p><strong><code>Deprecated</code></strong></p>
<p>Provide your own remove <code>&lt;MenuItem&gt;</code> as part of the <code>children</code> passed to this component</p>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#removeconfirmationmessage">removeConfirmationMessage</a></p>
<hr />
<h3 id="toggleevent">toggleEvent<a class="headerlink" href="#toggleevent" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>toggleEvent</strong>: <code>"contextmenu"</code> | <code>"click"</code></p>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#toggleevent">toggleEvent</a></p>
<hr />
<h3 id="toolbar">toolbar<a class="headerlink" href="#toolbar" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>toolbar</strong>: <code>boolean</code></p>
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#toolbar">toolbar</a></p>
<hr />
<h3 id="triggericon">triggerIcon<a class="headerlink" href="#triggericon" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>triggerIcon</strong>: <code>ReactNode</code> | <a href="../Renderer.Component.IconProps/"><code>IconProps</code></a> &amp; <a href="../Renderer.Component.TooltipDecoratorProps/"><code>TooltipDecoratorProps</code></a></p>
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#triggericon">triggerIcon</a></p>
<hr />
<h3 id="updateaction">updateAction<a class="headerlink" href="#updateaction" title="Permanent link">#</a></h3>
@ -1141,26 +1154,26 @@
<p>Provide your own update <code>&lt;MenuItem&gt;</code> as part of the <code>children</code> passed to this component</p>
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
<p><code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#updateaction">updateAction</a></p>
<hr />
<h3 id="useportal">usePortal<a class="headerlink" href="#useportal" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>usePortal</strong>: <code>boolean</code> | <code>HTMLElement</code></p>
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#useportal">usePortal</a></p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="close">close<a class="headerlink" href="#close" title="Permanent link">#</a></h3>
<p>▸ <code>Optional</code> <strong>close</strong>(): <code>void</code></p>
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
<p><code>void</code></p>
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#close">close</a></p>
<hr />
<h3 id="open">open<a class="headerlink" href="#open" title="Permanent link">#</a></h3>
<p>▸ <code>Optional</code> <strong>open</strong>(): <code>void</code></p>
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
<p><code>void</code></p>
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
<p><a href="../Renderer.Component.MenuActionsProps/">MenuActionsProps</a>.<a href="../Renderer.Component.MenuActionsProps/#open">open</a></p>

27
master/extensions/api/interfaces/Renderer.Component.MenuActionsProps/index.html
View File

@ -807,6 +807,13 @@
closeOnScroll
</a>
</li>
<li class="md-nav__item">
<a href="#data-testid" class="md-nav__link">
data-testid
</a>
</li>
<li class="md-nav__item">
@ -958,6 +965,7 @@
<li><a href="./#closeonclickitem">closeOnClickItem</a></li>
<li><a href="./#closeonclickoutside">closeOnClickOutside</a></li>
<li><a href="./#closeonscroll">closeOnScroll</a></li>
<li><a href="./#data-testid">data-testid</a></li>
<li><a href="./#htmlfor">htmlFor</a></li>
<li><a href="./#id">id</a></li>
<li><a href="./#isopen">isOpen</a></li>
@ -1015,9 +1023,14 @@
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
<p>Partial.closeOnScroll</p>
<hr />
<h3 id="data-testid">data-testid<a class="headerlink" href="#data-testid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>data-testid</strong>: <code>string</code></p>
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
<p>Partial.data-testid</p>
<hr />
<h3 id="htmlfor">htmlFor<a class="headerlink" href="#htmlfor" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>htmlFor</strong>: <code>string</code></p>
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
<p>Partial.htmlFor</p>
<hr />
<h3 id="id">id<a class="headerlink" href="#id" title="Permanent link">#</a></h3>
@ -1027,7 +1040,7 @@
<hr />
<h3 id="isopen">isOpen<a class="headerlink" href="#isopen" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isOpen</strong>: <code>boolean</code></p>
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
<p>Partial.isOpen</p>
<hr />
<h3 id="onopen">onOpen<a class="headerlink" href="#onopen" title="Permanent link">#</a></h3>
@ -1039,7 +1052,7 @@
<hr />
<h3 id="position">position<a class="headerlink" href="#position" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>position</strong>: <a href="../Renderer.Component.MenuPosition/"><code>MenuPosition</code></a></p>
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
<p>Partial.position</p>
<hr />
<h3 id="removeaction">removeAction<a class="headerlink" href="#removeaction" title="Permanent link">#</a></h3>
@ -1058,7 +1071,7 @@
<hr />
<h3 id="toggleevent">toggleEvent<a class="headerlink" href="#toggleevent" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>toggleEvent</strong>: <code>"contextmenu"</code> | <code>"click"</code></p>
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
<p>Partial.toggleEvent</p>
<hr />
<h3 id="toolbar">toolbar<a class="headerlink" href="#toolbar" title="Permanent link">#</a></h3>
@ -1078,21 +1091,21 @@
<hr />
<h3 id="useportal">usePortal<a class="headerlink" href="#useportal" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>usePortal</strong>: <code>boolean</code> | <code>HTMLElement</code></p>
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<p>Partial.usePortal</p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="close">close<a class="headerlink" href="#close" title="Permanent link">#</a></h3>
<p>▸ <code>Optional</code> <strong>close</strong>(): <code>void</code></p>
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
<p><code>void</code></p>
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<p>Partial.close</p>
<hr />
<h3 id="open">open<a class="headerlink" href="#open" title="Permanent link">#</a></h3>
<p>▸ <code>Optional</code> <strong>open</strong>(): <code>void</code></p>
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
<p><code>void</code></p>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<p>Partial.open</p>

11
master/extensions/api/interfaces/Renderer.Component.MenuProps/index.html
View File

@ -793,6 +793,13 @@
closeOnScroll
</a>
</li>
<li class="md-nav__item">
<a href="#data-testid" class="md-nav__link">
data-testid
</a>
</li>
<li class="md-nav__item">
@ -895,6 +902,7 @@
<li><a href="./#closeonclickitem">closeOnClickItem</a></li>
<li><a href="./#closeonclickoutside">closeOnClickOutside</a></li>
<li><a href="./#closeonscroll">closeOnScroll</a></li>
<li><a href="./#data-testid">data-testid</a></li>
<li><a href="./#htmlfor">htmlFor</a></li>
<li><a href="./#id">id</a></li>
<li><a href="./#isopen">isOpen</a></li>
@ -929,6 +937,9 @@
<h3 id="closeonscroll">closeOnScroll<a class="headerlink" href="#closeonscroll" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>closeOnScroll</strong>: <code>boolean</code></p>
<hr />
<h3 id="data-testid">data-testid<a class="headerlink" href="#data-testid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>data-testid</strong>: <code>string</code></p>
<hr />
<h3 id="htmlfor">htmlFor<a class="headerlink" href="#htmlfor" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>htmlFor</strong>: <code>string</code></p>
<hr />

150
master/extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/index.html
View File

@ -842,6 +842,13 @@
classNamePrefix
</a>
</li>
<li class="md-nav__item">
<a href="#classnames" class="md-nav__link">
classNames
</a>
</li>
<li class="md-nav__item">
@ -1283,6 +1290,13 @@
themeName
</a>
</li>
<li class="md-nav__item">
<a href="#unstyled" class="md-nav__link">
unstyled
</a>
</li>
<li class="md-nav__item">
@ -1349,6 +1363,7 @@
<li><a href="./#capturemenuscroll">captureMenuScroll</a></li>
<li><a href="./#classname">className</a></li>
<li><a href="./#classnameprefix">classNamePrefix</a></li>
<li><a href="./#classnames">classNames</a></li>
<li><a href="./#closemenuonscroll">closeMenuOnScroll</a></li>
<li><a href="./#closemenuonselect">closeMenuOnSelect</a></li>
<li><a href="./#components">components</a></li>
@ -1412,6 +1427,7 @@
<li><a href="./#tabselectsvalue">tabSelectsValue</a></li>
<li><a href="./#theme">theme</a></li>
<li><a href="./#themename">themeName</a></li>
<li><a href="./#unstyled">unstyled</a></li>
<li><a href="./#value">value</a></li>
</ul>
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
@ -1495,6 +1511,12 @@
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<p>Omit.classNamePrefix</p>
<hr />
<h3 id="classnames">classNames<a class="headerlink" href="#classnames" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>classNames</strong>: <code>ClassNamesConfig</code>&lt;{ <code>label</code>: <code>string</code> ; <code>value</code>: <code>string</code> }, <code>IsMulti</code>, <code>GroupBase</code>&lt;{ <code>label</code>: <code>string</code> ; <code>value</code>: <code>string</code> }>></p>
<p>Provide classNames based on state for each inner component</p>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<p>Omit.classNames</p>
<hr />
<h3 id="closemenuonscroll">closeMenuOnScroll<a class="headerlink" href="#closemenuonscroll" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>closeMenuOnScroll</strong>: <code>boolean</code> | (<code>event</code>: <code>Event</code>) =&gt; <code>boolean</code></p>
<p>If <code>true</code>, close the select menu when the user scrolls the document/body.</p>
@ -1503,13 +1525,13 @@
<p><code>false</code> =&gt; The menu stays open</p>
<p>This is useful when you have a scrollable modal and want to portal the menu out,
but want to avoid graphical issues.</p>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<p>Omit.closeMenuOnScroll</p>
<hr />
<h3 id="closemenuonselect">closeMenuOnSelect<a class="headerlink" href="#closemenuonselect" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>closeMenuOnSelect</strong>: <code>boolean</code></p>
<p>Close the select menu when the user selects an option</p>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<p>Omit.closeMenuOnSelect</p>
<hr />
<h3 id="components">components<a class="headerlink" href="#components" title="Permanent link">#</a></h3>
@ -1520,52 +1542,52 @@ with the appropriate namespace.</p>
<p>If you only wish to restyle a component, we recommend using the <code>styles</code> prop
instead. For a list of the components that can be passed in, and the shape
that will be passed to them, see <a href="/components">the components docs</a></p>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
<p>Omit.components</p>
<hr />
<h3 id="controlshouldrendervalue">controlShouldRenderValue<a class="headerlink" href="#controlshouldrendervalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>controlShouldRenderValue</strong>: <code>boolean</code></p>
<p>Whether the value of the select, e.g. SingleValue, should be displayed in the control.</p>
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
<p>Omit.controlShouldRenderValue</p>
<hr />
<h3 id="defaultinputvalue">defaultInputValue<a class="headerlink" href="#defaultinputvalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>defaultInputValue</strong>: <code>string</code></p>
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
<p>Omit.defaultInputValue</p>
<hr />
<h3 id="defaultmenuisopen">defaultMenuIsOpen<a class="headerlink" href="#defaultmenuisopen" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>defaultMenuIsOpen</strong>: <code>boolean</code></p>
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
<p>Omit.defaultMenuIsOpen</p>
<hr />
<h3 id="defaultvalue">defaultValue<a class="headerlink" href="#defaultvalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>defaultValue</strong>: <code>PropsValue</code>&lt;{ <code>label</code>: <code>string</code> ; <code>value</code>: <code>string</code> }></p>
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
<p>Omit.defaultValue</p>
<hr />
<h3 id="delimiter">delimiter<a class="headerlink" href="#delimiter" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>delimiter</strong>: <code>string</code></p>
<p>Delimiter used to join multiple values into a single HTML Input value</p>
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
<p>Omit.delimiter</p>
<hr />
<h3 id="escapeclearsvalue">escapeClearsValue<a class="headerlink" href="#escapeclearsvalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>escapeClearsValue</strong>: <code>boolean</code></p>
<p>Clear all values when the user presses escape AND the menu is closed</p>
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
<p>Omit.escapeClearsValue</p>
<hr />
<h3 id="filteroption">filterOption<a class="headerlink" href="#filteroption" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>filterOption</strong>: <code>null</code> | (<code>option</code>: <code>FilterOptionOption</code>&lt;{ <code>label</code>: <code>string</code> ; <code>value</code>: <code>string</code> }>, <code>inputValue</code>: <code>string</code>) =&gt; <code>boolean</code></p>
<p>Custom method to filter whether an option should be displayed in the menu</p>
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
<p>Omit.filterOption</p>
<hr />
<h3 id="form">form<a class="headerlink" href="#form" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>form</strong>: <code>string</code></p>
<p>Sets the form attribute on the input</p>
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
<p>Omit.form</p>
<hr />
<h3 id="formatgrouplabel">formatGroupLabel<a class="headerlink" href="#formatgrouplabel" title="Permanent link">#</a></h3>
@ -1591,7 +1613,7 @@ that will be passed to them, see <a href="/components">the components docs</a></
</table>
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
<p><code>ReactNode</code></p>
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
<p>Omit.formatGroupLabel</p>
<hr />
<h3 id="formatoptionlabel">formatOptionLabel<a class="headerlink" href="#formatoptionlabel" title="Permanent link">#</a></h3>
@ -1628,7 +1650,7 @@ that will be passed to them, see <a href="/components">the components docs</a></
</table>
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
<p><code>ReactNode</code></p>
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
<p>Omit.formatOptionLabel</p>
<hr />
<h3 id="getoptionlabel">getOptionLabel<a class="headerlink" href="#getoptionlabel" title="Permanent link">#</a></h3>
@ -1636,73 +1658,73 @@ that will be passed to them, see <a href="/components">the components docs</a></
<p>Resolves option data to a string to be displayed as the label by components</p>
<p>Note: Failure to resolve to a string type can interfere with filtering and
screen reader support.</p>
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
<p>Omit.getOptionLabel</p>
<hr />
<h3 id="getoptionvalue">getOptionValue<a class="headerlink" href="#getoptionvalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>getOptionValue</strong>: <code>GetOptionValue</code>&lt;{ <code>label</code>: <code>string</code> ; <code>value</code>: <code>string</code> }></p>
<p>Resolves option data to a string to compare options and specify value attributes</p>
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
<p>Omit.getOptionValue</p>
<hr />
<h3 id="hideselectedoptions">hideSelectedOptions<a class="headerlink" href="#hideselectedoptions" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>hideSelectedOptions</strong>: <code>boolean</code></p>
<p>Hide the selected option from the menu</p>
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
<p>Omit.hideSelectedOptions</p>
<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>
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
<p>Omit.id</p>
<hr />
<h3 id="inputid">inputId<a class="headerlink" href="#inputid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>inputId</strong>: <code>string</code></p>
<p>The id of the search input</p>
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
<p>Omit.inputId</p>
<hr />
<h3 id="inputvalue">inputValue<a class="headerlink" href="#inputvalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>inputValue</strong>: <code>string</code></p>
<p>The value of the search input</p>
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
<p>Omit.inputValue</p>
<hr />
<h3 id="instanceid">instanceId<a class="headerlink" href="#instanceid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>instanceId</strong>: <code>string</code> | <code>number</code></p>
<p>Define an id prefix for the select components e.g. {your-id}-value</p>
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
<h4 id="inherited-from_33">Inherited from<a class="headerlink" href="#inherited-from_33" title="Permanent link">#</a></h4>
<p>Omit.instanceId</p>
<hr />
<h3 id="isclearable">isClearable<a class="headerlink" href="#isclearable" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isClearable</strong>: <code>boolean</code></p>
<p>Is the select value clearable</p>
<h4 id="inherited-from_33">Inherited from<a class="headerlink" href="#inherited-from_33" title="Permanent link">#</a></h4>
<h4 id="inherited-from_34">Inherited from<a class="headerlink" href="#inherited-from_34" title="Permanent link">#</a></h4>
<p>Omit.isClearable</p>
<hr />
<h3 id="iscreatable">isCreatable<a class="headerlink" href="#iscreatable" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isCreatable</strong>: <code>boolean</code></p>
<p><strong><code>Deprecated</code></strong></p>
<p>This option does nothing</p>
<h4 id="inherited-from_34">Inherited from<a class="headerlink" href="#inherited-from_34" title="Permanent link">#</a></h4>
<h4 id="inherited-from_35">Inherited from<a class="headerlink" href="#inherited-from_35" title="Permanent link">#</a></h4>
<p>Omit.isCreatable</p>
<hr />
<h3 id="isdisabled">isDisabled<a class="headerlink" href="#isdisabled" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isDisabled</strong>: <code>boolean</code></p>
<p>Is the select disabled</p>
<h4 id="inherited-from_35">Inherited from<a class="headerlink" href="#inherited-from_35" title="Permanent link">#</a></h4>
<h4 id="inherited-from_36">Inherited from<a class="headerlink" href="#inherited-from_36" title="Permanent link">#</a></h4>
<p>Omit.isDisabled</p>
<hr />
<h3 id="isloading">isLoading<a class="headerlink" href="#isloading" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isLoading</strong>: <code>boolean</code></p>
<p>Is the select in a state of loading (async)</p>
<h4 id="inherited-from_36">Inherited from<a class="headerlink" href="#inherited-from_36" title="Permanent link">#</a></h4>
<h4 id="inherited-from_37">Inherited from<a class="headerlink" href="#inherited-from_37" title="Permanent link">#</a></h4>
<p>Omit.isLoading</p>
<hr />
<h3 id="ismulti">isMulti<a class="headerlink" href="#ismulti" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isMulti</strong>: <code>IsMulti</code></p>
<p>Support multiple selected options</p>
<h4 id="inherited-from_37">Inherited from<a class="headerlink" href="#inherited-from_37" title="Permanent link">#</a></h4>
<h4 id="inherited-from_38">Inherited from<a class="headerlink" href="#inherited-from_38" title="Permanent link">#</a></h4>
<p>Omit.isMulti</p>
<hr />
<h3 id="isoptiondisabled">isOptionDisabled<a class="headerlink" href="#isoptiondisabled" title="Permanent link">#</a></h3>
@ -1740,7 +1762,7 @@ screen reader support.</p>
</table>
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
<p><code>boolean</code></p>
<h4 id="inherited-from_38">Inherited from<a class="headerlink" href="#inherited-from_38" title="Permanent link">#</a></h4>
<h4 id="inherited-from_39">Inherited from<a class="headerlink" href="#inherited-from_39" title="Permanent link">#</a></h4>
<p>Omit.isOptionDisabled</p>
<hr />
<h3 id="isoptionselected">isOptionSelected<a class="headerlink" href="#isoptionselected" title="Permanent link">#</a></h3>
@ -1777,19 +1799,19 @@ screen reader support.</p>
</table>
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
<p><code>boolean</code></p>
<h4 id="inherited-from_39">Inherited from<a class="headerlink" href="#inherited-from_39" title="Permanent link">#</a></h4>
<h4 id="inherited-from_40">Inherited from<a class="headerlink" href="#inherited-from_40" title="Permanent link">#</a></h4>
<p>Omit.isOptionSelected</p>
<hr />
<h3 id="isrtl">isRtl<a class="headerlink" href="#isrtl" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isRtl</strong>: <code>boolean</code></p>
<p>Is the select direction right-to-left</p>
<h4 id="inherited-from_40">Inherited from<a class="headerlink" href="#inherited-from_40" title="Permanent link">#</a></h4>
<h4 id="inherited-from_41">Inherited from<a class="headerlink" href="#inherited-from_41" title="Permanent link">#</a></h4>
<p>Omit.isRtl</p>
<hr />
<h3 id="issearchable">isSearchable<a class="headerlink" href="#issearchable" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isSearchable</strong>: <code>boolean</code></p>
<p>Whether to enable search functionality</p>
<h4 id="inherited-from_41">Inherited from<a class="headerlink" href="#inherited-from_41" title="Permanent link">#</a></h4>
<h4 id="inherited-from_42">Inherited from<a class="headerlink" href="#inherited-from_42" title="Permanent link">#</a></h4>
<p>Omit.isSearchable</p>
<hr />
<h3 id="loadingmessage">loadingMessage<a class="headerlink" href="#loadingmessage" title="Permanent link">#</a></h3>
@ -1818,68 +1840,68 @@ screen reader support.</p>
</table>
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
<p><code>ReactNode</code></p>
<h4 id="inherited-from_42">Inherited from<a class="headerlink" href="#inherited-from_42" title="Permanent link">#</a></h4>
<h4 id="inherited-from_43">Inherited from<a class="headerlink" href="#inherited-from_43" title="Permanent link">#</a></h4>
<p>Omit.loadingMessage</p>
<hr />
<h3 id="maxmenuheight">maxMenuHeight<a class="headerlink" href="#maxmenuheight" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>maxMenuHeight</strong>: <code>number</code></p>
<p>Maximum height of the menu before scrolling</p>
<h4 id="inherited-from_43">Inherited from<a class="headerlink" href="#inherited-from_43" title="Permanent link">#</a></h4>
<h4 id="inherited-from_44">Inherited from<a class="headerlink" href="#inherited-from_44" title="Permanent link">#</a></h4>
<p>Omit.maxMenuHeight</p>
<hr />
<h3 id="menuclass">menuClass<a class="headerlink" href="#menuclass" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>menuClass</strong>: <code>string</code></p>
<h4 id="inherited-from_44">Inherited from<a class="headerlink" href="#inherited-from_44" title="Permanent link">#</a></h4>
<h4 id="inherited-from_45">Inherited from<a class="headerlink" href="#inherited-from_45" title="Permanent link">#</a></h4>
<p>Omit.menuClass</p>
<hr />
<h3 id="menuisopen">menuIsOpen<a class="headerlink" href="#menuisopen" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>menuIsOpen</strong>: <code>boolean</code></p>
<p>Whether the menu is open</p>
<h4 id="inherited-from_45">Inherited from<a class="headerlink" href="#inherited-from_45" title="Permanent link">#</a></h4>
<h4 id="inherited-from_46">Inherited from<a class="headerlink" href="#inherited-from_46" title="Permanent link">#</a></h4>
<p>Omit.menuIsOpen</p>
<hr />
<h3 id="menuplacement">menuPlacement<a class="headerlink" href="#menuplacement" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>menuPlacement</strong>: <code>MenuPlacement</code></p>
<p>Default placement of the menu in relation to the control. 'auto' will flip
when there isn't enough space below the control.</p>
<h4 id="inherited-from_46">Inherited from<a class="headerlink" href="#inherited-from_46" title="Permanent link">#</a></h4>
<h4 id="inherited-from_47">Inherited from<a class="headerlink" href="#inherited-from_47" title="Permanent link">#</a></h4>
<p>Omit.menuPlacement</p>
<hr />
<h3 id="menuportaltarget">menuPortalTarget<a class="headerlink" href="#menuportaltarget" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>menuPortalTarget</strong>: <code>null</code> | <code>HTMLElement</code></p>
<p>Whether the menu should use a portal, and where it should attach</p>
<p>An example can be found in the <a href="/advanced#portaling">Portaling</a> documentation</p>
<h4 id="inherited-from_47">Inherited from<a class="headerlink" href="#inherited-from_47" title="Permanent link">#</a></h4>
<h4 id="inherited-from_48">Inherited from<a class="headerlink" href="#inherited-from_48" title="Permanent link">#</a></h4>
<p>Omit.menuPortalTarget</p>
<hr />
<h3 id="menuposition">menuPosition<a class="headerlink" href="#menuposition" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>menuPosition</strong>: <code>MenuPosition</code></p>
<p>The CSS position value of the menu, when "fixed" extra layout management is required</p>
<h4 id="inherited-from_48">Inherited from<a class="headerlink" href="#inherited-from_48" title="Permanent link">#</a></h4>
<h4 id="inherited-from_49">Inherited from<a class="headerlink" href="#inherited-from_49" title="Permanent link">#</a></h4>
<p>Omit.menuPosition</p>
<hr />
<h3 id="menushouldblockscroll">menuShouldBlockScroll<a class="headerlink" href="#menushouldblockscroll" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>menuShouldBlockScroll</strong>: <code>boolean</code></p>
<p>Whether to block scroll events when the menu is open</p>
<h4 id="inherited-from_49">Inherited from<a class="headerlink" href="#inherited-from_49" title="Permanent link">#</a></h4>
<h4 id="inherited-from_50">Inherited from<a class="headerlink" href="#inherited-from_50" title="Permanent link">#</a></h4>
<p>Omit.menuShouldBlockScroll</p>
<hr />
<h3 id="menushouldscrollintoview">menuShouldScrollIntoView<a class="headerlink" href="#menushouldscrollintoview" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>menuShouldScrollIntoView</strong>: <code>boolean</code></p>
<p>Whether the menu should be scrolled into view when it opens</p>
<h4 id="inherited-from_50">Inherited from<a class="headerlink" href="#inherited-from_50" title="Permanent link">#</a></h4>
<h4 id="inherited-from_51">Inherited from<a class="headerlink" href="#inherited-from_51" title="Permanent link">#</a></h4>
<p>Omit.menuShouldScrollIntoView</p>
<hr />
<h3 id="minmenuheight">minMenuHeight<a class="headerlink" href="#minmenuheight" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>minMenuHeight</strong>: <code>number</code></p>
<p>Minimum height of the menu before flipping</p>
<h4 id="inherited-from_51">Inherited from<a class="headerlink" href="#inherited-from_51" title="Permanent link">#</a></h4>
<h4 id="inherited-from_52">Inherited from<a class="headerlink" href="#inherited-from_52" title="Permanent link">#</a></h4>
<p>Omit.minMenuHeight</p>
<hr />
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>name</strong>: <code>string</code></p>
<p>Name of the HTML Input (optional - without this, no input will be rendered)</p>
<h4 id="inherited-from_52">Inherited from<a class="headerlink" href="#inherited-from_52" title="Permanent link">#</a></h4>
<h4 id="inherited-from_53">Inherited from<a class="headerlink" href="#inherited-from_53" title="Permanent link">#</a></h4>
<p>Omit.name</p>
<hr />
<h3 id="nooptionsmessage">noOptionsMessage<a class="headerlink" href="#nooptionsmessage" title="Permanent link">#</a></h3>
@ -1908,13 +1930,13 @@ when there isn't enough space below the control.</p>
</table>
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
<p><code>ReactNode</code></p>
<h4 id="inherited-from_53">Inherited from<a class="headerlink" href="#inherited-from_53" title="Permanent link">#</a></h4>
<h4 id="inherited-from_54">Inherited from<a class="headerlink" href="#inherited-from_54" title="Permanent link">#</a></h4>
<p>Omit.noOptionsMessage</p>
<hr />
<h3 id="onblur">onBlur<a class="headerlink" href="#onblur" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>onBlur</strong>: <code>FocusEventHandler</code>&lt;<code>HTMLInputElement</code>></p>
<p>Handle blur events on the control</p>
<h4 id="inherited-from_54">Inherited from<a class="headerlink" href="#inherited-from_54" title="Permanent link">#</a></h4>
<h4 id="inherited-from_55">Inherited from<a class="headerlink" href="#inherited-from_55" title="Permanent link">#</a></h4>
<p>Omit.onBlur</p>
<hr />
<h3 id="onchange">onChange<a class="headerlink" href="#onchange" title="Permanent link">#</a></h3>
@ -1943,13 +1965,13 @@ when there isn't enough space below the control.</p>
</table>
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_55">Inherited from<a class="headerlink" href="#inherited-from_55" title="Permanent link">#</a></h4>
<h4 id="inherited-from_56">Inherited from<a class="headerlink" href="#inherited-from_56" title="Permanent link">#</a></h4>
<p>Omit.onChange</p>
<hr />
<h3 id="onfocus">onFocus<a class="headerlink" href="#onfocus" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>onFocus</strong>: <code>FocusEventHandler</code>&lt;<code>HTMLInputElement</code>></p>
<p>Handle focus events on the control</p>
<h4 id="inherited-from_56">Inherited from<a class="headerlink" href="#inherited-from_56" title="Permanent link">#</a></h4>
<h4 id="inherited-from_57">Inherited from<a class="headerlink" href="#inherited-from_57" title="Permanent link">#</a></h4>
<p>Omit.onFocus</p>
<hr />
<h3 id="oninputchange">onInputChange<a class="headerlink" href="#oninputchange" title="Permanent link">#</a></h3>
@ -1978,13 +2000,13 @@ when there isn't enough space below the control.</p>
</table>
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_57">Inherited from<a class="headerlink" href="#inherited-from_57" title="Permanent link">#</a></h4>
<h4 id="inherited-from_58">Inherited from<a class="headerlink" href="#inherited-from_58" title="Permanent link">#</a></h4>
<p>Omit.onInputChange</p>
<hr />
<h3 id="onkeydown">onKeyDown<a class="headerlink" href="#onkeydown" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>onKeyDown</strong>: <code>KeyboardEventHandler</code>&lt;<code>HTMLDivElement</code>></p>
<p>Handle key down events on the select</p>
<h4 id="inherited-from_58">Inherited from<a class="headerlink" href="#inherited-from_58" title="Permanent link">#</a></h4>
<h4 id="inherited-from_59">Inherited from<a class="headerlink" href="#inherited-from_59" title="Permanent link">#</a></h4>
<p>Omit.onKeyDown</p>
<hr />
<h3 id="onmenuclose">onMenuClose<a class="headerlink" href="#onmenuclose" title="Permanent link">#</a></h3>
@ -1994,7 +2016,7 @@ when there isn't enough space below the control.</p>
<p>Handle the menu closing</p>
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_59">Inherited from<a class="headerlink" href="#inherited-from_59" title="Permanent link">#</a></h4>
<h4 id="inherited-from_60">Inherited from<a class="headerlink" href="#inherited-from_60" title="Permanent link">#</a></h4>
<p>Omit.onMenuClose</p>
<hr />
<h3 id="onmenuopen">onMenuOpen<a class="headerlink" href="#onmenuopen" title="Permanent link">#</a></h3>
@ -2004,7 +2026,7 @@ when there isn't enough space below the control.</p>
<p>Handle the menu opening</p>
<h5 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_60">Inherited from<a class="headerlink" href="#inherited-from_60" title="Permanent link">#</a></h4>
<h4 id="inherited-from_61">Inherited from<a class="headerlink" href="#inherited-from_61" title="Permanent link">#</a></h4>
<p>Omit.onMenuOpen</p>
<hr />
<h3 id="onmenuscrolltobottom">onMenuScrollToBottom<a class="headerlink" href="#onmenuscrolltobottom" title="Permanent link">#</a></h3>
@ -2029,7 +2051,7 @@ when there isn't enough space below the control.</p>
</table>
<h5 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_61">Inherited from<a class="headerlink" href="#inherited-from_61" title="Permanent link">#</a></h4>
<h4 id="inherited-from_62">Inherited from<a class="headerlink" href="#inherited-from_62" title="Permanent link">#</a></h4>
<p>Omit.onMenuScrollToBottom</p>
<hr />
<h3 id="onmenuscrolltotop">onMenuScrollToTop<a class="headerlink" href="#onmenuscrolltotop" title="Permanent link">#</a></h3>
@ -2054,37 +2076,37 @@ when there isn't enough space below the control.</p>
</table>
<h5 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_62">Inherited from<a class="headerlink" href="#inherited-from_62" title="Permanent link">#</a></h4>
<h4 id="inherited-from_63">Inherited from<a class="headerlink" href="#inherited-from_63" title="Permanent link">#</a></h4>
<p>Omit.onMenuScrollToTop</p>
<hr />
<h3 id="openmenuonclick">openMenuOnClick<a class="headerlink" href="#openmenuonclick" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>openMenuOnClick</strong>: <code>boolean</code></p>
<p>Allows control of whether the menu is opened when the Select is clicked</p>
<h4 id="inherited-from_63">Inherited from<a class="headerlink" href="#inherited-from_63" title="Permanent link">#</a></h4>
<h4 id="inherited-from_64">Inherited from<a class="headerlink" href="#inherited-from_64" title="Permanent link">#</a></h4>
<p>Omit.openMenuOnClick</p>
<hr />
<h3 id="openmenuonfocus">openMenuOnFocus<a class="headerlink" href="#openmenuonfocus" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>openMenuOnFocus</strong>: <code>boolean</code></p>
<p>Allows control of whether the menu is opened when the Select is focused</p>
<h4 id="inherited-from_64">Inherited from<a class="headerlink" href="#inherited-from_64" title="Permanent link">#</a></h4>
<h4 id="inherited-from_65">Inherited from<a class="headerlink" href="#inherited-from_65" title="Permanent link">#</a></h4>
<p>Omit.openMenuOnFocus</p>
<hr />
<h3 id="pagesize">pageSize<a class="headerlink" href="#pagesize" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>pageSize</strong>: <code>number</code></p>
<p>Number of options to jump in menu when page{up|down} keys are used</p>
<h4 id="inherited-from_65">Inherited from<a class="headerlink" href="#inherited-from_65" title="Permanent link">#</a></h4>
<h4 id="inherited-from_66">Inherited from<a class="headerlink" href="#inherited-from_66" title="Permanent link">#</a></h4>
<p>Omit.pageSize</p>
<hr />
<h3 id="placeholder">placeholder<a class="headerlink" href="#placeholder" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>placeholder</strong>: <code>ReactNode</code></p>
<p>Placeholder for the select value</p>
<h4 id="inherited-from_66">Inherited from<a class="headerlink" href="#inherited-from_66" title="Permanent link">#</a></h4>
<h4 id="inherited-from_67">Inherited from<a class="headerlink" href="#inherited-from_67" title="Permanent link">#</a></h4>
<p>Omit.placeholder</p>
<hr />
<h3 id="required">required<a class="headerlink" href="#required" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>required</strong>: <code>boolean</code></p>
<p>Marks the value-holding input as required for form validation</p>
<h4 id="inherited-from_67">Inherited from<a class="headerlink" href="#inherited-from_67" title="Permanent link">#</a></h4>
<h4 id="inherited-from_68">Inherited from<a class="headerlink" href="#inherited-from_68" title="Permanent link">#</a></h4>
<p>Omit.required</p>
<hr />
<h3 id="screenreaderstatus">screenReaderStatus<a class="headerlink" href="#screenreaderstatus" title="Permanent link">#</a></h3>
@ -2113,7 +2135,7 @@ when there isn't enough space below the control.</p>
</table>
<h5 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h5>
<p><code>string</code></p>
<h4 id="inherited-from_68">Inherited from<a class="headerlink" href="#inherited-from_68" title="Permanent link">#</a></h4>
<h4 id="inherited-from_69">Inherited from<a class="headerlink" href="#inherited-from_69" title="Permanent link">#</a></h4>
<p>Omit.screenReaderStatus</p>
<hr />
<h3 id="showicons">showIcons<a class="headerlink" href="#showicons" title="Permanent link">#</a></h3>
@ -2126,32 +2148,38 @@ when there isn't enough space below the control.</p>
<p>• <code>Optional</code> <strong>styles</strong>: <code>StylesConfig</code>&lt;{ <code>label</code>: <code>string</code> ; <code>value</code>: <code>string</code> }, <code>IsMulti</code>, <code>GroupBase</code>&lt;{ <code>label</code>: <code>string</code> ; <code>value</code>: <code>string</code> }>></p>
<p>Style modifier methods</p>
<p>A basic example can be found at the bottom of the <a href="/advanced#replacing-builtins">Replacing builtins</a> documentation.</p>
<h4 id="inherited-from_69">Inherited from<a class="headerlink" href="#inherited-from_69" title="Permanent link">#</a></h4>
<h4 id="inherited-from_70">Inherited from<a class="headerlink" href="#inherited-from_70" title="Permanent link">#</a></h4>
<p>Omit.styles</p>
<hr />
<h3 id="tabindex">tabIndex<a class="headerlink" href="#tabindex" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>tabIndex</strong>: <code>number</code></p>
<p>Sets the tabIndex attribute on the input</p>
<h4 id="inherited-from_70">Inherited from<a class="headerlink" href="#inherited-from_70" title="Permanent link">#</a></h4>
<h4 id="inherited-from_71">Inherited from<a class="headerlink" href="#inherited-from_71" title="Permanent link">#</a></h4>
<p>Omit.tabIndex</p>
<hr />
<h3 id="tabselectsvalue">tabSelectsValue<a class="headerlink" href="#tabselectsvalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>tabSelectsValue</strong>: <code>boolean</code></p>
<p>Select the currently focused option when the user presses tab</p>
<h4 id="inherited-from_71">Inherited from<a class="headerlink" href="#inherited-from_71" title="Permanent link">#</a></h4>
<h4 id="inherited-from_72">Inherited from<a class="headerlink" href="#inherited-from_72" title="Permanent link">#</a></h4>
<p>Omit.tabSelectsValue</p>
<hr />
<h3 id="theme">theme<a class="headerlink" href="#theme" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>theme</strong>: <code>ThemeConfig</code></p>
<p>Theme modifier method</p>
<h4 id="inherited-from_72">Inherited from<a class="headerlink" href="#inherited-from_72" title="Permanent link">#</a></h4>
<h4 id="inherited-from_73">Inherited from<a class="headerlink" href="#inherited-from_73" title="Permanent link">#</a></h4>
<p>Omit.theme</p>
<hr />
<h3 id="themename">themeName<a class="headerlink" href="#themename" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>themeName</strong>: <code>"dark"</code> | <code>"light"</code> | <code>"lens"</code> | <code>"outlined"</code></p>
<h4 id="inherited-from_73">Inherited from<a class="headerlink" href="#inherited-from_73" title="Permanent link">#</a></h4>
<h4 id="inherited-from_74">Inherited from<a class="headerlink" href="#inherited-from_74" title="Permanent link">#</a></h4>
<p>Omit.themeName</p>
<hr />
<h3 id="unstyled">unstyled<a class="headerlink" href="#unstyled" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>unstyled</strong>: <code>boolean</code></p>
<p>Remove all non-essential styles</p>
<h4 id="inherited-from_75">Inherited from<a class="headerlink" href="#inherited-from_75" title="Permanent link">#</a></h4>
<p>Omit.unstyled</p>
<hr />
<h3 id="value">value<a class="headerlink" href="#value" title="Permanent link">#</a></h3>
<p>• <strong>value</strong>: <code>undefined</code> | <code>null</code> | <code>string</code></p>

142
master/extensions/api/interfaces/Renderer.Component.SelectProps/index.html
View File

@ -842,6 +842,13 @@
classNamePrefix
</a>
</li>
<li class="md-nav__item">
<a href="#classnames" class="md-nav__link">
classNames
</a>
</li>
<li class="md-nav__item">
@ -1276,6 +1283,13 @@
themeName
</a>
</li>
<li class="md-nav__item">
<a href="#unstyled" class="md-nav__link">
unstyled
</a>
</li>
<li class="md-nav__item">
@ -1354,6 +1368,7 @@
<li><a href="./#capturemenuscroll">captureMenuScroll</a></li>
<li><a href="./#classname">className</a></li>
<li><a href="./#classnameprefix">classNamePrefix</a></li>
<li><a href="./#classnames">classNames</a></li>
<li><a href="./#closemenuonscroll">closeMenuOnScroll</a></li>
<li><a href="./#closemenuonselect">closeMenuOnSelect</a></li>
<li><a href="./#components">components</a></li>
@ -1416,6 +1431,7 @@
<li><a href="./#tabselectsvalue">tabSelectsValue</a></li>
<li><a href="./#theme">theme</a></li>
<li><a href="./#themename">themeName</a></li>
<li><a href="./#unstyled">unstyled</a></li>
<li><a href="./#value">value</a></li>
</ul>
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
@ -1497,6 +1513,12 @@
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<p>Omit.classNamePrefix</p>
<hr />
<h3 id="classnames">classNames<a class="headerlink" href="#classnames" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>classNames</strong>: <code>ClassNamesConfig</code>&lt;<code>Option</code>, <code>IsMulti</code>, <code>Group</code>></p>
<p>Provide classNames based on state for each inner component</p>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<p>Omit.classNames</p>
<hr />
<h3 id="closemenuonscroll">closeMenuOnScroll<a class="headerlink" href="#closemenuonscroll" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>closeMenuOnScroll</strong>: <code>boolean</code> | (<code>event</code>: <code>Event</code>) =&gt; <code>boolean</code></p>
<p>If <code>true</code>, close the select menu when the user scrolls the document/body.</p>
@ -1505,13 +1527,13 @@
<p><code>false</code> =&gt; The menu stays open</p>
<p>This is useful when you have a scrollable modal and want to portal the menu out,
but want to avoid graphical issues.</p>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<p>Omit.closeMenuOnScroll</p>
<hr />
<h3 id="closemenuonselect">closeMenuOnSelect<a class="headerlink" href="#closemenuonselect" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>closeMenuOnSelect</strong>: <code>boolean</code></p>
<p>Close the select menu when the user selects an option</p>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<p>Omit.closeMenuOnSelect</p>
<hr />
<h3 id="components">components<a class="headerlink" href="#components" title="Permanent link">#</a></h3>
@ -1522,52 +1544,52 @@ with the appropriate namespace.</p>
<p>If you only wish to restyle a component, we recommend using the <code>styles</code> prop
instead. For a list of the components that can be passed in, and the shape
that will be passed to them, see <a href="/components">the components docs</a></p>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<p>Omit.components</p>
<hr />
<h3 id="controlshouldrendervalue">controlShouldRenderValue<a class="headerlink" href="#controlshouldrendervalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>controlShouldRenderValue</strong>: <code>boolean</code></p>
<p>Whether the value of the select, e.g. SingleValue, should be displayed in the control.</p>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
<p>Omit.controlShouldRenderValue</p>
<hr />
<h3 id="defaultinputvalue">defaultInputValue<a class="headerlink" href="#defaultinputvalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>defaultInputValue</strong>: <code>string</code></p>
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
<p>Omit.defaultInputValue</p>
<hr />
<h3 id="defaultmenuisopen">defaultMenuIsOpen<a class="headerlink" href="#defaultmenuisopen" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>defaultMenuIsOpen</strong>: <code>boolean</code></p>
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
<p>Omit.defaultMenuIsOpen</p>
<hr />
<h3 id="defaultvalue">defaultValue<a class="headerlink" href="#defaultvalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>defaultValue</strong>: <code>PropsValue</code>&lt;<code>Option</code>></p>
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
<p>Omit.defaultValue</p>
<hr />
<h3 id="delimiter">delimiter<a class="headerlink" href="#delimiter" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>delimiter</strong>: <code>string</code></p>
<p>Delimiter used to join multiple values into a single HTML Input value</p>
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
<p>Omit.delimiter</p>
<hr />
<h3 id="escapeclearsvalue">escapeClearsValue<a class="headerlink" href="#escapeclearsvalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>escapeClearsValue</strong>: <code>boolean</code></p>
<p>Clear all values when the user presses escape AND the menu is closed</p>
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
<p>Omit.escapeClearsValue</p>
<hr />
<h3 id="filteroption">filterOption<a class="headerlink" href="#filteroption" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>filterOption</strong>: <code>null</code> | (<code>option</code>: <code>FilterOptionOption</code>&lt;<code>Option</code>>, <code>inputValue</code>: <code>string</code>) =&gt; <code>boolean</code></p>
<p>Custom method to filter whether an option should be displayed in the menu</p>
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
<p>Omit.filterOption</p>
<hr />
<h3 id="form">form<a class="headerlink" href="#form" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>form</strong>: <code>string</code></p>
<p>Sets the form attribute on the input</p>
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
<p>Omit.form</p>
<hr />
<h3 id="formatgrouplabel">formatGroupLabel<a class="headerlink" href="#formatgrouplabel" title="Permanent link">#</a></h3>
@ -1593,7 +1615,7 @@ that will be passed to them, see <a href="/components">the components docs</a></
</table>
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
<p><code>ReactNode</code></p>
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
<p>Omit.formatGroupLabel</p>
<hr />
<h3 id="formatoptionlabel">formatOptionLabel<a class="headerlink" href="#formatoptionlabel" title="Permanent link">#</a></h3>
@ -1622,7 +1644,7 @@ that will be passed to them, see <a href="/components">the components docs</a></
</table>
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
<p><code>ReactNode</code></p>
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
<p>Omit.formatOptionLabel</p>
<hr />
<h3 id="getoptionlabel">getOptionLabel<a class="headerlink" href="#getoptionlabel" title="Permanent link">#</a></h3>
@ -1630,19 +1652,19 @@ that will be passed to them, see <a href="/components">the components docs</a></
<p>Resolves option data to a string to be displayed as the label by components</p>
<p>Note: Failure to resolve to a string type can interfere with filtering and
screen reader support.</p>
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
<p>Omit.getOptionLabel</p>
<hr />
<h3 id="getoptionvalue">getOptionValue<a class="headerlink" href="#getoptionvalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>getOptionValue</strong>: <code>GetOptionValue</code>&lt;<code>Option</code>></p>
<p>Resolves option data to a string to compare options and specify value attributes</p>
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
<p>Omit.getOptionValue</p>
<hr />
<h3 id="hideselectedoptions">hideSelectedOptions<a class="headerlink" href="#hideselectedoptions" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>hideSelectedOptions</strong>: <code>boolean</code></p>
<p>Hide the selected option from the menu</p>
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
<p>Omit.hideSelectedOptions</p>
<hr />
<h3 id="id">id<a class="headerlink" href="#id" title="Permanent link">#</a></h3>
@ -1653,25 +1675,25 @@ screen reader support.</p>
<h3 id="inputid">inputId<a class="headerlink" href="#inputid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>inputId</strong>: <code>string</code></p>
<p>The id of the search input</p>
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
<p>Omit.inputId</p>
<hr />
<h3 id="inputvalue">inputValue<a class="headerlink" href="#inputvalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>inputValue</strong>: <code>string</code></p>
<p>The value of the search input</p>
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
<p>Omit.inputValue</p>
<hr />
<h3 id="instanceid">instanceId<a class="headerlink" href="#instanceid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>instanceId</strong>: <code>string</code> | <code>number</code></p>
<p>Define an id prefix for the select components e.g. {your-id}-value</p>
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
<p>Omit.instanceId</p>
<hr />
<h3 id="isclearable">isClearable<a class="headerlink" href="#isclearable" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isClearable</strong>: <code>boolean</code></p>
<p>Is the select value clearable</p>
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
<p>Omit.isClearable</p>
<hr />
<h3 id="iscreatable">isCreatable<a class="headerlink" href="#iscreatable" title="Permanent link">#</a></h3>
@ -1682,19 +1704,19 @@ screen reader support.</p>
<h3 id="isdisabled">isDisabled<a class="headerlink" href="#isdisabled" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isDisabled</strong>: <code>boolean</code></p>
<p>Is the select disabled</p>
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
<h4 id="inherited-from_33">Inherited from<a class="headerlink" href="#inherited-from_33" title="Permanent link">#</a></h4>
<p>Omit.isDisabled</p>
<hr />
<h3 id="isloading">isLoading<a class="headerlink" href="#isloading" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isLoading</strong>: <code>boolean</code></p>
<p>Is the select in a state of loading (async)</p>
<h4 id="inherited-from_33">Inherited from<a class="headerlink" href="#inherited-from_33" title="Permanent link">#</a></h4>
<h4 id="inherited-from_34">Inherited from<a class="headerlink" href="#inherited-from_34" title="Permanent link">#</a></h4>
<p>Omit.isLoading</p>
<hr />
<h3 id="ismulti">isMulti<a class="headerlink" href="#ismulti" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isMulti</strong>: <code>IsMulti</code></p>
<p>Support multiple selected options</p>
<h4 id="inherited-from_34">Inherited from<a class="headerlink" href="#inherited-from_34" title="Permanent link">#</a></h4>
<h4 id="inherited-from_35">Inherited from<a class="headerlink" href="#inherited-from_35" title="Permanent link">#</a></h4>
<p>Omit.isMulti</p>
<hr />
<h3 id="isoptiondisabled">isOptionDisabled<a class="headerlink" href="#isoptiondisabled" title="Permanent link">#</a></h3>
@ -1724,7 +1746,7 @@ screen reader support.</p>
</table>
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
<p><code>boolean</code></p>
<h4 id="inherited-from_35">Inherited from<a class="headerlink" href="#inherited-from_35" title="Permanent link">#</a></h4>
<h4 id="inherited-from_36">Inherited from<a class="headerlink" href="#inherited-from_36" title="Permanent link">#</a></h4>
<p>Omit.isOptionDisabled</p>
<hr />
<h3 id="isoptionselected">isOptionSelected<a class="headerlink" href="#isoptionselected" title="Permanent link">#</a></h3>
@ -1753,19 +1775,19 @@ screen reader support.</p>
</table>
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
<p><code>boolean</code></p>
<h4 id="inherited-from_36">Inherited from<a class="headerlink" href="#inherited-from_36" title="Permanent link">#</a></h4>
<h4 id="inherited-from_37">Inherited from<a class="headerlink" href="#inherited-from_37" title="Permanent link">#</a></h4>
<p>Omit.isOptionSelected</p>
<hr />
<h3 id="isrtl">isRtl<a class="headerlink" href="#isrtl" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isRtl</strong>: <code>boolean</code></p>
<p>Is the select direction right-to-left</p>
<h4 id="inherited-from_37">Inherited from<a class="headerlink" href="#inherited-from_37" title="Permanent link">#</a></h4>
<h4 id="inherited-from_38">Inherited from<a class="headerlink" href="#inherited-from_38" title="Permanent link">#</a></h4>
<p>Omit.isRtl</p>
<hr />
<h3 id="issearchable">isSearchable<a class="headerlink" href="#issearchable" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isSearchable</strong>: <code>boolean</code></p>
<p>Whether to enable search functionality</p>
<h4 id="inherited-from_38">Inherited from<a class="headerlink" href="#inherited-from_38" title="Permanent link">#</a></h4>
<h4 id="inherited-from_39">Inherited from<a class="headerlink" href="#inherited-from_39" title="Permanent link">#</a></h4>
<p>Omit.isSearchable</p>
<hr />
<h3 id="loadingmessage">loadingMessage<a class="headerlink" href="#loadingmessage" title="Permanent link">#</a></h3>
@ -1794,13 +1816,13 @@ screen reader support.</p>
</table>
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
<p><code>ReactNode</code></p>
<h4 id="inherited-from_39">Inherited from<a class="headerlink" href="#inherited-from_39" title="Permanent link">#</a></h4>
<h4 id="inherited-from_40">Inherited from<a class="headerlink" href="#inherited-from_40" title="Permanent link">#</a></h4>
<p>Omit.loadingMessage</p>
<hr />
<h3 id="maxmenuheight">maxMenuHeight<a class="headerlink" href="#maxmenuheight" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>maxMenuHeight</strong>: <code>number</code></p>
<p>Maximum height of the menu before scrolling</p>
<h4 id="inherited-from_40">Inherited from<a class="headerlink" href="#inherited-from_40" title="Permanent link">#</a></h4>
<h4 id="inherited-from_41">Inherited from<a class="headerlink" href="#inherited-from_41" title="Permanent link">#</a></h4>
<p>Omit.maxMenuHeight</p>
<hr />
<h3 id="menuclass">menuClass<a class="headerlink" href="#menuclass" title="Permanent link">#</a></h3>
@ -1809,51 +1831,51 @@ screen reader support.</p>
<h3 id="menuisopen">menuIsOpen<a class="headerlink" href="#menuisopen" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>menuIsOpen</strong>: <code>boolean</code></p>
<p>Whether the menu is open</p>
<h4 id="inherited-from_41">Inherited from<a class="headerlink" href="#inherited-from_41" title="Permanent link">#</a></h4>
<h4 id="inherited-from_42">Inherited from<a class="headerlink" href="#inherited-from_42" title="Permanent link">#</a></h4>
<p>Omit.menuIsOpen</p>
<hr />
<h3 id="menuplacement">menuPlacement<a class="headerlink" href="#menuplacement" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>menuPlacement</strong>: <code>MenuPlacement</code></p>
<p>Default placement of the menu in relation to the control. 'auto' will flip
when there isn't enough space below the control.</p>
<h4 id="inherited-from_42">Inherited from<a class="headerlink" href="#inherited-from_42" title="Permanent link">#</a></h4>
<h4 id="inherited-from_43">Inherited from<a class="headerlink" href="#inherited-from_43" title="Permanent link">#</a></h4>
<p>Omit.menuPlacement</p>
<hr />
<h3 id="menuportaltarget">menuPortalTarget<a class="headerlink" href="#menuportaltarget" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>menuPortalTarget</strong>: <code>null</code> | <code>HTMLElement</code></p>
<p>Whether the menu should use a portal, and where it should attach</p>
<p>An example can be found in the <a href="/advanced#portaling">Portaling</a> documentation</p>
<h4 id="inherited-from_43">Inherited from<a class="headerlink" href="#inherited-from_43" title="Permanent link">#</a></h4>
<h4 id="inherited-from_44">Inherited from<a class="headerlink" href="#inherited-from_44" title="Permanent link">#</a></h4>
<p>Omit.menuPortalTarget</p>
<hr />
<h3 id="menuposition">menuPosition<a class="headerlink" href="#menuposition" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>menuPosition</strong>: <code>MenuPosition</code></p>
<p>The CSS position value of the menu, when "fixed" extra layout management is required</p>
<h4 id="inherited-from_44">Inherited from<a class="headerlink" href="#inherited-from_44" title="Permanent link">#</a></h4>
<h4 id="inherited-from_45">Inherited from<a class="headerlink" href="#inherited-from_45" title="Permanent link">#</a></h4>
<p>Omit.menuPosition</p>
<hr />
<h3 id="menushouldblockscroll">menuShouldBlockScroll<a class="headerlink" href="#menushouldblockscroll" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>menuShouldBlockScroll</strong>: <code>boolean</code></p>
<p>Whether to block scroll events when the menu is open</p>
<h4 id="inherited-from_45">Inherited from<a class="headerlink" href="#inherited-from_45" title="Permanent link">#</a></h4>
<h4 id="inherited-from_46">Inherited from<a class="headerlink" href="#inherited-from_46" title="Permanent link">#</a></h4>
<p>Omit.menuShouldBlockScroll</p>
<hr />
<h3 id="menushouldscrollintoview">menuShouldScrollIntoView<a class="headerlink" href="#menushouldscrollintoview" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>menuShouldScrollIntoView</strong>: <code>boolean</code></p>
<p>Whether the menu should be scrolled into view when it opens</p>
<h4 id="inherited-from_46">Inherited from<a class="headerlink" href="#inherited-from_46" title="Permanent link">#</a></h4>
<h4 id="inherited-from_47">Inherited from<a class="headerlink" href="#inherited-from_47" title="Permanent link">#</a></h4>
<p>Omit.menuShouldScrollIntoView</p>
<hr />
<h3 id="minmenuheight">minMenuHeight<a class="headerlink" href="#minmenuheight" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>minMenuHeight</strong>: <code>number</code></p>
<p>Minimum height of the menu before flipping</p>
<h4 id="inherited-from_47">Inherited from<a class="headerlink" href="#inherited-from_47" title="Permanent link">#</a></h4>
<h4 id="inherited-from_48">Inherited from<a class="headerlink" href="#inherited-from_48" title="Permanent link">#</a></h4>
<p>Omit.minMenuHeight</p>
<hr />
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>name</strong>: <code>string</code></p>
<p>Name of the HTML Input (optional - without this, no input will be rendered)</p>
<h4 id="inherited-from_48">Inherited from<a class="headerlink" href="#inherited-from_48" title="Permanent link">#</a></h4>
<h4 id="inherited-from_49">Inherited from<a class="headerlink" href="#inherited-from_49" title="Permanent link">#</a></h4>
<p>Omit.name</p>
<hr />
<h3 id="nooptionsmessage">noOptionsMessage<a class="headerlink" href="#nooptionsmessage" title="Permanent link">#</a></h3>
@ -1882,13 +1904,13 @@ when there isn't enough space below the control.</p>
</table>
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
<p><code>ReactNode</code></p>
<h4 id="inherited-from_49">Inherited from<a class="headerlink" href="#inherited-from_49" title="Permanent link">#</a></h4>
<h4 id="inherited-from_50">Inherited from<a class="headerlink" href="#inherited-from_50" title="Permanent link">#</a></h4>
<p>Omit.noOptionsMessage</p>
<hr />
<h3 id="onblur">onBlur<a class="headerlink" href="#onblur" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>onBlur</strong>: <code>FocusEventHandler</code>&lt;<code>HTMLInputElement</code>></p>
<p>Handle blur events on the control</p>
<h4 id="inherited-from_50">Inherited from<a class="headerlink" href="#inherited-from_50" title="Permanent link">#</a></h4>
<h4 id="inherited-from_51">Inherited from<a class="headerlink" href="#inherited-from_51" title="Permanent link">#</a></h4>
<p>Omit.onBlur</p>
<hr />
<h3 id="onchange">onChange<a class="headerlink" href="#onchange" title="Permanent link">#</a></h3>
@ -1917,13 +1939,13 @@ when there isn't enough space below the control.</p>
</table>
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_51">Inherited from<a class="headerlink" href="#inherited-from_51" title="Permanent link">#</a></h4>
<h4 id="inherited-from_52">Inherited from<a class="headerlink" href="#inherited-from_52" title="Permanent link">#</a></h4>
<p>Omit.onChange</p>
<hr />
<h3 id="onfocus">onFocus<a class="headerlink" href="#onfocus" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>onFocus</strong>: <code>FocusEventHandler</code>&lt;<code>HTMLInputElement</code>></p>
<p>Handle focus events on the control</p>
<h4 id="inherited-from_52">Inherited from<a class="headerlink" href="#inherited-from_52" title="Permanent link">#</a></h4>
<h4 id="inherited-from_53">Inherited from<a class="headerlink" href="#inherited-from_53" title="Permanent link">#</a></h4>
<p>Omit.onFocus</p>
<hr />
<h3 id="oninputchange">onInputChange<a class="headerlink" href="#oninputchange" title="Permanent link">#</a></h3>
@ -1952,13 +1974,13 @@ when there isn't enough space below the control.</p>
</table>
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_53">Inherited from<a class="headerlink" href="#inherited-from_53" title="Permanent link">#</a></h4>
<h4 id="inherited-from_54">Inherited from<a class="headerlink" href="#inherited-from_54" title="Permanent link">#</a></h4>
<p>Omit.onInputChange</p>
<hr />
<h3 id="onkeydown">onKeyDown<a class="headerlink" href="#onkeydown" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>onKeyDown</strong>: <code>KeyboardEventHandler</code>&lt;<code>HTMLDivElement</code>></p>
<p>Handle key down events on the select</p>
<h4 id="inherited-from_54">Inherited from<a class="headerlink" href="#inherited-from_54" title="Permanent link">#</a></h4>
<h4 id="inherited-from_55">Inherited from<a class="headerlink" href="#inherited-from_55" title="Permanent link">#</a></h4>
<p>Omit.onKeyDown</p>
<hr />
<h3 id="onmenuclose">onMenuClose<a class="headerlink" href="#onmenuclose" title="Permanent link">#</a></h3>
@ -1968,7 +1990,7 @@ when there isn't enough space below the control.</p>
<p>Handle the menu closing</p>
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_55">Inherited from<a class="headerlink" href="#inherited-from_55" title="Permanent link">#</a></h4>
<h4 id="inherited-from_56">Inherited from<a class="headerlink" href="#inherited-from_56" title="Permanent link">#</a></h4>
<p>Omit.onMenuClose</p>
<hr />
<h3 id="onmenuopen">onMenuOpen<a class="headerlink" href="#onmenuopen" title="Permanent link">#</a></h3>
@ -1978,7 +2000,7 @@ when there isn't enough space below the control.</p>
<p>Handle the menu opening</p>
<h5 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_56">Inherited from<a class="headerlink" href="#inherited-from_56" title="Permanent link">#</a></h4>
<h4 id="inherited-from_57">Inherited from<a class="headerlink" href="#inherited-from_57" title="Permanent link">#</a></h4>
<p>Omit.onMenuOpen</p>
<hr />
<h3 id="onmenuscrolltobottom">onMenuScrollToBottom<a class="headerlink" href="#onmenuscrolltobottom" title="Permanent link">#</a></h3>
@ -2003,7 +2025,7 @@ when there isn't enough space below the control.</p>
</table>
<h5 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_57">Inherited from<a class="headerlink" href="#inherited-from_57" title="Permanent link">#</a></h4>
<h4 id="inherited-from_58">Inherited from<a class="headerlink" href="#inherited-from_58" title="Permanent link">#</a></h4>
<p>Omit.onMenuScrollToBottom</p>
<hr />
<h3 id="onmenuscrolltotop">onMenuScrollToTop<a class="headerlink" href="#onmenuscrolltotop" title="Permanent link">#</a></h3>
@ -2028,19 +2050,19 @@ when there isn't enough space below the control.</p>
</table>
<h5 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h5>
<p><code>void</code></p>
<h4 id="inherited-from_58">Inherited from<a class="headerlink" href="#inherited-from_58" title="Permanent link">#</a></h4>
<h4 id="inherited-from_59">Inherited from<a class="headerlink" href="#inherited-from_59" title="Permanent link">#</a></h4>
<p>Omit.onMenuScrollToTop</p>
<hr />
<h3 id="openmenuonclick">openMenuOnClick<a class="headerlink" href="#openmenuonclick" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>openMenuOnClick</strong>: <code>boolean</code></p>
<p>Allows control of whether the menu is opened when the Select is clicked</p>
<h4 id="inherited-from_59">Inherited from<a class="headerlink" href="#inherited-from_59" title="Permanent link">#</a></h4>
<h4 id="inherited-from_60">Inherited from<a class="headerlink" href="#inherited-from_60" title="Permanent link">#</a></h4>
<p>Omit.openMenuOnClick</p>
<hr />
<h3 id="openmenuonfocus">openMenuOnFocus<a class="headerlink" href="#openmenuonfocus" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>openMenuOnFocus</strong>: <code>boolean</code></p>
<p>Allows control of whether the menu is opened when the Select is focused</p>
<h4 id="inherited-from_60">Inherited from<a class="headerlink" href="#inherited-from_60" title="Permanent link">#</a></h4>
<h4 id="inherited-from_61">Inherited from<a class="headerlink" href="#inherited-from_61" title="Permanent link">#</a></h4>
<p>Omit.openMenuOnFocus</p>
<hr />
<h3 id="options">options<a class="headerlink" href="#options" title="Permanent link">#</a></h3>
@ -2049,19 +2071,19 @@ when there isn't enough space below the control.</p>
<h3 id="pagesize">pageSize<a class="headerlink" href="#pagesize" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>pageSize</strong>: <code>number</code></p>
<p>Number of options to jump in menu when page{up|down} keys are used</p>
<h4 id="inherited-from_61">Inherited from<a class="headerlink" href="#inherited-from_61" title="Permanent link">#</a></h4>
<h4 id="inherited-from_62">Inherited from<a class="headerlink" href="#inherited-from_62" title="Permanent link">#</a></h4>
<p>Omit.pageSize</p>
<hr />
<h3 id="placeholder">placeholder<a class="headerlink" href="#placeholder" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>placeholder</strong>: <code>ReactNode</code></p>
<p>Placeholder for the select value</p>
<h4 id="inherited-from_62">Inherited from<a class="headerlink" href="#inherited-from_62" title="Permanent link">#</a></h4>
<h4 id="inherited-from_63">Inherited from<a class="headerlink" href="#inherited-from_63" title="Permanent link">#</a></h4>
<p>Omit.placeholder</p>
<hr />
<h3 id="required">required<a class="headerlink" href="#required" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>required</strong>: <code>boolean</code></p>
<p>Marks the value-holding input as required for form validation</p>
<h4 id="inherited-from_63">Inherited from<a class="headerlink" href="#inherited-from_63" title="Permanent link">#</a></h4>
<h4 id="inherited-from_64">Inherited from<a class="headerlink" href="#inherited-from_64" title="Permanent link">#</a></h4>
<p>Omit.required</p>
<hr />
<h3 id="screenreaderstatus">screenReaderStatus<a class="headerlink" href="#screenreaderstatus" title="Permanent link">#</a></h3>
@ -2090,37 +2112,43 @@ when there isn't enough space below the control.</p>
</table>
<h5 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h5>
<p><code>string</code></p>
<h4 id="inherited-from_64">Inherited from<a class="headerlink" href="#inherited-from_64" title="Permanent link">#</a></h4>
<h4 id="inherited-from_65">Inherited from<a class="headerlink" href="#inherited-from_65" title="Permanent link">#</a></h4>
<p>Omit.screenReaderStatus</p>
<hr />
<h3 id="styles">styles<a class="headerlink" href="#styles" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>styles</strong>: <code>StylesConfig</code>&lt;<code>Option</code>, <code>IsMulti</code>, <code>Group</code>></p>
<p>Style modifier methods</p>
<p>A basic example can be found at the bottom of the <a href="/advanced#replacing-builtins">Replacing builtins</a> documentation.</p>
<h4 id="inherited-from_65">Inherited from<a class="headerlink" href="#inherited-from_65" title="Permanent link">#</a></h4>
<h4 id="inherited-from_66">Inherited from<a class="headerlink" href="#inherited-from_66" title="Permanent link">#</a></h4>
<p>Omit.styles</p>
<hr />
<h3 id="tabindex">tabIndex<a class="headerlink" href="#tabindex" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>tabIndex</strong>: <code>number</code></p>
<p>Sets the tabIndex attribute on the input</p>
<h4 id="inherited-from_66">Inherited from<a class="headerlink" href="#inherited-from_66" title="Permanent link">#</a></h4>
<h4 id="inherited-from_67">Inherited from<a class="headerlink" href="#inherited-from_67" title="Permanent link">#</a></h4>
<p>Omit.tabIndex</p>
<hr />
<h3 id="tabselectsvalue">tabSelectsValue<a class="headerlink" href="#tabselectsvalue" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>tabSelectsValue</strong>: <code>boolean</code></p>
<p>Select the currently focused option when the user presses tab</p>
<h4 id="inherited-from_67">Inherited from<a class="headerlink" href="#inherited-from_67" title="Permanent link">#</a></h4>
<h4 id="inherited-from_68">Inherited from<a class="headerlink" href="#inherited-from_68" title="Permanent link">#</a></h4>
<p>Omit.tabSelectsValue</p>
<hr />
<h3 id="theme">theme<a class="headerlink" href="#theme" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>theme</strong>: <code>ThemeConfig</code></p>
<p>Theme modifier method</p>
<h4 id="inherited-from_68">Inherited from<a class="headerlink" href="#inherited-from_68" title="Permanent link">#</a></h4>
<h4 id="inherited-from_69">Inherited from<a class="headerlink" href="#inherited-from_69" title="Permanent link">#</a></h4>
<p>Omit.theme</p>
<hr />
<h3 id="themename">themeName<a class="headerlink" href="#themename" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>themeName</strong>: <code>"dark"</code> | <code>"light"</code> | <code>"lens"</code> | <code>"outlined"</code></p>
<hr />
<h3 id="unstyled">unstyled<a class="headerlink" href="#unstyled" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>unstyled</strong>: <code>boolean</code></p>
<p>Remove all non-essential styles</p>
<h4 id="inherited-from_70">Inherited from<a class="headerlink" href="#inherited-from_70" title="Permanent link">#</a></h4>
<p>Omit.unstyled</p>
<hr />
<h3 id="value">value<a class="headerlink" href="#value" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>value</strong>: <code>PropsValue</code>&lt;<code>Value</code>></p>

2
master/search/search_index.json
View File

File diff suppressed because one or more lines are too long

BIN
master/sitemap.xml.gz
View File

Binary file not shown.