@sap-ux/ui-components 1.14.0 → 1.14.1

package/dist/components/UIComboBox/UIComboBox.d.ts

@@ -1,209 +1,209 @@
-import React from 'react';
-import type { IComboBoxProps } from '@fluentui/react';
-import { IComboBox, IComboBoxOption, IOnRenderComboBoxLabelProps, SelectableOptionMenuItemType } from '@fluentui/react';
-import './UIComboBox.scss';
-import './Callout.scss';
-import type { UIMessagesExtendedProps } from '../../helper/ValidationMessage';
-export { IComboBoxOption as UIComboBoxOption, IComboBox as UIComboBoxRef, IOnRenderComboBoxLabelProps as UIOnRenderComboBoxLabelProps, SelectableOptionMenuItemType as UISelectableOptionMenuItemType };
-export interface UIComboBoxProps extends IComboBoxProps, UIMessagesExtendedProps {
-    wrapperRef?: React.RefObject<HTMLDivElement>;
-    highlight?: boolean;
-    useComboBoxAsMenuMinWidth?: boolean;
-    openMenuOnClick?: boolean;
-    onRefresh?(): void;
-    onHandleChange?(value: string | number): void;
-    tooltipRefreshButton?: string;
-    isLoading?: boolean;
-    isForceEnabled?: boolean;
-    readOnly?: boolean;
-    calloutCollisionTransformation?: boolean;
-}
-export interface UIComboBoxState {
-    minWidth?: number;
-    isListHidden?: boolean;
-}
-/**
- * UIComboBox component.
- *
- * @exports
- * @class {UIComboBox}
- * @extends {React.Component<UIComboBoxProps, UIComboBoxState>}
- */
-export declare class UIComboBox extends React.Component<UIComboBoxProps, UIComboBoxState> {
-    static defaultProps: {
-        openMenuOnClick: boolean;
-    };
-    private comboBox;
-    private comboboxDomRef;
-    private menuDomRef;
-    private selectedElement;
-    private query;
-    private ignoreOpenKeys;
-    private isListHidden;
-    private calloutCollisionTransform;
-    /**
-     * Initializes component properties.
-     *
-     * @param {UIComboBoxProps} props
-     */
-    constructor(props: UIComboBoxProps);
-    /**
-     *
-     * @param {UIComboBoxProps} nextProps
-     * @returns {boolean}
-     */
-    shouldComponentUpdate(nextProps: UIComboBoxProps): boolean;
-    /**
-     * Updates hidden options.
-     *
-     * @param {IComboBoxOption[]} opts
-     */
-    private updateHiddenOptions;
-    /**
-     * Method prevents cursor from jumping to the end of input.
-     *
-     * @param {React.FormEvent<IComboBox>} event Combobox event object
-     */
-    private setCaretPosition;
-    /**
-     * Method filters options and hides unmatched options.
-     *
-     * @param {React.FormEvent<IComboBox>} event Combobox event object
-     */
-    private onInput;
-    /**
-     * Method opens menu when user clicks on Combobox (input or button).
-     *
-     * @param event
-     */
-    private onClick;
-    /**
-     * Method handles keydown event and does following.
-     * 1. Fix for bug(in fluentui sources) regarding keyboard navigation when last item is not visible.
-     * 2. Opens list when user enters any key.
-     *
-     * @param {React.FormEvent<HTMLInputElement>} event Keydown event
-     */
-    private onKeyDown;
-    /**
-     * Method resets search query.
-     */
-    private reserQuery;
-    /**
-     * Method called on combobox option resolvation.
-     * We should not allow to add any custom option.
-     *
-     * @returns {IComboBoxOption[]} Array of combobox items.
-     */
-    private onResolveOptions;
-    /**
-     * Method called on combobox item render.
-     * We should pass query to it and avoid rendering if it is hidden.
-     *
-     * @param {IComboBoxOption} props Combobox item props.
-     * @param {Function} defaultRender Combobox item default renderer.
-     * @returns {JSX.Element | null} Element to render.
-     */
-    private onRenderItem;
-    /**
-     * Method to get current selected index.
-     *
-     * @returns {number | undefined} Selected item index.
-     */
-    private getCurrentSelectedIndex;
-    /**
-     * Return a value for the placeholder.
-     *
-     * @returns {string}
-     */
-    private getPlaceholder;
-    /**
-     * Method called on combobox item's option/label render.
-     * We should use different componenet which support highlighting - 'ComboboxSearchOption'.
-     *
-     * @param {IComboBoxOption} props Combobox item props.
-     * @param {Function} defaultRender Combobox item default renderer.
-     * @returns {JSX.Element | null} Element to render.
-     */
-    private readonly onRenderOption;
-    /**
-     * Method which determines what is next visible item - it is used to fix bug in fluentui sources..
-     *
-     * @param {number} index Current index.
-     * @param {boolean} forward Dirrection to look up.
-     * @returns {ComboboxItemInfo | null} Combobox item object.
-     */
-    private getNextVisibleItem;
-    /**
-     * Method is used as fix for bug(in fluentui sources) regarding keyboard navigation when last item is not visible.
-     *
-     * @param {boolean} forward Dirrection to look up.
-     * @returns {boolean} Returs true if method changed navigation.
-     */
-    private _setCyclingNavigation;
-    /**
-     * Method for property 'useComboBoxAsMenuMinWidth' - method resolves current dropdown width and updates state with latest value.
-     * 'minWidth' from state is used to set callout size in render.
-     */
-    private calculateMenuMinWidth;
-    /**
-     * Method called only when property 'highlight' is true.
-     * Method called after each value live change - we need recheck if there is any visible item after search is done.
-     * 1. If there no any visible item - we hide menu callout.
-     * 2. If there is any visible item - we show menu callout.
-     *
-     * @param option Selected option.
-     * @param index Selected option's index.
-     * @param value Text value entered in input.
-     */
-    private onPendingValueChanged;
-    /**
-     * Public method to close menu callout if it is open.
-     */
-    dismissMenu(): void;
-    /**
-     * Public method to set the focus on the combo box.
-     */
-    setFocus(): void;
-    /**
-     * Method called only when property 'onRefresh' has been defined.
-     * It is called when click on the refresh buttonIcon.
-     */
-    private handleRefreshButton;
-    handleChange: IComboBoxProps['onChange'];
-    private onRenderListLoading;
-    /**
-     * Handle multiselect change by avoiding 'blur' event.
-     * Problem is that blur event uses suggested value and toggles selection for it.
-     *
-     * @param {React.FormEvent<IComboBox>} event on change
-     * @param {IComboBoxOption} option changed option
-     * @param {number} index option index
-     * @param {string} value changed value
-     */
-    private onMultiSelectChange;
-    /**
-     * Method is used to fix bug in fluent ui.
-     * Bug is for multiselect combobox - when keyboard navigation is used, then scrollbar position is not updated to make selected option visible in viewport.
-     */
-    private onScrollToItem;
-    /**
-     * Method returns class names string depending on props and component state.
-     *
-     * @param {InputValidationMessageInfo} messageInfo Error/warning message if applied
-     * @returns {string} Class names of root combobox element.
-     */
-    private getClassNames;
-    /**
-     * Method returns properties for Autofill component(combobox's inner compnent for text input).
-     * Method handles 'highlight' and 'readOnly' properties.
-     *
-     * @returns {IAutofillProps} Properties for Autofill component.
-     */
-    private getAutofillProps;
-    /**
-     * @returns {JSX.Element}
-     */
-    render(): JSX.Element;
-}
+import React from 'react';
+import type { IComboBoxProps } from '@fluentui/react';
+import { IComboBox, IComboBoxOption, IOnRenderComboBoxLabelProps, SelectableOptionMenuItemType } from '@fluentui/react';
+import './UIComboBox.scss';
+import './Callout.scss';
+import type { UIMessagesExtendedProps } from '../../helper/ValidationMessage';
+export { IComboBoxOption as UIComboBoxOption, IComboBox as UIComboBoxRef, IOnRenderComboBoxLabelProps as UIOnRenderComboBoxLabelProps, SelectableOptionMenuItemType as UISelectableOptionMenuItemType };
+export interface UIComboBoxProps extends IComboBoxProps, UIMessagesExtendedProps {
+    wrapperRef?: React.RefObject<HTMLDivElement>;
+    highlight?: boolean;
+    useComboBoxAsMenuMinWidth?: boolean;
+    openMenuOnClick?: boolean;
+    onRefresh?(): void;
+    onHandleChange?(value: string | number): void;
+    tooltipRefreshButton?: string;
+    isLoading?: boolean;
+    isForceEnabled?: boolean;
+    readOnly?: boolean;
+    calloutCollisionTransformation?: boolean;
+}
+export interface UIComboBoxState {
+    minWidth?: number;
+    isListHidden?: boolean;
+}
+/**
+ * UIComboBox component.
+ *
+ * @exports
+ * @class {UIComboBox}
+ * @extends {React.Component<UIComboBoxProps, UIComboBoxState>}
+ */
+export declare class UIComboBox extends React.Component<UIComboBoxProps, UIComboBoxState> {
+    static defaultProps: {
+        openMenuOnClick: boolean;
+    };
+    private comboBox;
+    private comboboxDomRef;
+    private menuDomRef;
+    private selectedElement;
+    private query;
+    private ignoreOpenKeys;
+    private isListHidden;
+    private calloutCollisionTransform;
+    /**
+     * Initializes component properties.
+     *
+     * @param {UIComboBoxProps} props
+     */
+    constructor(props: UIComboBoxProps);
+    /**
+     *
+     * @param {UIComboBoxProps} nextProps
+     * @returns {boolean}
+     */
+    shouldComponentUpdate(nextProps: UIComboBoxProps): boolean;
+    /**
+     * Updates hidden options.
+     *
+     * @param {IComboBoxOption[]} opts
+     */
+    private updateHiddenOptions;
+    /**
+     * Method prevents cursor from jumping to the end of input.
+     *
+     * @param {React.FormEvent<IComboBox>} event Combobox event object
+     */
+    private setCaretPosition;
+    /**
+     * Method filters options and hides unmatched options.
+     *
+     * @param {React.FormEvent<IComboBox>} event Combobox event object
+     */
+    private onInput;
+    /**
+     * Method opens menu when user clicks on Combobox (input or button).
+     *
+     * @param event
+     */
+    private onClick;
+    /**
+     * Method handles keydown event and does following.
+     * 1. Fix for bug(in fluentui sources) regarding keyboard navigation when last item is not visible.
+     * 2. Opens list when user enters any key.
+     *
+     * @param {React.FormEvent<HTMLInputElement>} event Keydown event
+     */
+    private onKeyDown;
+    /**
+     * Method resets search query.
+     */
+    private reserQuery;
+    /**
+     * Method called on combobox option resolvation.
+     * We should not allow to add any custom option.
+     *
+     * @returns {IComboBoxOption[]} Array of combobox items.
+     */
+    private onResolveOptions;
+    /**
+     * Method called on combobox item render.
+     * We should pass query to it and avoid rendering if it is hidden.
+     *
+     * @param {IComboBoxOption} props Combobox item props.
+     * @param {Function} defaultRender Combobox item default renderer.
+     * @returns {JSX.Element | null} Element to render.
+     */
+    private onRenderItem;
+    /**
+     * Method to get current selected index.
+     *
+     * @returns {number | undefined} Selected item index.
+     */
+    private getCurrentSelectedIndex;
+    /**
+     * Return a value for the placeholder.
+     *
+     * @returns {string}
+     */
+    private getPlaceholder;
+    /**
+     * Method called on combobox item's option/label render.
+     * We should use different componenet which support highlighting - 'ComboboxSearchOption'.
+     *
+     * @param {IComboBoxOption} props Combobox item props.
+     * @param {Function} defaultRender Combobox item default renderer.
+     * @returns {JSX.Element | null} Element to render.
+     */
+    private readonly onRenderOption;
+    /**
+     * Method which determines what is next visible item - it is used to fix bug in fluentui sources..
+     *
+     * @param {number} index Current index.
+     * @param {boolean} forward Dirrection to look up.
+     * @returns {ComboboxItemInfo | null} Combobox item object.
+     */
+    private getNextVisibleItem;
+    /**
+     * Method is used as fix for bug(in fluentui sources) regarding keyboard navigation when last item is not visible.
+     *
+     * @param {boolean} forward Dirrection to look up.
+     * @returns {boolean} Returs true if method changed navigation.
+     */
+    private _setCyclingNavigation;
+    /**
+     * Method for property 'useComboBoxAsMenuMinWidth' - method resolves current dropdown width and updates state with latest value.
+     * 'minWidth' from state is used to set callout size in render.
+     */
+    private calculateMenuMinWidth;
+    /**
+     * Method called only when property 'highlight' is true.
+     * Method called after each value live change - we need recheck if there is any visible item after search is done.
+     * 1. If there no any visible item - we hide menu callout.
+     * 2. If there is any visible item - we show menu callout.
+     *
+     * @param option Selected option.
+     * @param index Selected option's index.
+     * @param value Text value entered in input.
+     */
+    private onPendingValueChanged;
+    /**
+     * Public method to close menu callout if it is open.
+     */
+    dismissMenu(): void;
+    /**
+     * Public method to set the focus on the combo box.
+     */
+    setFocus(): void;
+    /**
+     * Method called only when property 'onRefresh' has been defined.
+     * It is called when click on the refresh buttonIcon.
+     */
+    private handleRefreshButton;
+    handleChange: IComboBoxProps['onChange'];
+    private onRenderListLoading;
+    /**
+     * Handle multiselect change by avoiding 'blur' event.
+     * Problem is that blur event uses suggested value and toggles selection for it.
+     *
+     * @param {React.FormEvent<IComboBox>} event on change
+     * @param {IComboBoxOption} option changed option
+     * @param {number} index option index
+     * @param {string} value changed value
+     */
+    private onMultiSelectChange;
+    /**
+     * Method is used to fix bug in fluent ui.
+     * Bug is for multiselect combobox - when keyboard navigation is used, then scrollbar position is not updated to make selected option visible in viewport.
+     */
+    private onScrollToItem;
+    /**
+     * Method returns class names string depending on props and component state.
+     *
+     * @param {InputValidationMessageInfo} messageInfo Error/warning message if applied
+     * @returns {string} Class names of root combobox element.
+     */
+    private getClassNames;
+    /**
+     * Method returns properties for Autofill component(combobox's inner compnent for text input).
+     * Method handles 'highlight' and 'readOnly' properties.
+     *
+     * @returns {IAutofillProps} Properties for Autofill component.
+     */
+    private getAutofillProps;
+    /**
+     * @returns {JSX.Element}
+     */
+    render(): JSX.Element;
+}
 //# sourceMappingURL=UIComboBox.d.ts.map