@procore/core-react 11.8.0-rc.6 → 11.8.0-rc.9

package/dist/SuperSelect/useSuperSelect.d.ts

@@ -1,51 +1,421 @@
 /// <reference types="lodash" />
 import React from 'react';
-import { VirtuosoHandle } from 'react-virtuoso';
-import { TypeaheadInputProps, TypeaheadProps } from '../Typeahead/Typeahead.types';
+import { VirtuosoHandle, VirtuosoProps } from 'react-virtuoso';
 import { SuperSelectConfig, SuperSelectOption, SuperSelectValue, SuperSelectValuePrimitive } from './SuperSelect.types';
-export declare function useSuperSelect({ components, draggable, defaultValue, disabled, getOptionAvatar, getOptionGroup, getOptionIcon, setOptionGroup, getOptionIsBatch, getOptionIsDisabled, getOptionLabel, getOptionTitle, getOptionTooltip, getOptionValue, onManualSort, multiple, onChange, options: sourceOptions, search, sort, value: value_, }: SuperSelectConfig): {
-    activeMenuIndex: number | null;
-    activeTokenIndex: number | null;
-    components: import("./SuperSelect.types").SuperSelectComponents | undefined;
-    draggable: boolean | undefined;
-    floating: import("@floating-ui/react-dom-interactions").UseFloatingReturn<HTMLElement>;
-    getClearProps: () => React.AriaAttributes & React.HTMLAttributes<HTMLElement>;
-    getFloatingProps: (userProps?: any) => Record<string, unknown>;
-    getItemProps: (userProps?: any) => Record<string, unknown>;
-    getMultiInputProps: () => React.AriaAttributes & React.InputHTMLAttributes<HTMLInputElement>;
-    getOptionGroup: (option: any) => string;
-    getOptionIcon: ((option: any) => string) | undefined;
-    getOptionAvatar: ((option: any) => string) | undefined;
-    getOptionIsBatch: (option: any) => boolean;
-    getOptionIsDisabled: (option: any) => boolean;
-    getOptionIsOptgroup: (item: any) => item is import("./SuperSelect.types").SuperSelectOptgroup;
-    getOptionLabel: (option: any) => string;
-    getOptionTitle: ((option: any) => string) | undefined;
-    getOptionTooltip: ((option: any) => string) | undefined;
-    getOptionValue: (option: any) => SuperSelectValuePrimitive;
-    getReferenceProps: (userProps?: any) => Record<string, unknown>;
-    getTokenClearProps: (index: number) => React.AriaAttributes & React.SVGAttributes<SVGElement>;
-    getTypeaheadProps: () => React.AriaAttributes & TypeaheadInputProps & TypeaheadProps;
-    isEmpty: () => boolean;
-    isSelected: (option: SuperSelectOption) => boolean;
-    listId: string;
-    maxHeight: number;
-    multiple: boolean;
-    navigationListRef: React.MutableRefObject<(HTMLElement | null)[]>;
-    onSelect: (option: SuperSelectOption) => void;
-    open: boolean;
-    sourceOptions: any[];
-    options: any[];
-    overlayId: string;
-    searchValue: string;
-    selectedIndex: number;
-    selectedOption: any;
-    selectedLabel: string;
-    setOpen: React.Dispatch<React.SetStateAction<boolean>>;
-    setPointer: React.Dispatch<React.SetStateAction<boolean>>;
-    setSearchValue: import("lodash").DebouncedFunc<React.Dispatch<React.SetStateAction<string>>>;
-    value: SuperSelectValue;
-    virtuoso: React.RefObject<VirtuosoHandle>;
-    width: number;
-    onDragEnd: (result: any) => void;
+export declare function useSuperSelect({ block, components: customComponents, defaultValue, disabled, draggable, emptyMessage, error, footer, getOptionGroup, getOptionIsBatch, getOptionIsDisabled, getOptionLabel, getOptionValue, header, loading, multiple, onChange, onManualSort, options: sourceOptions, placeholder, preset, search, selectionStyle, setOptionGroup, sort, tabIndex, value: value_, }: SuperSelectConfig): {
+    config: {
+        block: boolean;
+        disabled: boolean;
+        draggable: boolean;
+        emptyMessage: string;
+        error: boolean | undefined;
+        footer: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined;
+        header: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined;
+        placeholder: string | undefined;
+        preset: import("./SuperSelect.types").SuperSelectPreset;
+        selectionStyle: "checkbox" | "highlight" | "checkmark";
+        tabIndex: number;
+        loading: boolean;
+        multiple: boolean;
+    };
+    components: {
+        Overlay: React.ForwardRefExoticComponent<Pick<any, string | number | symbol> & React.RefAttributes<HTMLElement>>;
+        SingleTrigger: (props: any) => JSX.Element;
+        MultiTrigger: (props: any) => JSX.Element | null;
+        Trigger: React.ForwardRefExoticComponent<Pick<any, string | number | symbol> & React.RefAttributes<HTMLDivElement>>;
+        Indicators: (props: any) => JSX.Element;
+        Label: React.ForwardRefExoticComponent<{
+            hoverable: boolean;
+        } & React.RefAttributes<HTMLDivElement>>;
+        Loading: () => JSX.Element;
+        ArrowContainer: (props: any) => JSX.Element;
+        Arrow: ({ up, down, left, right, width, height, border, }: any) => JSX.Element;
+        Clear: () => JSX.Element;
+        MultiInputContainer: (props: {
+            children?: React.ReactNode;
+        }) => JSX.Element;
+        MultiInput: (props: any) => JSX.Element;
+        MultiValue: (props: any) => JSX.Element;
+        MultiValueContainer: (props: any) => JSX.Element;
+        SearchContainer: (props: any) => JSX.Element;
+        Search: (props: any) => JSX.Element;
+        Header: (props: any) => JSX.Element;
+        Footer: (props: any) => JSX.Element;
+        EmptyMessage: (props: any) => JSX.Element;
+        Options: (props: {
+            children?: React.ReactNode;
+        } & import("../_utils/types").DivAttributes) => JSX.Element;
+        Group: (props: {
+            children?: React.ReactNode;
+        }) => JSX.Element;
+        Item: React.ForwardRefExoticComponent<import("./SuperSelect.types").SuperSelectMenuItemProps & React.RefAttributes<HTMLDivElement>>;
+        OptionGroupHeader: ({ optgroup }: any) => JSX.Element;
+        OptionLabel: ({ option }: any) => JSX.Element;
+        OptionContent: ({ option }: any) => JSX.Element;
+        DraggableOptionContent: ({ index, option }: any) => JSX.Element;
+        DragHandle: (props: any) => JSX.Element;
+        CheckboxContainer: (props: any) => JSX.Element;
+        Checkbox: (props: any) => JSX.Element;
+        CheckmarkContainer: (props: any) => JSX.Element;
+        Checkmark: (props: any) => JSX.Element;
+    };
+    state: {
+        activeMenuIndex: number | null;
+        activeTokenIndex: number | null;
+        isEmpty: () => boolean;
+        listContainerHeight: number;
+        listId: string;
+        maxHeight: number;
+        onDragEnd: (result: any) => void;
+        onSelect: (option: SuperSelectOption) => void;
+        open: boolean;
+        options: any[];
+        overlayId: string;
+        searchValue: string;
+        selectedIndex: number;
+        selectedLabel: string;
+        selectedOption: any;
+        setOpen: React.Dispatch<React.SetStateAction<boolean>>;
+        setPointer: React.Dispatch<React.SetStateAction<boolean>>;
+        setSearchValue: import("lodash").DebouncedFunc<React.Dispatch<React.SetStateAction<string>>>;
+        sourceOptions: any[];
+        value: SuperSelectValue;
+        width: number;
+    };
+    props: {
+        clear: () => {
+            'aria-hidden': boolean;
+            'aria-label': string;
+            onClick(e: React.MouseEvent): void;
+        };
+        emptyMessage: () => {
+            emptyMessage: string;
+        };
+        footer: () => {
+            ref: (el: HTMLElement | null) => void;
+            onKeyDown: (e: React.KeyboardEvent) => void;
+        };
+        header: () => {
+            ref: (el: HTMLElement | null) => void;
+        };
+        item: (userProps?: any) => Record<string, unknown>;
+        label: () => {
+            $hoverable: boolean;
+        };
+        menu: () => {
+            scrollable: boolean;
+            style: {
+                height: number;
+            };
+        };
+        multiInput: () => React.AriaAttributes & React.InputHTMLAttributes<HTMLInputElement> & {
+            ref: React.Ref<HTMLInputElement>;
+        };
+        overlay: (userProps?: any) => Record<string, unknown>;
+        search: () => {
+            'aria-controls': string;
+            onChange(value: string): void;
+            placeholder: string;
+        };
+        searchContainer: () => {
+            ref: (el: HTMLElement | null) => void;
+        };
+        tokenClear: (index: number) => {
+            onClick(e: React.MouseEvent): void;
+        };
+        trigger: (userProps?: any) => Record<string, unknown>;
+        virtuoso: () => VirtuosoProps<{}, {}>;
+    };
+    option: {
+        group: (option: any) => string;
+        isBatch: (option: any) => boolean;
+        isSelected: (option: SuperSelectOption) => boolean;
+        isDisabled: (option: any) => boolean;
+        isOptgroup: (item: any) => item is import("./SuperSelect.types").SuperSelectOptgroup;
+        label: (option: any) => string;
+        value: (option: any) => SuperSelectValuePrimitive;
+    };
+    refs: {
+        floating: import("@floating-ui/react-dom-interactions").UseFloatingReturn<HTMLElement>;
+        navigationList: React.MutableRefObject<(HTMLElement | null)[]>;
+        virtuoso: React.RefObject<VirtuosoHandle>;
+    };
+};
+export declare const SuperSelectContext: React.Context<{
+    config: {
+        block: boolean;
+        disabled: boolean;
+        draggable: boolean;
+        emptyMessage: string;
+        error: boolean | undefined;
+        footer: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined;
+        header: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined;
+        placeholder: string | undefined;
+        preset: import("./SuperSelect.types").SuperSelectPreset;
+        selectionStyle: "checkbox" | "highlight" | "checkmark";
+        tabIndex: number;
+        loading: boolean;
+        multiple: boolean;
+    };
+    components: {
+        Overlay: React.ForwardRefExoticComponent<Pick<any, string | number | symbol> & React.RefAttributes<HTMLElement>>;
+        SingleTrigger: (props: any) => JSX.Element;
+        MultiTrigger: (props: any) => JSX.Element | null;
+        Trigger: React.ForwardRefExoticComponent<Pick<any, string | number | symbol> & React.RefAttributes<HTMLDivElement>>;
+        Indicators: (props: any) => JSX.Element;
+        Label: React.ForwardRefExoticComponent<{
+            hoverable: boolean;
+        } & React.RefAttributes<HTMLDivElement>>;
+        Loading: () => JSX.Element;
+        ArrowContainer: (props: any) => JSX.Element;
+        Arrow: ({ up, down, left, right, width, height, border, }: any) => JSX.Element;
+        Clear: () => JSX.Element;
+        MultiInputContainer: (props: {
+            children?: React.ReactNode;
+        }) => JSX.Element;
+        MultiInput: (props: any) => JSX.Element;
+        MultiValue: (props: any) => JSX.Element;
+        MultiValueContainer: (props: any) => JSX.Element;
+        SearchContainer: (props: any) => JSX.Element;
+        Search: (props: any) => JSX.Element;
+        Header: (props: any) => JSX.Element;
+        Footer: (props: any) => JSX.Element;
+        EmptyMessage: (props: any) => JSX.Element;
+        Options: (props: {
+            children?: React.ReactNode;
+        } & import("../_utils/types").DivAttributes) => JSX.Element;
+        Group: (props: {
+            children?: React.ReactNode;
+        }) => JSX.Element;
+        Item: React.ForwardRefExoticComponent<import("./SuperSelect.types").SuperSelectMenuItemProps & React.RefAttributes<HTMLDivElement>>;
+        OptionGroupHeader: ({ optgroup }: any) => JSX.Element;
+        OptionLabel: ({ option }: any) => JSX.Element;
+        OptionContent: ({ option }: any) => JSX.Element;
+        DraggableOptionContent: ({ index, option }: any) => JSX.Element;
+        DragHandle: (props: any) => JSX.Element;
+        CheckboxContainer: (props: any) => JSX.Element;
+        Checkbox: (props: any) => JSX.Element;
+        CheckmarkContainer: (props: any) => JSX.Element;
+        Checkmark: (props: any) => JSX.Element;
+    };
+    state: {
+        activeMenuIndex: number | null;
+        activeTokenIndex: number | null;
+        isEmpty: () => boolean;
+        listContainerHeight: number;
+        listId: string;
+        maxHeight: number;
+        onDragEnd: (result: any) => void;
+        onSelect: (option: SuperSelectOption) => void;
+        open: boolean;
+        options: any[];
+        overlayId: string;
+        searchValue: string;
+        selectedIndex: number;
+        selectedLabel: string;
+        selectedOption: any;
+        setOpen: React.Dispatch<React.SetStateAction<boolean>>;
+        setPointer: React.Dispatch<React.SetStateAction<boolean>>;
+        setSearchValue: import("lodash").DebouncedFunc<React.Dispatch<React.SetStateAction<string>>>;
+        sourceOptions: any[];
+        value: SuperSelectValue;
+        width: number;
+    };
+    props: {
+        clear: () => {
+            'aria-hidden': boolean;
+            'aria-label': string;
+            onClick(e: React.MouseEvent): void;
+        };
+        emptyMessage: () => {
+            emptyMessage: string;
+        };
+        footer: () => {
+            ref: (el: HTMLElement | null) => void;
+            onKeyDown: (e: React.KeyboardEvent) => void;
+        };
+        header: () => {
+            ref: (el: HTMLElement | null) => void;
+        };
+        item: (userProps?: any) => Record<string, unknown>;
+        label: () => {
+            $hoverable: boolean;
+        };
+        menu: () => {
+            scrollable: boolean;
+            style: {
+                height: number;
+            };
+        };
+        multiInput: () => React.AriaAttributes & React.InputHTMLAttributes<HTMLInputElement> & {
+            ref: React.Ref<HTMLInputElement>;
+        };
+        overlay: (userProps?: any) => Record<string, unknown>;
+        search: () => {
+            'aria-controls': string;
+            onChange(value: string): void;
+            placeholder: string;
+        };
+        searchContainer: () => {
+            ref: (el: HTMLElement | null) => void;
+        };
+        tokenClear: (index: number) => {
+            onClick(e: React.MouseEvent): void;
+        };
+        trigger: (userProps?: any) => Record<string, unknown>;
+        virtuoso: () => VirtuosoProps<{}, {}>;
+    };
+    option: {
+        group: (option: any) => string;
+        isBatch: (option: any) => boolean;
+        isSelected: (option: SuperSelectOption) => boolean;
+        isDisabled: (option: any) => boolean;
+        isOptgroup: (item: any) => item is import("./SuperSelect.types").SuperSelectOptgroup;
+        label: (option: any) => string;
+        value: (option: any) => SuperSelectValuePrimitive;
+    };
+    refs: {
+        floating: import("@floating-ui/react-dom-interactions").UseFloatingReturn<HTMLElement>;
+        navigationList: React.MutableRefObject<(HTMLElement | null)[]>;
+        virtuoso: React.RefObject<VirtuosoHandle>;
+    };
+} | null>;
+export declare function useSuperSelectContext(): {
+    config: {
+        block: boolean;
+        disabled: boolean;
+        draggable: boolean;
+        emptyMessage: string;
+        error: boolean | undefined;
+        footer: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined;
+        header: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined;
+        placeholder: string | undefined;
+        preset: import("./SuperSelect.types").SuperSelectPreset;
+        selectionStyle: "checkbox" | "highlight" | "checkmark";
+        tabIndex: number;
+        loading: boolean;
+        multiple: boolean;
+    };
+    components: {
+        Overlay: React.ForwardRefExoticComponent<Pick<any, string | number | symbol> & React.RefAttributes<HTMLElement>>;
+        SingleTrigger: (props: any) => JSX.Element;
+        MultiTrigger: (props: any) => JSX.Element | null;
+        Trigger: React.ForwardRefExoticComponent<Pick<any, string | number | symbol> & React.RefAttributes<HTMLDivElement>>;
+        Indicators: (props: any) => JSX.Element;
+        Label: React.ForwardRefExoticComponent<{
+            hoverable: boolean;
+        } & React.RefAttributes<HTMLDivElement>>;
+        Loading: () => JSX.Element;
+        ArrowContainer: (props: any) => JSX.Element;
+        Arrow: ({ up, down, left, right, width, height, border, }: any) => JSX.Element;
+        Clear: () => JSX.Element;
+        MultiInputContainer: (props: {
+            children?: React.ReactNode;
+        }) => JSX.Element;
+        MultiInput: (props: any) => JSX.Element;
+        MultiValue: (props: any) => JSX.Element;
+        MultiValueContainer: (props: any) => JSX.Element;
+        SearchContainer: (props: any) => JSX.Element;
+        Search: (props: any) => JSX.Element;
+        Header: (props: any) => JSX.Element;
+        Footer: (props: any) => JSX.Element;
+        EmptyMessage: (props: any) => JSX.Element;
+        Options: (props: {
+            children?: React.ReactNode;
+        } & import("../_utils/types").DivAttributes) => JSX.Element;
+        Group: (props: {
+            children?: React.ReactNode;
+        }) => JSX.Element;
+        Item: React.ForwardRefExoticComponent<import("./SuperSelect.types").SuperSelectMenuItemProps & React.RefAttributes<HTMLDivElement>>;
+        OptionGroupHeader: ({ optgroup }: any) => JSX.Element;
+        OptionLabel: ({ option }: any) => JSX.Element;
+        OptionContent: ({ option }: any) => JSX.Element;
+        DraggableOptionContent: ({ index, option }: any) => JSX.Element;
+        DragHandle: (props: any) => JSX.Element;
+        CheckboxContainer: (props: any) => JSX.Element;
+        Checkbox: (props: any) => JSX.Element;
+        CheckmarkContainer: (props: any) => JSX.Element;
+        Checkmark: (props: any) => JSX.Element;
+    };
+    state: {
+        activeMenuIndex: number | null;
+        activeTokenIndex: number | null;
+        isEmpty: () => boolean;
+        listContainerHeight: number;
+        listId: string;
+        maxHeight: number;
+        onDragEnd: (result: any) => void;
+        onSelect: (option: any) => void;
+        open: boolean;
+        options: any[];
+        overlayId: string;
+        searchValue: string;
+        selectedIndex: number;
+        selectedLabel: string;
+        selectedOption: any;
+        setOpen: React.Dispatch<React.SetStateAction<boolean>>;
+        setPointer: React.Dispatch<React.SetStateAction<boolean>>;
+        setSearchValue: import("lodash").DebouncedFunc<React.Dispatch<React.SetStateAction<string>>>;
+        sourceOptions: any[];
+        value: SuperSelectValue;
+        width: number;
+    };
+    props: {
+        clear: () => {
+            'aria-hidden': boolean;
+            'aria-label': string;
+            onClick(e: React.MouseEvent<Element, MouseEvent>): void;
+        };
+        emptyMessage: () => {
+            emptyMessage: string;
+        };
+        footer: () => {
+            ref: (el: HTMLElement | null) => void;
+            onKeyDown: (e: React.KeyboardEvent<Element>) => void;
+        };
+        header: () => {
+            ref: (el: HTMLElement | null) => void;
+        };
+        item: (userProps?: any) => Record<string, unknown>;
+        label: () => {
+            $hoverable: boolean;
+        };
+        menu: () => {
+            scrollable: boolean;
+            style: {
+                height: number;
+            };
+        };
+        multiInput: () => React.AriaAttributes & React.InputHTMLAttributes<HTMLInputElement> & {
+            ref: React.Ref<HTMLInputElement>;
+        };
+        overlay: (userProps?: any) => Record<string, unknown>;
+        search: () => {
+            'aria-controls': string;
+            onChange(value: string): void;
+            placeholder: string;
+        };
+        searchContainer: () => {
+            ref: (el: HTMLElement | null) => void;
+        };
+        tokenClear: (index: number) => {
+            onClick(e: React.MouseEvent<Element, MouseEvent>): void;
+        };
+        trigger: (userProps?: any) => Record<string, unknown>;
+        virtuoso: () => VirtuosoProps<{}, {}>;
+    };
+    option: {
+        group: (option: any) => string;
+        isBatch: (option: any) => boolean;
+        isSelected: (option: any) => boolean;
+        isDisabled: (option: any) => boolean;
+        isOptgroup: (item: any) => item is import("./SuperSelect.types").SuperSelectOptgroup;
+        label: (option: any) => string;
+        value: (option: any) => SuperSelectValuePrimitive;
+    };
+    refs: {
+        floating: import("@floating-ui/react-dom-interactions").UseFloatingReturn<HTMLElement>;
+        navigationList: React.MutableRefObject<(HTMLElement | null)[]>;
+        virtuoso: React.RefObject<VirtuosoHandle>;
+    };
 };