@splunk/react-ui 5.1.0 → 5.2.0

package/types/src/File/docs/examples/Error.d.ts

@@ -1,2 +1,6 @@
 import React from 'react';
+/**
+ * @name Error
+ * @description The File and File.Item have separate error states. Generally, they should not be used together. Either the File is in error (for example, required field), or an Item is in error (for example, incorrect file type).
+ */
 export default function FileErrors(): React.JSX.Element;

package/types/src/File/docs/examples/FullScreen.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Full screen
+ * @description This example must open in a modal. There can only be one File component on the page. Dropping a file anywhere will upload the file.
+ */
 declare function Fullscreen(): React.JSX.Element;
 export default Fullscreen;

package/types/src/File/docs/examples/Multi.d.ts

@@ -4,6 +4,10 @@ interface FileItem {
     name: string;
     value?: string | ArrayBuffer | null;
 }
+/**
+ * @name Multifile
+ * @description By storing an array of items, multiple files can be supported.
+ */
 declare class Multi extends Component<object, {
     files: FileItem[];
 }> {

package/types/src/File/docs/examples/Progress.d.ts

@@ -1,2 +1,6 @@
 import React from 'react';
+/**
+ * @name Progress
+ * @description The File.Item can display its upload progress.
+ */
 export default function Progress(): React.JSX.Element;

package/types/src/File/docs/examples/Single.d.ts

@@ -1,5 +1,9 @@
 import React, { Component } from 'react';
 import { FileRequestAddHandler } from '@splunk/react-ui/File';
+/**
+ * @name Single file
+ * @description Here, selecting a new file will replace the existing file.
+ */
 declare class Single extends Component<object, {
     filename?: string;
 }> {

package/types/src/FormRows/docs/examples/Basic.d.ts

@@ -1,5 +1,8 @@
 import React, { Component } from 'react';
 import { FormRowsRequestMoveHandler, RowRequestRemoveHandler } from '@splunk/react-ui/FormRows';
+/**
+ * @name Basic
+ */
 declare class Basic extends Component<object, {
     items: React.ReactElement[];
 }> {

package/types/src/FormRows/docs/examples/Header.d.ts

@@ -1,5 +1,9 @@
 import React, { Component } from 'react';
 import { FormRowsRequestMoveHandler, RowRequestRemoveHandler } from '@splunk/react-ui/FormRows';
+/**
+ * @name Header
+ * @description Form Rows does not provide a concept of columns, but this can be simulated by adding content to the header and setting fixed widths on the elements. For accessibility compliance, ensure each heading has a unique id and form controls have a matching describedBy prop.
+ */
 declare class Header extends Component<object, {
     items: React.ReactElement[];
 }> {

package/types/src/FormRows/docs/examples/Menu.d.ts

@@ -1,6 +1,10 @@
 import React, { Component } from 'react';
 import { FormRowsRequestMoveHandler, RowRequestRemoveHandler } from '@splunk/react-ui/FormRows';
 import { SelectChangeHandler } from '@splunk/react-ui/Select';
+/**
+ * @name Custom add menu
+ * @description The 'Add row' button can be replaced with a button, multiple buttons, or any other content you want to show below the Form Rows.
+ */
 declare class Menu extends Component<object, {
     items: React.ReactElement[];
 }> {

package/types/src/FormRows/docs/examples/ReorderOnly.d.ts

@@ -1,5 +1,9 @@
 import React, { Component } from 'react';
 import { FormRowsRequestMoveHandler } from '@splunk/react-ui/FormRows';
+/**
+ * @name Reorder only
+ * @description The add and delete functionality can be removed by not including the onRequestAdd handler on Form Rows and the onRequestRemove handler on Row. The functionality of reordering Rows will still remain intact. If users can add, they should be able to delete as well.
+ */
 declare class ReorderOnly extends Component<object, {
     items: React.ReactElement[];
 }> {

package/types/src/Heading/docs/examples/Basic.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Basic
+ */
 declare function Basic(): React.JSX.Element;
 export default Basic;

package/types/src/Heading/docs/examples/Variant.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Variant
+ * @description The level prop determines the <hX> HTML tag and has an associated default typography mixin style. To override this default styling, the variant prop can be used to specify a typography mixin style. For instance, it is possible for a variant to have title1 styling and be a <h2> tag as in the below example.
+ */
 declare function Variant(): React.JSX.Element;
 export default Variant;

package/types/src/Image/docs/examples/Basic.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Basic
+ */
 declare function Basic(): React.JSX.Element;
 export default Basic;

package/types/src/JSONTree/docs/examples/Basic.d.ts

@@ -1,2 +1,5 @@
 import React from 'react';
+/**
+ * @name Basic
+ */
 export default function Basic(): React.JSX.Element;

package/types/src/JSONTree/docs/examples/Events.d.ts

@@ -1,5 +1,9 @@
 import React, { Component } from 'react';
 import { JSONTreeClickValueHandler, JSONTreeClickKeyHandler } from '@splunk/react-ui/JSONTree';
+/**
+ * @name Click events
+ * @description Click the value to see the interaction.
+ */
 declare class Events extends Component<object, {
     key: string;
     keyPath?: (string | number)[];

package/types/src/JSONTree/docs/examples/ExpandChildrenOnShiftKey.d.ts

@@ -1,2 +1,6 @@
 import React from 'react';
+/**
+ * @name Expand children on shift key
+ * @description Shift + Click or Shift + Enter to expand all child nodes at once.
+ */
 export default function ExpandChildrenOnShiftKey(): React.JSX.Element;

package/types/src/Layer/docs/examples/Basic.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Basic
+ * @description This example shows a simple overlay that can be dismissed by pressing the Escape key.
+ */
 declare function Basic(): React.JSX.Element;
 export default Basic;

package/types/src/Layout/docs/examples/Basic.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Basic
+ */
 declare function Basic(): React.JSX.Element;
 export default Basic;

package/types/src/Link/docs/examples/Basic.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Basic
+ * @description Use the Link component instead of an <a> tag, by default it is displayed inline.
+ */
 declare function Basic(): React.JSX.Element;
 export default Basic;

package/types/src/Link/docs/examples/Disabled.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Disabled
+ * @description Links can be disabled. The href is then removed from the markup.
+ */
 declare function Disabled(): React.JSX.Element;
 export default Disabled;

package/types/src/Link/docs/examples/NewWindow.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name New window
+ * @description openInNewContext=true adds an icon and sets target to _blank. A message indicates the behavior for screen reader users. The default message, '(Opens new window)', can be customized by by passing a string to openInNewContext.
+ */
 declare function NewWindow(): React.JSX.Element;
 export default NewWindow;

package/types/src/Link/docs/examples/Standalone.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Standalone
+ * @description Use appearance="standalone" when using Link on its own without other text content.
+ */
 declare function Standalone(): React.JSX.Element;
 export default Standalone;

package/types/src/List/docs/examples/CustomizedList.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Customized list
+ * @description List style type can be customized using CSS.
+ */
 declare function CustomizedList(): React.JSX.Element;
 export default CustomizedList;

package/types/src/List/docs/examples/OrderedList.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Ordered list
+ * @description Ordered Lists use numerals by default.
+ */
 declare function Ordered(): React.JSX.Element;
 export default Ordered;

package/types/src/List/docs/examples/UnorderedList.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Unordered list
+ */
 declare function UnorderedList(): React.JSX.Element;
 export default UnorderedList;

package/types/src/Markdown/docs/examples/Basic.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Basic
+ * @description Most Markdown elements and capabilities are supported. HTML is not permitted.
+ */
 declare function BasicExample(): React.JSX.Element;
 export default BasicExample;

package/types/src/Markdown/docs/examples/I18n.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name I18n
+ * @description Combine with gettext interpolation.
+ */
 declare function I18nExample(): React.JSX.Element;
 export default I18nExample;

package/types/src/Menu/Item.d.ts

@@ -74,20 +74,25 @@ interface ItemPropsBase {
      */
     role?: 'menuitem' | 'menuitemradio' | 'menuitemcheckbox' | 'listboxitem' | 'option';
     /**
-     * If selectable is true, whitespace is left where the checkmark can be shown.
+     * Enables selection for this item and reserves space for the control.
+     * Required when using `selected` or `selectableAppearance`.
      */
     selectable?: boolean;
     /**
-     * If selectable is true, whitespace is left where the checkmark can be shown.
+     * Specifies the type of selection control to display when `selectable` is enabled.
      */
     selectableAppearance?: 'checkmark' | 'checkbox';
     /**
-     * Indicates the selection state of the item.
-     * - With `selectableAppearance='checkmark'`: if `selected` is `true`, a checkmark shows the item is selected.
-     * - With `selectableAppearance='checkbox'`:
-     *   - `selected=true` renders a fully checked checkbox.
-     *   - `selected='some'` renders a partially checked (indeterminate) checkbox, corresponding to `aria-checked='mixed'`.
-     *   - `selected=false` renders an unchecked checkbox.
+     * Controls the selection state of the item.
+     * The selection control (checkmark or checkbox) is only rendered when `selectable` is enabled.
+     *
+     * When `selectableAppearance = 'checkmark'`:
+     * - `true` shows a checkmark.
+     *
+     * When `selectableAppearance = 'checkbox'`:
+     * - `true` renders a checked box.
+     * - `'some'` renders an indeterminate box (`aria-checked="mixed"`).
+     * - `false` renders an unchecked box.
      */
     selected?: boolean | 'some';
     /** Adornment in front of the label. */
@@ -101,8 +106,20 @@ interface ItemPropsBase {
      */
     truncate?: boolean;
 }
-type ItemButtonProps = ComponentProps<ItemPropsBase, 'button'>;
-type ItemLinkProps = ComponentProps<ItemPropsBase, 'a', 'href'>;
+type SharedItemProps = Omit<ItemPropsBase, 'selectable' | 'selectableAppearance' | 'selected'>;
+interface NonSelectableItemProps extends SharedItemProps {
+    selectable?: false;
+    selectableAppearance?: never;
+    selected?: never;
+}
+interface SelectableItemProps extends SharedItemProps {
+    selectable: true;
+    selectableAppearance?: 'checkmark' | 'checkbox';
+    selected?: boolean | 'some';
+}
+type ItemPropsCommon = NonSelectableItemProps | SelectableItemProps;
+type ItemButtonProps = ComponentProps<ItemPropsCommon, 'button'>;
+type ItemLinkProps = ComponentProps<ItemPropsCommon, 'a', 'href'>;
 type ItemProps = ItemButtonProps | ItemLinkProps;
 declare function Item({ active, children, description, descriptionPosition, disabled, endAdornment, elementRef, hasSubmenu, itemKey, matchRanges, onClick, onFocus, openInNewContext, role, selectable, selectableAppearance, selected, startAdornment, to, truncate, ...otherProps }: ItemProps): React.JSX.Element;
 declare namespace Item {

package/types/src/Menu/docs/examples/Adornments.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Adornments
+ * @description A startAdornment and/or endAdornment can be added to a Menu.Item. Adornments should be decorative.
+ */
 declare function Adornments(): React.JSX.Element;
 export default Adornments;

package/types/src/Menu/docs/examples/Basic.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Basic
+ */
 declare function Basic(): React.JSX.Element;
 export default Basic;

package/types/src/Menu/docs/examples/Complex.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Complex
+ * @description All the options can be used together. Additional props, such as hasSubmenu, are detailed in the following example.
+ */
 declare function Complex(): React.JSX.Element;
 export default Complex;

package/types/src/Menu/docs/examples/Descriptions.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Descriptions
+ * @description Descriptions can be placed below or to the right of the label. Defaults to descriptionPosition="bottom".
+ */
 declare function Descriptions(): React.JSX.Element;
 export default Descriptions;

package/types/src/Menu/docs/examples/Dimmed.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Dimmed
+ * @description If you absolutely need to disable a Menu Item use a dimmed Menu Item. When the disabled prop is set to "dimmed", the Menu Item does not respond to events but can still receive focus to ensure users can navigate to the Item when using assistive technologies. This also sets aria-disabled to true.
+ */
 declare function Dimmed(): React.JSX.Element;
 export default Dimmed;

package/types/src/Menu/docs/examples/Disabled.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Disabled
+ */
 declare function Disabled(): React.JSX.Element;
 export default Disabled;

package/types/src/Menu/docs/examples/Dividers.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Dividers
+ */
 declare function Dividers(): React.JSX.Element;
 export default Dividers;

package/types/src/Menu/docs/examples/Headings.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Headings
+ * @description Menus can have headings to summarize the following items.
+ */
 declare function Headings(): React.JSX.Element;
 export default Headings;

package/types/src/Menu/docs/examples/Links.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Links
+ * @description Menu.Items can contain links by including a to attribute.
+ */
 declare function Links(): React.JSX.Element;
 export default Links;

package/types/src/Menu/docs/examples/MatchRanges.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Match ranges
+ * @description Menu.Item can highlight portions of the label as matching a filter or search.
+ */
 declare function MatchRanges(): React.JSX.Element;
 export default MatchRanges;

package/types/src/Menu/docs/examples/Selectable.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Selectable and selected
+ * @description Items can be selected or selectable, which ensures space is reserved for the checkmark.
+ */
 declare function Selectable(): React.JSX.Element;
 export default Selectable;

package/types/src/Menu/docs/examples/SelectableWithAdornments.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Selectable and selected with adornments
+ * @description Items with adornments can be selected or selectable.
+ */
 declare function SelectableWithAdornments(): React.JSX.Element;
 export default SelectableWithAdornments;

package/types/src/Menu/docs/examples/Truncate.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Truncation
+ * @description Labels that are too long can be optionally constrained to one line and truncated.
+ */
 declare function Truncate(): React.JSX.Element;
 export default Truncate;

package/types/src/Message/docs/examples/Basic.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Message types
+ */
 declare function Basic(): React.JSX.Element;
 export default Basic;

package/types/src/Message/docs/examples/Content.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Content
+ * @description Message can contain text, links, and buttons. Interactive items should not be included in content when Message is being used as a toast.
+ */
 declare function Content(): React.JSX.Element;
 export default Content;

package/types/src/Message/docs/examples/Fill.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Fill
+ */
 declare function Fill(): React.JSX.Element;
 export default Fill;

package/types/src/Message/docs/examples/Removable.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Removable
+ */
 declare function Removable(): React.JSX.Element;
 export default Removable;

package/types/src/MessageBar/docs/examples/Basic.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Basic
+ * @description Message Bar is a landmark so that users can easily navigate to and discover the important information; therefore, they must include a label using aria-labelledby or aria-label. There are several ways to accomplish this so each of the examples on this page illustrates a different approach.
+ */
 declare function Basic(): React.JSX.Element;
 export default Basic;

package/types/src/MessageBar/docs/examples/Types.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Types
+ * @description Message Bar can have one of four types: "info", "warning", "error" or "success".
+ */
 declare function Types(): React.JSX.Element;
 export default Types;

package/types/src/MessageBar/docs/examples/WithActions.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name With actions
+ */
 declare function WithActions(): React.JSX.Element;
 export default WithActions;

package/types/src/Modal/Modal.d.ts

@@ -23,6 +23,13 @@ interface ModalPropsBase {
     /**
      * @private
      * Set to 'true' to enable closing the Modal by clicking outside of it.
+     *
+     * This behavior should be avoided as it can lead to accidental dismissal of the modal causing data loss or disruption of a user's workflow.
+     * Only enable click outside to dismiss when:
+     * - The modal content is non-critical or purely informational
+     * - Accidental dismissal will not result in loss of progress, data, or important context
+     *
+     * `onRequestClose` will receive an event with reason 'clickAway' when this happens.
      */
     closeOnClickAway?: boolean;
     /**
@@ -39,12 +46,12 @@ interface ModalPropsBase {
      */
     initialFocus?: ModalInitialFocus;
     /**
-     * Called when a close event occurs. The callback is passed the event
-     * and a reason, which is 'escapeKey', 'clickAway', or 'clickCloseButton'.
-     *
+     * Called when a close event occurs.
      * When `Modal` includes this prop, a close button is displayed by default in the `Modal.Header`.
      * To hide the close button, pass the `hideCloseButton` prop to `Modal.Header`.
      *
+     * The callback is passed the event and a reason, which is 'escapeKey' or 'clickCloseButton'.
+     *
      * Generally, use this callback to toggle the `open` prop.
      */
     onRequestClose?: ModalRequestCloseHandler;

package/types/src/Modal/docs/examples/Basic.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Basic
+ */
 declare function Basic(): React.JSX.Element;
 export default Basic;

package/types/src/Modal/docs/examples/InitialFocus.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Initial focus
+ * @description Initial focus can be set to an different element.
+ */
 declare function InitialFocus(): React.JSX.Element;
 export default InitialFocus;

package/types/src/Modal/docs/examples/TypicalUsage.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Typical usage
+ * @description This example shows a basic Splunk UI-styled Modal. By default, the Modal takes on the width of the content, so ensure that the width is set on the children. Alternately, set width on the Modal or Modal.Body with an inline style. Use an inline style to set the width and height of the icon to fit the icon's container. Modals *must* return focus to the element that invoked the dialog (or another element that follows the logical flow of the application) on close. To automatically return focus to the invoking element on Modal close, pass the ref of the invoking element to Modal's returnFocus prop. If using a ref is not possible, you *must* manually return focus to the invoking element in a function passed to returnFocus. Additionally, Modals containing a form should not close when clickAway event occurs. See below for an example of how to implement these requirements.
+ */
 declare function TypicalUsage(): React.JSX.Element;
 export default TypicalUsage;

package/types/src/Modal/docs/examples/Undismissable.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Undismissable
+ * @description To create a Modal that cannot be dismissed, omit the onClose callback.
+ */
 declare function Basic(): React.JSX.Element;
 export default Basic;

package/types/src/Monogram/Monogram.d.ts

@@ -44,6 +44,10 @@ type MonogramProps = MonogramInteractiveProps | MonogramNonInteractiveProps;
  * @public
  */
 declare function getInitials(name: string): string;
+/**
+ * @deprecated
+ * Monogram has been deprecated and will be removed in a future major version. Use Avatar instead.
+ */
 declare function Monogram({ backgroundColor, initials, size, ...otherProps }: MonogramProps): React.JSX.Element;
 declare namespace Monogram {
     var propTypes: {

package/types/src/Monogram/docs/examples/BackgroundAuto.d.ts

@@ -1,2 +1,6 @@
 import React from 'react';
+/**
+ * @name Auto background color
+ * @description The background color is derived from the initials prop if the backgroundColor prop is set to "auto". We do not recommend using "auto" background color because the existing built-in background color set might lead to color contrast issues. Please use a custom background color and ensure that it has sufficient color contrast with the initial's text color.
+ */
 export default function BackgroundAuto(): React.JSX.Element;

package/types/src/Monogram/docs/examples/BackgroundCustom.d.ts

@@ -1,2 +1,5 @@
 import React from 'react';
+/**
+ * @name Custom background color
+ */
 export default function BackgroundCustom(): React.JSX.Element;

package/types/src/Monogram/docs/examples/Basic.d.ts

@@ -1,2 +1,6 @@
 import React from 'react';
+/**
+ * @name Basic
+ * @description A Monogram can show one to three characters. You can use the getInitials helper to shorten a name.
+ */
 export default function Basic(): React.JSX.Element;

package/types/src/Monogram/docs/examples/Interactive.d.ts

@@ -1,2 +1,6 @@
 import React from 'react';
+/**
+ * @name Interactive
+ * @description A click handler can be added to enable interactivity.
+ */
 export default function Interactive(): React.JSX.Element;

package/types/src/Monogram/docs/examples/Size.d.ts

@@ -1,2 +1,6 @@
 import React from 'react';
+/**
+ * @name Size
+ * @description Monograms can be one of three standard sizes: "small", "medium" (default), "large", or "xlarge" (deprecated). The size prop can also be a number if the standard size does not fit your use case. Note: using a non-standard size may have unexpected layouts when combined with other components.
+ */
 export default function Size(): React.JSX.Element;

package/types/src/Multiselect/Compact.d.ts

@@ -129,7 +129,7 @@ interface CompactPropsBase {
      * @deprecatedValue 'buttongroup'
      * The 'buttongroup' value is deprecated and will be removed in a future major version.
      */
-    selectAllAppearance?: 'buttongroup' | 'checkbox';
+    selectAllAppearance?: 'buttongroup' | 'checkbox' | 'none';
     /**
      * Move selected values to the top of the list on next open, immediately, or not at all.
      */

package/types/src/Multiselect/Multiselect.d.ts

@@ -154,7 +154,7 @@ interface MultiselectPropsBase {
      * @deprecatedValue 'buttongroup'
      * The 'buttongroup' value is deprecated and will be removed in a future major version.
      */
-    selectAllAppearance?: 'buttongroup' | 'checkbox';
+    selectAllAppearance?: 'buttongroup' | 'checkbox' | 'none';
     /**
      * When `compact=true`, move selected values to the top of the list on next open (default), immediately, or not at all.
      */

package/types/src/Multiselect/docs/examples/Children.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Children
+ * @description children replace label when provided. label is still used for matching to the filter.
+ */
 declare function Children(): React.JSX.Element;
 export default Children;

package/types/src/Multiselect/docs/examples/Compact.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Compact
+ * @description When compact is true, the Multiselect will never grow tall.
+ */
 declare function Compact(): React.JSX.Element;
 export default Compact;