@devtron-labs/devtron-fe-common-lib 0.2.8-beta-1 → 0.2.9-beta-1

package/dist/Shared/Components/SelectPicker/FilterSelectPicker.d.ts

@@ -0,0 +1,4 @@
+import { FilterSelectPickerProps } from './type';
+
+declare const FilterSelectPicker: ({ appliedFilterOptions, handleApplyFilter, options, ...props }: FilterSelectPickerProps) => JSX.Element;
+export default FilterSelectPicker;

package/dist/Shared/Components/SelectPicker/SelectPicker.component.d.ts

@@ -80,6 +80,60 @@ import { SelectPickerProps } from './type';
  * ```tsx
  * <SelectPicker ... showSelectedOptionsCount />
  * ```
+ * @example Multi Select
+ * ```tsx
+ * <SelectPicker ... isMulti />
+ * ```
+ *
+ * @example Creatable Multi Select
+ * ```tsx
+ * <SelectPicker
+ *      ...
+ *      isMulti
+ *      multiSelectProps={{
+ *          isCreatable: true
+ *      }}
+ * />
+ * ```
+ *
+ * @example Multi Select with group heading selectable
+ * ```tsx
+ * <SelectPicker
+ *      ...
+ *      isMulti
+ *      multiSelectProps={{
+ *          isGroupHeadingSelectable: true
+ *      }}
+ * />
+ * ```
+ *
+ * @example Multi Select with selected option validator
+ * ```tsx
+ * <SelectPicker
+ *      ...
+ *      isMulti
+ *      multiSelectProps={{
+ *          getIsOptionValid: (option) => boolean
+ *      }}
+ * />
+ * ```
+ *
+ * @example Custom options rendering support (menuIsOpen needs to be handled by consumer)
+ * ```tsx
+ * <SelectPicker
+ *      ...
+ *      shouldRenderCustomOptions
+ *      renderCustomOptions={() => <div />}
+ * />
+ * ```
+ *
+ * @example Align the menu at the right most end
+ * ```tsx
+ * <SelectPicker
+ *      ...
+ *      shouldMenuAlignRight
+ * />
+ * ```
  */
-declare const SelectPicker: ({ error, icon, renderMenuListFooter, helperText, placeholder, label, showSelectedOptionIcon, size, disabledTippyContent, showSelectedOptionsCount, menuSize, variant, ...props }: SelectPickerProps) => JSX.Element;
+declare const SelectPicker: <OptionValue, IsMulti extends boolean>({ error, icon, renderMenuListFooter, helperText, placeholder, label, showSelectedOptionIcon, size, disabledTippyContent, showSelectedOptionsCount, menuSize, menuPosition, variant, disableDescriptionEllipsis, multiSelectProps, isMulti, name, classNamePrefix, renderCustomOptions, shouldRenderCustomOptions, isSearchable, selectRef, shouldMenuAlignRight, fullWidth, customSelectedOptionsCount, ...props }: SelectPickerProps<OptionValue, IsMulti>) => JSX.Element;
 export default SelectPicker;

package/dist/Shared/Components/SelectPicker/common.d.ts

@@ -1,10 +1,13 @@
-import { DropdownIndicatorProps, ControlProps, OptionProps, ClearIndicatorProps, ValueContainerProps, MenuListProps } from 'react-select';
-import { SelectPickerOptionType, SelectPickerProps } from './type';
+import { DropdownIndicatorProps, ControlProps, OptionProps, ClearIndicatorProps, ValueContainerProps, MenuListProps, MultiValueRemoveProps, MultiValueProps } from 'react-select';
+import { SelectPickerGroupHeadingProps, SelectPickerOptionType, SelectPickerProps } from './type';
 
-export declare const SelectPickerDropdownIndicator: (props: DropdownIndicatorProps<SelectPickerOptionType>) => JSX.Element;
-export declare const SelectPickerClearIndicator: (props: ClearIndicatorProps<SelectPickerOptionType>) => JSX.Element;
-export declare const SelectPickerControl: ({ icon, showSelectedOptionIcon, ...props }: ControlProps<SelectPickerOptionType> & Pick<SelectPickerProps, 'icon' | 'showSelectedOptionIcon'>) => JSX.Element;
-export declare const SelectPickerValueContainer: ({ showSelectedOptionsCount, ...props }: ValueContainerProps<SelectPickerOptionType> & Pick<SelectPickerProps, 'showSelectedOptionsCount'>) => JSX.Element;
+export declare const SelectPickerDropdownIndicator: <OptionValue>(props: DropdownIndicatorProps<SelectPickerOptionType<OptionValue>, boolean, import('react-select').GroupBase<SelectPickerOptionType<OptionValue>>>) => JSX.Element;
+export declare const SelectPickerClearIndicator: <OptionValue>(props: ClearIndicatorProps<SelectPickerOptionType<OptionValue>, boolean, import('react-select').GroupBase<SelectPickerOptionType<OptionValue>>>) => JSX.Element;
+export declare const SelectPickerControl: <OptionValue, IsMulti extends boolean>({ icon, showSelectedOptionIcon, ...props }: ControlProps<SelectPickerOptionType<OptionValue>, boolean, import('react-select').GroupBase<SelectPickerOptionType<OptionValue>>> & Pick<SelectPickerProps<OptionValue, IsMulti>, "icon" | "showSelectedOptionIcon">) => JSX.Element;
+export declare const SelectPickerValueContainer: <OptionValue, IsMulti extends boolean>({ showSelectedOptionsCount, customSelectedOptionsCount, ...props }: ValueContainerProps<SelectPickerOptionType<OptionValue>, boolean, import('react-select').GroupBase<SelectPickerOptionType<OptionValue>>> & Pick<SelectPickerProps<OptionValue, IsMulti>, "customSelectedOptionsCount" | "showSelectedOptionsCount">) => JSX.Element;
 export declare const SelectPickerLoadingIndicator: () => JSX.Element;
-export declare const SelectPickerOption: ({ disableDescriptionEllipsis }: SelectPickerProps) => (props: OptionProps<SelectPickerOptionType>) => JSX.Element;
-export declare const SelectPickerMenuList: ({ renderMenuListFooter, ...props }: MenuListProps<SelectPickerOptionType> & Pick<SelectPickerProps, 'renderMenuListFooter'>) => JSX.Element;
+export declare const SelectPickerOption: <OptionValue, IsMulti extends boolean>({ disableDescriptionEllipsis, ...props }: OptionProps<SelectPickerOptionType<OptionValue>, boolean, import('react-select').GroupBase<SelectPickerOptionType<OptionValue>>> & Pick<SelectPickerProps<OptionValue, IsMulti>, "disableDescriptionEllipsis">) => JSX.Element;
+export declare const SelectPickerMenuList: <OptionValue, IsMulti extends boolean>({ renderMenuListFooter, shouldRenderCustomOptions, renderCustomOptions, ...props }: MenuListProps<SelectPickerOptionType<OptionValue>, boolean, import('react-select').GroupBase<SelectPickerOptionType<OptionValue>>> & Pick<SelectPickerProps<OptionValue, IsMulti>, "renderMenuListFooter" | "shouldRenderCustomOptions" | "renderCustomOptions">) => JSX.Element;
+export declare const SelectPickerMultiValueLabel: <OptionValue, IsMulti extends boolean>({ getIsOptionValid, ...props }: MultiValueProps<SelectPickerOptionType<OptionValue>, true, import('react-select').GroupBase<SelectPickerOptionType<OptionValue>>> & Pick<SelectPickerProps<OptionValue, IsMulti>["multiSelectProps"], "getIsOptionValid">) => JSX.Element;
+export declare const SelectPickerMultiValueRemove: (props: MultiValueRemoveProps) => JSX.Element;
+export declare const SelectPickerGroupHeading: <OptionValue>({ isGroupHeadingSelectable, ...props }: SelectPickerGroupHeadingProps<OptionValue>) => JSX.Element;

package/dist/Shared/Components/SelectPicker/index.d.ts

@@ -1,3 +1,4 @@
 export { default as SelectPicker } from './SelectPicker.component';
+export { default as FilterSelectPicker } from './FilterSelectPicker';
 export * from './type';
 export { getSelectPickerOptionByValue } from './utils';

package/dist/Shared/Components/SelectPicker/type.d.ts

@@ -1,9 +1,10 @@
 import { OptionType } from '../../../Common/Types';
 import { ComponentSizeType } from '../../constants';
-import { ReactElement, ReactNode } from 'react';
-import { Props as ReactSelectProps } from 'react-select';
+import { MutableRefObject, ReactElement, ReactNode } from 'react';
+import { GroupBase, GroupHeadingProps, Props as ReactSelectProps, SelectInstance } from 'react-select';
+import { CreatableProps } from 'react-select/creatable';
 
-export interface SelectPickerOptionType extends OptionType<number | string, ReactNode> {
+export interface SelectPickerOptionType<OptionValue = string | number> extends OptionType<OptionValue, ReactNode> {
     /**
      * Description to be displayed for the option
      */
@@ -19,10 +20,10 @@ export interface SelectPickerOptionType extends OptionType<number | string, Reac
 }
 export declare enum SelectPickerVariantType {
     DEFAULT = "default",
-    BORDERLESS = "borderless"
+    BORDER_LESS = "border-less"
 }
-type SelectProps = ReactSelectProps<SelectPickerOptionType>;
-export interface SelectPickerProps extends Pick<SelectProps, 'options' | 'value' | 'onChange' | 'isSearchable' | 'isClearable' | 'isLoading' | 'hideSelectedOptions' | 'controlShouldRenderValue' | 'closeMenuOnSelect' | 'isDisabled' | 'isLoading' | 'required' | 'isOptionDisabled' | 'placeholder'>, Required<Pick<SelectProps, 'classNamePrefix' | 'inputId' | 'name'>> {
+type SelectProps<OptionValue, IsMulti extends boolean> = ReactSelectProps<SelectPickerOptionType<OptionValue>, IsMulti, GroupBase<SelectPickerOptionType<OptionValue>>>;
+export type SelectPickerProps<OptionValue = number | string, IsMulti extends boolean = false> = Pick<SelectProps<OptionValue, IsMulti>, 'name' | 'classNamePrefix' | 'options' | 'value' | 'onChange' | 'isSearchable' | 'isClearable' | 'hideSelectedOptions' | 'controlShouldRenderValue' | 'closeMenuOnSelect' | 'isDisabled' | 'isLoading' | 'required' | 'isOptionDisabled' | 'placeholder' | 'menuPosition' | 'getOptionLabel' | 'getOptionValue' | 'isOptionSelected' | 'menuIsOpen' | 'onMenuOpen' | 'onMenuClose' | 'autoFocus'> & Required<Pick<SelectProps<OptionValue, IsMulti>, 'inputId'>> & {
     /**
      * Icon to be rendered in the control
      */
@@ -34,7 +35,7 @@ export interface SelectPickerProps extends Pick<SelectProps, 'options' | 'value'
     /**
      * Render function for the footer at the bottom of menu list. It is sticky by default
      */
-    renderMenuListFooter?: () => ReactNode;
+    renderMenuListFooter?: (selectedOptions: SelectProps<OptionValue, IsMulti>['value']) => ReactNode;
     /**
      * Info text for the select, if any
      */
@@ -50,6 +51,10 @@ export interface SelectPickerProps extends Pick<SelectProps, 'options' | 'value'
      * @default 'true'
      */
     showSelectedOptionIcon?: boolean;
+    /**
+     * Custom selected options count for use cases like filters
+     */
+    customSelectedOptionsCount?: number;
     /**
      * Height of the dropdown
      *
@@ -86,5 +91,73 @@ export interface SelectPickerProps extends Pick<SelectProps, 'options' | 'value'
      * @default false
      */
     disableDescriptionEllipsis?: boolean;
+    /**
+     * Ref for the select picker
+     */
+    selectRef?: IsMulti extends true ? MutableRefObject<SelectInstance<SelectPickerOptionType<OptionValue>, true>> : MutableRefObject<SelectInstance<SelectPickerOptionType<OptionValue>>>;
+    /**
+     * If true, the menu is aligned at the right end to prevent going outside of viewport
+     * in case of menu being larger than the control
+     *
+     * @default false
+     */
+    shouldMenuAlignRight?: boolean;
+    /**
+     * If true, the select spans to the max available width
+     *
+     * @default false
+     */
+    fullWidth?: boolean;
+} & (IsMulti extends true ? {
+    isMulti: IsMulti | boolean;
+    multiSelectProps?: Pick<CreatableProps<SelectPickerOptionType<OptionValue>, true, GroupBase<SelectPickerOptionType<OptionValue>>>, 'onCreateOption'> & {
+        /**
+         * If true, the select picker creates the new option
+         * Only applicable for IsMulti: true
+         *
+         * @default false
+         */
+        isCreatable?: boolean;
+        /**
+         * If true, the group heading can be selected
+         *
+         * Only applicable for IsMulti: true
+         *
+         * @default false
+         */
+        isGroupHeadingSelectable?: boolean;
+        /**
+         * Callback handler to check if the given selection is valid or not
+         */
+        getIsOptionValid?: (option: SelectPickerOptionType<OptionValue>) => boolean;
+    };
+} : {
+    isMulti?: never;
+    multiSelectProps?: never;
+}) & ({
+    /**
+     * If true, custom options are rendered in the menuList component of react select
+     *
+     * Note: renderCustomOptions is required to be passed; renderMenuListFooter is also not called
+     *
+     * @default false
+     */
+    shouldRenderCustomOptions: boolean;
+    /**
+     * Callback handler for custom options
+     *
+     * Imp Note: The menu open/close needs to handled by the consumer in this case
+     */
+    renderCustomOptions: () => ReactElement;
+} | {
+    shouldRenderCustomOptions?: never;
+    renderCustomOptions?: never;
+});
+export type SelectPickerGroupHeadingProps<OptionValue> = GroupHeadingProps<SelectPickerOptionType<OptionValue>> & {
+    isGroupHeadingSelectable: boolean;
+};
+export interface FilterSelectPickerProps extends Required<Pick<SelectPickerProps<number | string, true>, 'options' | 'isDisabled' | 'placeholder' | 'isLoading'>>, Pick<SelectPickerProps<number | string, true>, 'selectRef' | 'inputId' | 'menuPosition' | 'autoFocus' | 'shouldMenuAlignRight'> {
+    appliedFilterOptions: SelectPickerProps<number | string, true>['options'];
+    handleApplyFilter: (filtersToApply: SelectPickerOptionType<number | string>[]) => void;
 }
 export {};

package/dist/Shared/Components/SelectPicker/utils.d.ts

@@ -1,7 +1,9 @@
-import { GroupBase, OptionsOrGroups, StylesConfig } from 'react-select';
+import { CHECKBOX_VALUE } from '../../../Common/Types';
+import { GroupBase, MultiValue, OptionsOrGroups, StylesConfig } from 'react-select';
 import { SelectPickerOptionType, SelectPickerProps } from './type';
 
-export declare const getCommonSelectStyle: ({ error, size, menuSize, variant, }: Pick<SelectPickerProps, 'error' | 'size' | 'menuSize' | 'variant'>) => StylesConfig<SelectPickerOptionType>;
+export declare const getCommonSelectStyle: <OptionValue, IsMulti extends boolean>({ error, size, menuSize, variant, getIsOptionValid, isGroupHeadingSelectable, shouldMenuAlignRight, }: Pick<SelectPickerProps<OptionValue, IsMulti>, "error" | "size" | "shouldMenuAlignRight" | "menuSize" | "variant"> & Pick<SelectPickerProps<OptionValue, IsMulti>["multiSelectProps"], "getIsOptionValid" | "isGroupHeadingSelectable">) => StylesConfig<SelectPickerOptionType<OptionValue>, boolean, GroupBase<SelectPickerOptionType<OptionValue>>>;
+export declare const getGroupCheckboxValue: <OptionValue>(groupHeadingOptions: readonly SelectPickerOptionType<OptionValue>[], selectedOptions: MultiValue<SelectPickerOptionType<OptionValue>>, getOptionValue: (option: SelectPickerOptionType<OptionValue>) => string) => CHECKBOX_VALUE.CHECKED | CHECKBOX_VALUE.INTERMEDIATE;
 /**
  * Retrieves an option from the options list based on the provided value.
  *
@@ -10,4 +12,4 @@ export declare const getCommonSelectStyle: ({ error, size, menuSize, variant, }:
  * @param defaultOption - The default option to return if no match is found.
  * @returns The matched option or the default option if no match is found.
  */
-export declare const getSelectPickerOptionByValue: (optionsList: OptionsOrGroups<SelectPickerOptionType, GroupBase<SelectPickerOptionType>>, value: string | number, defaultOption?: SelectPickerOptionType) => SelectPickerOptionType;
+export declare const getSelectPickerOptionByValue: <OptionValue>(optionsList: OptionsOrGroups<SelectPickerOptionType<OptionValue>, GroupBase<SelectPickerOptionType<OptionValue>>>, value: OptionValue, defaultOption?: SelectPickerOptionType<OptionValue>) => SelectPickerOptionType<OptionValue>;

package/dist/Shared/Components/index.d.ts

@@ -35,6 +35,5 @@ export * from './SelectPicker';
 export * from './CollapsibleList';
 export * from './DeploymentConfigDiff';
 export * from './DetectBottom';
-export * from './TabGroup';
 export * from './Collapse';
 export * from './FilterButton';

package/dist/Shared/types.d.ts

@@ -566,5 +566,4 @@ export type BaseFilterQueryParams<T> = {
      */
     showAll?: boolean;
 } & SortingParams<T>;
-export type DataAttributes = Record<`data-${string}`, unknown>;
 export {};