carbon-react 118.1.0 → 118.2.0

package/esm/components/select/select.style.d.ts

@@ -0,0 +1,8 @@
+import { SimpleSelectProps } from "./simple-select";
+export interface StyledSelectProps extends Pick<SimpleSelectProps, "disabled" | "readOnly" | "transparent"> {
+    hasTextCursor?: boolean;
+    isOpen: boolean;
+    size?: string;
+}
+declare const StyledSelect: import("styled-components").StyledComponent<"div", any, StyledSelectProps, never>;
+export default StyledSelect;

package/esm/components/select/simple-select/index.d.ts

@@ -1 +1,2 @@
-export { default } from "./simple-select";
+export { default } from "./simple-select.component";
+export type { SimpleSelectProps } from "./simple-select.component";

package/esm/components/select/simple-select/index.js

@@ -0,0 +1 @@
+export { default } from "./simple-select.component";

package/esm/components/select/simple-select/simple-select.component.d.ts

@@ -0,0 +1,58 @@
+import React from "react";
+import { Side } from "@floating-ui/dom";
+import { FormInputPropTypes } from "../select-textbox";
+export interface SimpleSelectProps 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;
+    /** When true component will work in multi column mode.
+     * Children should consist of OptionRow components in this mode
+     */
+    multiColumn?: boolean;
+    /** A callback that is triggered when a user scrolls to the bottom of the list */
+    onListScrollBottom?: () => void;
+    /** A custom callback for when the dropdown menu opens */
+    onOpen?: () => 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;
+    /** If true the component input has no border and is transparent */
+    transparent?: boolean;
+    /** 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 SimpleSelect: React.ForwardRefExoticComponent<SimpleSelectProps & React.RefAttributes<unknown>>;
+export default SimpleSelect;