@bonprix-ds/react-select 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,70 @@
+import { default as default_2 } from 'react';
+import { FC } from 'react';
+import { ReactNode } from 'react';
+import { RefObject } from 'react';
+
+declare interface BaseProps {
+    /** The id of the input field. */
+    id?: string;
+    /** The visible label for the input field. */
+    label: string;
+    /** This is where Select.Item subcomponents should be placed. */
+    children: default_2.ReactNode;
+    /** The name of the input field. */
+    name?: string;
+    /** If `true`, disables the input. */
+    disabled?: boolean;
+    /** If `true`, the input field is in an error state. Required for `errorText` to be shown. */
+    error?: boolean;
+    /** If `true`, marks the input as required. */
+    required?: boolean;
+    /** A text that further describes the field and helps with filling out the form correctly. */
+    helperText?: string;
+    /** A text message that appears when the field is invalid. Only visible when `error` is set to `true`. */
+    errorText?: string;
+    /** <a href="https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby" target="_blank">ARIA: aria-describedby attribute.</a> */
+    describedBy?: string;
+    /** Reference to the root element of the select. */
+    ref?: RefObject<HTMLButtonElement>;
+}
+
+declare interface ControlledSelectProps extends BaseProps {
+    /** The current value of the select. Should be used in conjunction with `onValueChange`. */
+    value: string;
+    /** The default value of the select. Should be used when select is uncontrolled. */
+    defaultValue?: never;
+    /** Callback that is triggered when the value changes. */
+    onValueChange: (value: string) => void;
+}
+
+declare interface Props {
+    /** The value of the select item. This will be used as the value when the select is submitted. */
+    value: string;
+    /** The content text of the select item. */
+    children?: ReactNode;
+    /** If `true`, the select item will be disabled and not selectable. */
+    disabled?: boolean;
+    /** If `true`, the select item will be hidden from the dropdown menu. */
+    hidden?: boolean;
+    /** A reference to the root element of the select item. */
+    ref?: RefObject<HTMLDivElement>;
+}
+
+declare const Select: FC<SelectProps> & Subcomponents;
+export default Select;
+
+declare const SelectItem: FC<Props>;
+
+export declare type SelectProps = ControlledSelectProps | UncontrolledSelectProps;
+
+declare interface Subcomponents {
+    Item: typeof SelectItem;
+}
+
+declare interface UncontrolledSelectProps extends BaseProps {
+    value?: never;
+    defaultValue: string;
+    onValueChange?: (value: string) => void;
+}
+
+export { }