mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 30880276d7 to master with MkDocs 1.3.0 and mike 1.1.2
This commit is contained in:
GitHub Action committed
1 parent
ce1ce8b442
commit
5d9fad4a6f
36 files changed
+4113
-4129
No files matched your search
+213
-228
@@ -738,13 +738,6 @@
|
||||
Properties
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#methods" class="md-nav__link">
|
||||
Methods
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -1143,6 +1136,13 @@
|
||||
onBlur
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#onchange" class="md-nav__link">
|
||||
onChange
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1150,6 +1150,13 @@
|
||||
onFocus
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#oninputchange" class="md-nav__link">
|
||||
onInputChange
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1157,6 +1164,20 @@
|
||||
onKeyDown
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#onmenuclose" class="md-nav__link">
|
||||
onMenuClose
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#onmenuopen" class="md-nav__link">
|
||||
onMenuOpen
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1267,47 +1288,6 @@
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#methods_1" class="md-nav__link">
|
||||
Methods
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Methods">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#onchange" class="md-nav__link">
|
||||
onChange
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#oninputchange" class="md-nav__link">
|
||||
onInputChange
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#onmenuclose" class="md-nav__link">
|
||||
onMenuClose
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#onmenuopen" class="md-nav__link">
|
||||
onMenuOpen
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -1404,8 +1384,12 @@
|
||||
<li><a href="./#name">name</a></li>
|
||||
<li><a href="./#nooptionsmessage">noOptionsMessage</a></li>
|
||||
<li><a href="./#onblur">onBlur</a></li>
|
||||
<li><a href="./#onchange">onChange</a></li>
|
||||
<li><a href="./#onfocus">onFocus</a></li>
|
||||
<li><a href="./#oninputchange">onInputChange</a></li>
|
||||
<li><a href="./#onkeydown">onKeyDown</a></li>
|
||||
<li><a href="./#onmenuclose">onMenuClose</a></li>
|
||||
<li><a href="./#onmenuopen">onMenuOpen</a></li>
|
||||
<li><a href="./#onmenuscrolltobottom">onMenuScrollToBottom</a></li>
|
||||
<li><a href="./#onmenuscrolltotop">onMenuScrollToTop</a></li>
|
||||
<li><a href="./#openmenuonclick">openMenuOnClick</a></li>
|
||||
@@ -1422,13 +1406,6 @@
|
||||
<li><a href="./#themename">themeName</a></li>
|
||||
<li><a href="./#value">value</a></li>
|
||||
</ul>
|
||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#onchange">onChange</a></li>
|
||||
<li><a href="./#oninputchange">onInputChange</a></li>
|
||||
<li><a href="./#onmenuclose">onMenuClose</a></li>
|
||||
<li><a href="./#onmenuopen">onMenuOpen</a></li>
|
||||
</ul>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="aria-errormessage">aria-errormessage<a class="headerlink" href="#aria-errormessage" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-errormessage</strong>: <code>string</code></p>
|
||||
@@ -1930,23 +1907,11 @@ when there isn't enough space below the control.</p>
|
||||
<h4 id="inherited-from_54">Inherited from<a class="headerlink" href="#inherited-from_54" title="Permanent link">#</a></h4>
|
||||
<p>Omit.onBlur</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><<code>HTMLInputElement</code>></p>
|
||||
<p>Handle focus events on the control</p>
|
||||
<h4 id="inherited-from_55">Inherited from<a class="headerlink" href="#inherited-from_55" title="Permanent link">#</a></h4>
|
||||
<p>Omit.onFocus</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><<code>HTMLDivElement</code>></p>
|
||||
<p>Handle key down events on the select</p>
|
||||
<h4 id="inherited-from_56">Inherited from<a class="headerlink" href="#inherited-from_56" title="Permanent link">#</a></h4>
|
||||
<p>Omit.onKeyDown</p>
|
||||
<hr />
|
||||
<h3 id="onmenuscrolltobottom">onMenuScrollToBottom<a class="headerlink" href="#onmenuscrolltobottom" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>onMenuScrollToBottom</strong>: (<code>event</code>: <code>TouchEvent</code> | <code>WheelEvent</code>) => <code>void</code></p>
|
||||
<h3 id="onchange">onChange<a class="headerlink" href="#onchange" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>onChange</strong>: (<code>newValue</code>: <code>OnChangeValue</code><{ <code>label</code>: <code>string</code> ; <code>value</code>: <code>string</code> }, <code>IsMulti</code>>, <code>actionMeta</code>: <code>ActionMeta</code><{ <code>label</code>: <code>string</code> ; <code>value</code>: <code>string</code> }>) => <code>void</code></p>
|
||||
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||
<p>▸ (<code>event</code>): <code>void</code></p>
|
||||
<p>Fired when the user scrolls to the bottom of the menu</p>
|
||||
<p>▸ (<code>newValue</code>, <code>actionMeta</code>): <code>void</code></p>
|
||||
<p>Handle change events on the select</p>
|
||||
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1957,164 +1922,32 @@ when there isn't enough space below the control.</p>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>event</code></td>
|
||||
<td align="left"><code>TouchEvent</code> | <code>WheelEvent</code></td>
|
||||
<td align="left"><code>newValue</code></td>
|
||||
<td align="left"><code>OnChangeValue</code><{ <code>label</code>: <code>string</code> ; <code>value</code>: <code>string</code> }, <code>IsMulti</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>actionMeta</code></td>
|
||||
<td align="left"><code>ActionMeta</code><{ <code>label</code>: <code>string</code> ; <code>value</code>: <code>string</code> }></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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_57">Inherited from<a class="headerlink" href="#inherited-from_57" title="Permanent link">#</a></h4>
|
||||
<p>Omit.onMenuScrollToBottom</p>
|
||||
<hr />
|
||||
<h3 id="onmenuscrolltotop">onMenuScrollToTop<a class="headerlink" href="#onmenuscrolltotop" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>onMenuScrollToTop</strong>: (<code>event</code>: <code>TouchEvent</code> | <code>WheelEvent</code>) => <code>void</code></p>
|
||||
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||
<p>▸ (<code>event</code>): <code>void</code></p>
|
||||
<p>Fired when the user scrolls to the top of the menu</p>
|
||||
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" 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>event</code></td>
|
||||
<td align="left"><code>TouchEvent</code> | <code>WheelEvent</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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_58">Inherited from<a class="headerlink" href="#inherited-from_58" 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>
|
||||
<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>
|
||||
<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_61">Inherited from<a class="headerlink" href="#inherited-from_61" 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>
|
||||
<p>Omit.placeholder</p>
|
||||
<hr />
|
||||
<h3 id="screenreaderstatus">screenReaderStatus<a class="headerlink" href="#screenreaderstatus" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>screenReaderStatus</strong>: (<code>obj</code>: { <code>count</code>: <code>number</code> }) => <code>string</code></p>
|
||||
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||
<p>▸ (<code>obj</code>): <code>string</code></p>
|
||||
<p>Status to relay to screen readers</p>
|
||||
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" 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>obj</code></td>
|
||||
<td align="left"><code>Object</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>obj.count</code></td>
|
||||
<td align="left"><code>number</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_63">Inherited from<a class="headerlink" href="#inherited-from_63" title="Permanent link">#</a></h4>
|
||||
<p>Omit.screenReaderStatus</p>
|
||||
<hr />
|
||||
<h3 id="showicons">showIcons<a class="headerlink" href="#showicons" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>showIcons</strong>: <code>boolean</code></p>
|
||||
<hr />
|
||||
<h3 id="sort">sort<a class="headerlink" href="#sort" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>sort</strong>: <a href="../../modules/Renderer.Component/#namespaceselectsort"><code>NamespaceSelectSort</code></a></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><{ <code>label</code>: <code>string</code> ; <code>value</code>: <code>string</code> }, <code>IsMulti</code>, <code>GroupBase</code><{ <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_64">Inherited from<a class="headerlink" href="#inherited-from_64" 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_65">Inherited from<a class="headerlink" href="#inherited-from_65" 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_66">Inherited from<a class="headerlink" href="#inherited-from_66" 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_67">Inherited from<a class="headerlink" href="#inherited-from_67" 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>"lens"</code> | <code>"dark"</code> | <code>"light"</code> | <code>"outlined"</code></p>
|
||||
<h4 id="inherited-from_68">Inherited from<a class="headerlink" href="#inherited-from_68" title="Permanent link">#</a></h4>
|
||||
<p>Omit.themeName</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>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="onchange">onChange<a class="headerlink" href="#onchange" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Optional</code> <strong>onChange</strong>(<code>newValue</code>, <code>actionMeta</code>): <code>void</code></p>
|
||||
<p>Handle change events on the select</p>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" 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>newValue</code></td>
|
||||
<td align="left"><code>OnChangeValue</code><<code>Option</code>, <code>IsMulti</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>actionMeta</code></td>
|
||||
<td align="left"><code>ActionMeta</code><<code>Option</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_69">Inherited from<a class="headerlink" href="#inherited-from_69" 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.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><<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>
|
||||
<p>Omit.onFocus</p>
|
||||
<hr />
|
||||
<h3 id="oninputchange">onInputChange<a class="headerlink" href="#oninputchange" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Optional</code> <strong>onInputChange</strong>(<code>newValue</code>, <code>actionMeta</code>): <code>void</code></p>
|
||||
<p>• <code>Optional</code> <strong>onInputChange</strong>: (<code>newValue</code>: <code>string</code>, <code>actionMeta</code>: <code>InputActionMeta</code>) => <code>void</code></p>
|
||||
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||
<p>▸ (<code>newValue</code>, <code>actionMeta</code>): <code>void</code></p>
|
||||
<p>Handle change events on the input</p>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -2133,26 +1966,178 @@ when there isn't enough space below the control.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<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_70">Inherited from<a class="headerlink" href="#inherited-from_70" 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.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><<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>
|
||||
<p>Omit.onKeyDown</p>
|
||||
<hr />
|
||||
<h3 id="onmenuclose">onMenuClose<a class="headerlink" href="#onmenuclose" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Optional</code> <strong>onMenuClose</strong>(): <code>void</code></p>
|
||||
<p>• <code>Optional</code> <strong>onMenuClose</strong>: () => <code>void</code></p>
|
||||
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||
<p>▸ (): <code>void</code></p>
|
||||
<p>Handle the menu closing</p>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<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_71">Inherited from<a class="headerlink" href="#inherited-from_71" 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.onMenuClose</p>
|
||||
<hr />
|
||||
<h3 id="onmenuopen">onMenuOpen<a class="headerlink" href="#onmenuopen" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Optional</code> <strong>onMenuOpen</strong>(): <code>void</code></p>
|
||||
<p>• <code>Optional</code> <strong>onMenuOpen</strong>: () => <code>void</code></p>
|
||||
<h4 id="type-declaration_9">Type declaration<a class="headerlink" href="#type-declaration_9" title="Permanent link">#</a></h4>
|
||||
<p>▸ (): <code>void</code></p>
|
||||
<p>Handle the menu opening</p>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<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_72">Inherited from<a class="headerlink" href="#inherited-from_72" 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.onMenuOpen</p>
|
||||
<hr />
|
||||
<h3 id="onmenuscrolltobottom">onMenuScrollToBottom<a class="headerlink" href="#onmenuscrolltobottom" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>onMenuScrollToBottom</strong>: (<code>event</code>: <code>TouchEvent</code> | <code>WheelEvent</code>) => <code>void</code></p>
|
||||
<h4 id="type-declaration_10">Type declaration<a class="headerlink" href="#type-declaration_10" title="Permanent link">#</a></h4>
|
||||
<p>▸ (<code>event</code>): <code>void</code></p>
|
||||
<p>Fired when the user scrolls to the bottom of the menu</p>
|
||||
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" 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>event</code></td>
|
||||
<td align="left"><code>TouchEvent</code> | <code>WheelEvent</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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>
|
||||
<p>Omit.onMenuScrollToBottom</p>
|
||||
<hr />
|
||||
<h3 id="onmenuscrolltotop">onMenuScrollToTop<a class="headerlink" href="#onmenuscrolltotop" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>onMenuScrollToTop</strong>: (<code>event</code>: <code>TouchEvent</code> | <code>WheelEvent</code>) => <code>void</code></p>
|
||||
<h4 id="type-declaration_11">Type declaration<a class="headerlink" href="#type-declaration_11" title="Permanent link">#</a></h4>
|
||||
<p>▸ (<code>event</code>): <code>void</code></p>
|
||||
<p>Fired when the user scrolls to the top of the menu</p>
|
||||
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" 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>event</code></td>
|
||||
<td align="left"><code>TouchEvent</code> | <code>WheelEvent</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<p>Omit.placeholder</p>
|
||||
<hr />
|
||||
<h3 id="screenreaderstatus">screenReaderStatus<a class="headerlink" href="#screenreaderstatus" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>screenReaderStatus</strong>: (<code>obj</code>: { <code>count</code>: <code>number</code> }) => <code>string</code></p>
|
||||
<h4 id="type-declaration_12">Type declaration<a class="headerlink" href="#type-declaration_12" title="Permanent link">#</a></h4>
|
||||
<p>▸ (<code>obj</code>): <code>string</code></p>
|
||||
<p>Status to relay to screen readers</p>
|
||||
<h5 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" 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>obj</code></td>
|
||||
<td align="left"><code>Object</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>obj.count</code></td>
|
||||
<td align="left"><code>number</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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_67">Inherited from<a class="headerlink" href="#inherited-from_67" title="Permanent link">#</a></h4>
|
||||
<p>Omit.screenReaderStatus</p>
|
||||
<hr />
|
||||
<h3 id="showicons">showIcons<a class="headerlink" href="#showicons" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>showIcons</strong>: <code>boolean</code></p>
|
||||
<hr />
|
||||
<h3 id="sort">sort<a class="headerlink" href="#sort" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>sort</strong>: <a href="../../modules/Renderer.Component/#namespaceselectsort"><code>NamespaceSelectSort</code></a></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><{ <code>label</code>: <code>string</code> ; <code>value</code>: <code>string</code> }, <code>IsMulti</code>, <code>GroupBase</code><{ <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_68">Inherited from<a class="headerlink" href="#inherited-from_68" 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_69">Inherited from<a class="headerlink" href="#inherited-from_69" 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_70">Inherited from<a class="headerlink" href="#inherited-from_70" 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_71">Inherited from<a class="headerlink" href="#inherited-from_71" 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>"lens"</code> | <code>"dark"</code> | <code>"light"</code> | <code>"outlined"</code></p>
|
||||
<h4 id="inherited-from_72">Inherited from<a class="headerlink" href="#inherited-from_72" title="Permanent link">#</a></h4>
|
||||
<p>Omit.themeName</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>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in new issue
Block a user