Deployed 9ba92cb072 to master with MkDocs 1.4.2 and mike 1.1.2

This commit is contained in:
GitHub Action committed 2022-12-02 15:40:14 +00:00
1 parent beb305b9a9
commit a7d4d7c7e5
15 files changed
+583 -432

No files matched your search

@@ -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>