carbon-react 118.1.0 → 118.2.0

package/lib/components/select/__internal__/select-text/select-text.component.js

@@ -26,58 +26,38 @@ const SelectText = ({
   size = "medium"
 }) => {
   const hasPlaceholder = !disabled && !readOnly && !formattedValue;
-
-  function handleClick(event) {
-    onClick(event);
-  }
-
   return /*#__PURE__*/_react.default.createElement(_selectText.default, {
     "aria-hidden": true,
     "data-element": "select-text",
     disabled: disabled,
     hasPlaceholder: hasPlaceholder,
     id: textId,
-    onClick: handleClick,
+    onClick: onClick,
     onKeyDown: onKeyDown,
     onMouseDown: onMouseDown,
     readOnly: readOnly,
     role: "button",
-    tabIndex: "-1",
+    tabIndex: -1,
     transparent: transparent,
     size: size
   }, hasPlaceholder ? placeholder : formattedValue);
 };
 
 SelectText.propTypes = {
-  /** If true the Component will be disabled */
-  disabled: _propTypes.default.bool,
-
-  /** Value to be displayed */
-  formattedValue: _propTypes.default.string,
-
-  /** Callback function for when the component is clicked. */
-  onClick: _propTypes.default.func,
-
-  /** Callback function for when the key is pressed when focused on Select Text. */
-  onKeyDown: _propTypes.default.func,
-
-  /** Callback function for when the left mouse key is pressed when focused on Select Text. */
-  onMouseDown: _propTypes.default.func,
-
-  /** Placeholder string to be displayed when formattedValue is empty */
-  placeholder: _propTypes.default.string,
-
-  /** If true the Component will be read-only */
-  readOnly: _propTypes.default.bool,
-
-  /** If true the component has no border and a transparent background */
-  transparent: _propTypes.default.bool,
-
-  /** Id of the Select Text element */
-  textId: _propTypes.default.string,
-
-  /** Component size */
-  size: _propTypes.default.string
+  "disabled": _propTypes.default.bool,
+  "formattedValue": _propTypes.default.string,
+  "isOpen": _propTypes.default.bool,
+  "labelId": _propTypes.default.string,
+  "onBlur": _propTypes.default.func,
+  "onClick": _propTypes.default.func,
+  "onFocus": _propTypes.default.func,
+  "onKeyDown": _propTypes.default.func,
+  "onMouseDown": _propTypes.default.func,
+  "placeholder": _propTypes.default.string,
+  "readOnly": _propTypes.default.bool,
+  "size": _propTypes.default.oneOf(["large", "medium", "small"]),
+  "textId": _propTypes.default.string,
+  "transparent": _propTypes.default.bool
 };
 var _default = SelectText;
 exports.default = _default;

package/lib/components/select/__internal__/select-text/select-text.style.d.ts

@@ -1,2 +1,7 @@
+import { SelectTextProps } from ".";
+interface StyledSelectTextProps extends Pick<SelectTextProps, "disabled" | "readOnly" | "transparent"> {
+    hasPlaceholder: boolean;
+    size: NonNullable<SelectTextProps["size"]>;
+}
+declare const StyledSelectText: import("styled-components").StyledComponent<"span", any, StyledSelectTextProps, never>;
 export default StyledSelectText;
-declare const StyledSelectText: import("styled-components").StyledComponent<"span", any, {}, never>;

package/lib/components/select/filterable-select/filterable-select.component.d.ts

@@ -0,0 +1,65 @@
+import React from "react";
+import { Side } from "@floating-ui/dom";
+import { ButtonProps } from "../../button";
+import { FormInputPropTypes } from "../select-textbox";
+export interface FilterableSelectProps extends Omit<FormInputPropTypes, "defaultValue" | "value"> {
+    /** Prop to specify the aria-label attribute of the component input */
+    "aria-label"?: string;
+    /** Prop to specify the aria-labeledby property of the component input */
+    "aria-labelledby"?: string;
+    /** Identifier used for testing purposes, applied to the root element of the component. */
+    "data-component"?: string;
+    /** Identifier used for testing purposes, applied to the root element of the component. */
+    "data-element"?: string;
+    /** Identifier used for testing purposes, applied to the root element of the component. */
+    "data-role"?: string;
+    /** Child components (such as Option or OptionRow) for the SelectList */
+    children: React.ReactNode;
+    /** The default selected value(s), when the component is operating in uncontrolled mode */
+    defaultValue?: string | Record<string, unknown>;
+    /** Boolean to toggle where SelectList is rendered in relation to the Select Input */
+    disablePortal?: boolean;
+    /** If true the loader animation is displayed in the option list */
+    isLoading?: boolean;
+    /** True for default text button or a Button Component to be rendered */
+    listActionButton?: boolean | React.ReactElement<ButtonProps>;
+    /** When true component will work in multi column mode.
+     * Children should consist of OptionRow components in this mode
+     */
+    multiColumn?: boolean;
+    /** A custom message to be displayed when any option does not match the filter text */
+    noResultsMessage?: string;
+    /** A custom callback for when the input text changes */
+    onFilterChange?: (filterText: string) => void;
+    /** A custom callback for when the dropdown menu opens */
+    onOpen?: () => void;
+    /** A callback for when the Action Button is triggered */
+    onListAction?: () => void;
+    /** A callback that is triggered when a user scrolls to the bottom of the list */
+    onListScrollBottom?: () => void;
+    /** If true the Component opens on focus */
+    openOnFocus?: boolean;
+    /** SelectList table header, should consist of multiple th elements.
+     * Works only in multiColumn mode
+     */
+    tableHeader?: React.ReactNode;
+    /** The selected value(s), when the component is operating in controlled mode */
+    value?: string | Record<string, unknown>;
+    /** Overrides the default tooltip position */
+    tooltipPosition?: "top" | "bottom" | "left" | "right";
+    /** Maximum list height - defaults to 180 */
+    listMaxHeight?: number;
+    /** Placement of the select list in relation to the input element */
+    listPlacement?: Side;
+    /** Use the opposite list placement if the set placement does not fit */
+    flipEnabled?: boolean;
+    /** Set this prop to enable a virtualised list of options. If it is not used then all options will be in the
+     * DOM at all times, which may cause performance problems on very large lists */
+    enableVirtualScroll?: boolean;
+    /** The number of options to render into the DOM at once, either side of the currently-visible ones.
+     * Higher values make for smoother scrolling but may impact performance.
+     * Only used if the `enableVirtualScroll` prop is set. */
+    virtualScrollOverscan?: number;
+}
+export declare const FilterableSelect: React.ForwardRefExoticComponent<FilterableSelectProps & React.RefAttributes<unknown>>;
+export default FilterableSelect;