@true-engineering/true-react-common-ui-kit 3.41.0 → 3.42.0

package/src/components/FiltersPane/components/FilterWithPeriod/FilterWithPeriod.tsx

@@ -1,177 +1,177 @@
-import { FC, useCallback, useEffect, useMemo, useRef, useState } from 'react';
-import { useOnClickOutside, useTweakStyles } from '../../../../hooks';
-import { ICommonProps } from '../../../../types';
-import { PERIODS, PERIODS_GETTERS } from '../../constants';
-import { getLocale } from '../../helpers';
-import {
-  IDatePeriod,
-  IFilterLocaleKey,
-  IPartialFilterLocale,
-  IPeriod,
-  IPeriodGetter,
-  IPeriodsList,
-} from '../../types';
-import { FilterSelect } from '../FilterSelect';
-import { FilterWithDates } from '../FilterWithDates';
-import { useStyles, IFilterWithPeriodStyles, filterSelectStyles } from './FilterWithPeriod.styles';
-
-export interface IFilterWithPeriodProps extends ICommonProps<IFilterWithPeriodStyles> {
-  value?: IPeriod;
-  localeKey?: IFilterLocaleKey;
-  locale?: IPartialFilterLocale;
-  periods?: IPeriodsList;
-  onChange: (period?: IPeriod) => void;
-  onClose?: () => void;
-}
-
-export const FilterWithPeriod: FC<IFilterWithPeriodProps> = ({
-  value,
-  localeKey,
-  locale,
-  onChange,
-  onClose,
-  periods,
-  tweakStyles,
-  testId,
-}) => {
-  const classes = useStyles({ theme: tweakStyles });
-
-  const translates = useMemo(() => getLocale(localeKey, locale), [localeKey, locale]);
-
-  const [isPeriodPickerShown, setIsPeriodPickerShown] = useState(value?.periodType !== 'CUSTOM');
-
-  const [isDatePickerShown, setIsDatePickerShown] = useState(value?.periodType === 'CUSTOM');
-
-  const [period, setPeriod] = useState(value);
-
-  const periodGetters = useMemo(() => {
-    const result: Record<string, IPeriodGetter> = { ...PERIODS_GETTERS };
-    periods?.forEach((p) => {
-      if (Array.isArray(p)) {
-        result[p[0]] = p[1];
-      }
-    });
-    return result;
-  }, [periods]);
-
-  const periodsList = useMemo(() => {
-    if (periods === undefined) {
-      return [...PERIODS];
-    }
-    return periods.map((p) => (Array.isArray(p) ? p[0] : p));
-  }, [periods]);
-
-  const getPeriodTranslate = useCallback(
-    (val: string) => translates.periods[val] ?? val,
-    [translates.periods],
-  );
-
-  const handlePeriodChange = (periodType: string) => {
-    let from = null;
-    let to = null;
-
-    if (periodType in periodGetters) {
-      const newPeriod = periodGetters[periodType]();
-      from = newPeriod.from;
-      to = newPeriod.to;
-    }
-
-    const p = { from, to, periodType };
-    setPeriod(p);
-
-    if (periodType === 'CUSTOM') {
-      setIsDatePickerShown(true);
-    } else {
-      if (onClose !== undefined) {
-        onClose();
-      }
-      onChange({ ...p, label: getPeriodTranslate(periodType) });
-    }
-
-    setIsPeriodPickerShown(false);
-  };
-
-  const refPeriodPicker = useRef<HTMLDivElement>(null);
-  const refDatePicker = useRef<HTMLDivElement>(null);
-
-  const onPeriodChange = (val?: string) => {
-    if (val !== undefined) {
-      handlePeriodChange(val);
-    } else {
-      onChange(undefined);
-      if (onClose !== undefined) {
-        onClose();
-      }
-    }
-  };
-
-  const handleCustomDateChange = (val: IDatePeriod): void => {
-    if (val.from || val.to) {
-      onChange({
-        ...val,
-        periodType: 'CUSTOM',
-      });
-    } else {
-      onChange(undefined);
-    }
-  };
-
-  useOnClickOutside(refDatePicker, () => {
-    if (!period?.from && !period?.to) {
-      setPeriod(undefined);
-    }
-    setIsDatePickerShown(false);
-  });
-
-  useEffect(() => {
-    setPeriod(value);
-  }, [value, value?.from, value?.to, value?.periodType]);
-
-  const tweakSelectStyles = useTweakStyles({
-    innerStyles: filterSelectStyles,
-    tweakStyles,
-    className: 'tweakFilterSelect',
-    currentComponentName: 'FilterWithPeriod',
-  });
-
-  return (
-    <div className={classes.root}>
-      {isPeriodPickerShown && (
-        <div className={classes.main} ref={refPeriodPicker}>
-          <FilterSelect
-            options={periodsList}
-            value={period?.periodType}
-            onChange={onPeriodChange}
-            localeKey={localeKey}
-            locale={translates}
-            tweakStyles={tweakSelectStyles}
-            getValueView={getPeriodTranslate}
-            testId={testId !== undefined ? `${testId}-select` : undefined}
-          />
-        </div>
-      )}
-      {isDatePickerShown && (
-        <div className={classes.picker} style={{ width: 320 }} ref={refDatePicker}>
-          <FilterWithDates
-            onStartBtnSubmit={() => {
-              setIsDatePickerShown(false);
-              setIsPeriodPickerShown(true);
-            }}
-            onEndBtnSubmit={() => {
-              onChange(undefined);
-              setIsDatePickerShown(false);
-              if (onClose !== undefined) {
-                onClose();
-              }
-            }}
-            value={period}
-            onChange={handleCustomDateChange}
-            localeKey={localeKey}
-            locale={translates}
-            testId={testId !== undefined ? `${testId}-dates` : undefined}
-          />
-        </div>
-      )}
-    </div>
-  );
-};
+import { FC, useCallback, useEffect, useMemo, useRef, useState } from 'react';
+import { useOnClickOutside, useTweakStyles } from '../../../../hooks';
+import { ICommonProps } from '../../../../types';
+import { PERIODS, PERIODS_GETTERS } from '../../constants';
+import { getLocale } from '../../helpers';
+import {
+  IDatePeriod,
+  IFilterLocaleKey,
+  IPartialFilterLocale,
+  IPeriod,
+  IPeriodGetter,
+  IPeriodsList,
+} from '../../types';
+import { FilterSelect } from '../FilterSelect';
+import { FilterWithDates } from '../FilterWithDates';
+import { useStyles, IFilterWithPeriodStyles, filterSelectStyles } from './FilterWithPeriod.styles';
+
+export interface IFilterWithPeriodProps extends ICommonProps<IFilterWithPeriodStyles> {
+  value?: IPeriod;
+  localeKey?: IFilterLocaleKey;
+  locale?: IPartialFilterLocale;
+  periods?: IPeriodsList;
+  onChange: (period?: IPeriod) => void;
+  onClose?: () => void;
+}
+
+export const FilterWithPeriod: FC<IFilterWithPeriodProps> = ({
+  value,
+  localeKey,
+  locale,
+  onChange,
+  onClose,
+  periods,
+  tweakStyles,
+  testId,
+}) => {
+  const classes = useStyles({ theme: tweakStyles });
+
+  const translates = useMemo(() => getLocale(localeKey, locale), [localeKey, locale]);
+
+  const [isPeriodPickerShown, setIsPeriodPickerShown] = useState(value?.periodType !== 'CUSTOM');
+
+  const [isDatePickerShown, setIsDatePickerShown] = useState(value?.periodType === 'CUSTOM');
+
+  const [period, setPeriod] = useState(value);
+
+  const periodGetters = useMemo(() => {
+    const result: Record<string, IPeriodGetter> = { ...PERIODS_GETTERS };
+    periods?.forEach((p) => {
+      if (Array.isArray(p)) {
+        result[p[0]] = p[1];
+      }
+    });
+    return result;
+  }, [periods]);
+
+  const periodsList = useMemo(() => {
+    if (periods === undefined) {
+      return [...PERIODS];
+    }
+    return periods.map((p) => (Array.isArray(p) ? p[0] : p));
+  }, [periods]);
+
+  const getPeriodTranslate = useCallback(
+    (val: string) => translates.periods[val] ?? val,
+    [translates.periods],
+  );
+
+  const handlePeriodChange = (periodType: string) => {
+    let from = null;
+    let to = null;
+
+    if (periodType in periodGetters) {
+      const newPeriod = periodGetters[periodType]();
+      from = newPeriod.from;
+      to = newPeriod.to;
+    }
+
+    const p = { from, to, periodType };
+    setPeriod(p);
+
+    if (periodType === 'CUSTOM') {
+      setIsDatePickerShown(true);
+    } else {
+      if (onClose !== undefined) {
+        onClose();
+      }
+      onChange({ ...p, label: getPeriodTranslate(periodType) });
+    }
+
+    setIsPeriodPickerShown(false);
+  };
+
+  const refPeriodPicker = useRef<HTMLDivElement>(null);
+  const refDatePicker = useRef<HTMLDivElement>(null);
+
+  const onPeriodChange = (val?: string) => {
+    if (val !== undefined) {
+      handlePeriodChange(val);
+    } else {
+      onChange(undefined);
+      if (onClose !== undefined) {
+        onClose();
+      }
+    }
+  };
+
+  const handleCustomDateChange = (val: IDatePeriod): void => {
+    if (val.from || val.to) {
+      onChange({
+        ...val,
+        periodType: 'CUSTOM',
+      });
+    } else {
+      onChange(undefined);
+    }
+  };
+
+  useOnClickOutside(refDatePicker, () => {
+    if (!period?.from && !period?.to) {
+      setPeriod(undefined);
+    }
+    setIsDatePickerShown(false);
+  });
+
+  useEffect(() => {
+    setPeriod(value);
+  }, [value, value?.from, value?.to, value?.periodType]);
+
+  const tweakSelectStyles = useTweakStyles({
+    innerStyles: filterSelectStyles,
+    tweakStyles,
+    className: 'tweakFilterSelect',
+    currentComponentName: 'FilterWithPeriod',
+  });
+
+  return (
+    <div className={classes.root}>
+      {isPeriodPickerShown && (
+        <div className={classes.main} ref={refPeriodPicker}>
+          <FilterSelect
+            options={periodsList}
+            value={period?.periodType}
+            onChange={onPeriodChange}
+            localeKey={localeKey}
+            locale={translates}
+            tweakStyles={tweakSelectStyles}
+            getValueView={getPeriodTranslate}
+            testId={testId !== undefined ? `${testId}-select` : undefined}
+          />
+        </div>
+      )}
+      {isDatePickerShown && (
+        <div className={classes.picker} style={{ width: 320 }} ref={refDatePicker}>
+          <FilterWithDates
+            onStartBtnSubmit={() => {
+              setIsDatePickerShown(false);
+              setIsPeriodPickerShown(true);
+            }}
+            onEndBtnSubmit={() => {
+              onChange(undefined);
+              setIsDatePickerShown(false);
+              if (onClose !== undefined) {
+                onClose();
+              }
+            }}
+            value={period}
+            onChange={handleCustomDateChange}
+            localeKey={localeKey}
+            locale={translates}
+            testId={testId !== undefined ? `${testId}-dates` : undefined}
+          />
+        </div>
+      )}
+    </div>
+  );
+};

package/src/components/FiltersPane/components/FilterWrapper/FilterWrapper.styles.ts

@@ -59,6 +59,10 @@ export const useStyles = createThemedStyles('FilterWrapper', {
     flexShrink: 0,
   },
 
+  chevronIcon: {},
+
+  clearIcon: {},
+
   open: {
     transform: 'rotate(180deg)',
   },

package/src/components/FiltersPane/components/FilterWrapper/FilterWrapper.tsx

@@ -1,3 +1,4 @@
+import { MouseEventHandler } from 'react';
 import clsx from 'clsx';
 import { addDataTestId, getTestId } from '@true-engineering/true-react-platform-helpers';
 import { addDataAttributes } from '../../../../helpers';
@@ -66,8 +67,13 @@ export function FilterWrapper<Values, Key extends keyof Values>({
       onChange(!value);
     }
   };
+  const handleClearIconClick: MouseEventHandler<HTMLDivElement> = (event) => {
+    event.stopPropagation();
+    onChange(undefined);
+  };
 
   const hasValue = isContentNotEmpty(value);
+  const hasClearIcon = (filter.isClearable ?? false) && hasValue;
 
   return (
     <WithPopup
@@ -106,11 +112,23 @@ export function FilterWrapper<Values, Key extends keyof Values>({
                 />
               </div>
             )}
-            {!isBoolean && (
-              <div className={clsx(classes.iconContainer, { [classes.open]: isActive })}>
+            {!isBoolean && !hasClearIcon && (
+              <div
+                className={clsx(classes.iconContainer, classes.chevronIcon, {
+                  [classes.open]: isActive,
+                })}
+              >
                 <Icon type="chevron-down" />
               </div>
             )}
+            {hasClearIcon && (
+              <div
+                className={clsx(classes.iconContainer, classes.clearIcon)}
+                onClick={handleClearIconClick}
+              >
+                <Icon type="close-large" />
+              </div>
+            )}
           </div>
         </div>
       )}

package/src/components/FiltersPane/types.ts

@@ -49,6 +49,7 @@ export type MultiSelectOptionType<Value> = Value | undefined extends
 export interface IConfigItemBasicBase<Value> {
   name: string;
   isInline?: boolean;
+  isClearable?: boolean;
   requiredFilledFilters?: string[];
   localeKey?: IFilterLocaleKey;
   locale?: IPartialFilterLocale;

package/src/components/Flag/Flag.stories.tsx

@@ -1,29 +1,29 @@
-import { countries } from 'country-flag-icons';
-import { ComponentStory } from '@storybook/react';
-import { Flag } from './Flag';
-
-export default {
-  title: 'Data Display/Flag',
-  component: Flag,
-  argTypes: {
-    countryCode: { control: 'select', options: countries },
-  },
-};
-
-const Template: ComponentStory<typeof Flag> = (args) => (
-  <div style={{ width: 60, height: 40 }}>
-    <Flag {...args} />
-  </div>
-);
-
-export const Default = Template.bind({});
-
-Default.args = {
-  countryCode: 'ug',
-};
-
-Default.parameters = {
-  controls: {
-    exclude: ['data'],
-  },
-};
+import { countries } from 'country-flag-icons';
+import { ComponentStory } from '@storybook/react';
+import { Flag } from './Flag';
+
+export default {
+  title: 'Data Display/Flag',
+  component: Flag,
+  argTypes: {
+    countryCode: { control: 'select', options: countries },
+  },
+};
+
+const Template: ComponentStory<typeof Flag> = (args) => (
+  <div style={{ width: 60, height: 40 }}>
+    <Flag {...args} />
+  </div>
+);
+
+export const Default = Template.bind({});
+
+Default.args = {
+  countryCode: 'ug',
+};
+
+Default.parameters = {
+  controls: {
+    exclude: ['data'],
+  },
+};

package/src/components/Flag/Flag.tsx

@@ -1,26 +1,26 @@
-import { FC } from 'react';
-import { hasFlag } from 'country-flag-icons';
-import Flags from 'country-flag-icons/react/3x2';
-import { ICommonProps } from '../../types';
-import { Icon } from '../Icon';
-import { useStyles, IFlagStyles } from './Flag.styles';
-
-export interface IFlagProps extends Pick<ICommonProps<IFlagStyles>, 'tweakStyles'> {
-  /** @default '' */
-  countryCode?: string;
-}
-
-export const Flag: FC<IFlagProps> = ({ countryCode = '', tweakStyles }) => {
-  const classes = useStyles({ theme: tweakStyles });
-  const CC = countryCode.toUpperCase();
-
-  const TheFlag = hasFlag(CC)
-    ? Flags[CC as keyof typeof Flags]
-    : () => (
-        <div className={classes.noFlag}>
-          <Icon type="minus" />
-        </div>
-      );
-
-  return <TheFlag className={classes.root} />;
-};
+import { FC } from 'react';
+import { hasFlag } from 'country-flag-icons';
+import Flags from 'country-flag-icons/react/3x2';
+import { ICommonProps } from '../../types';
+import { Icon } from '../Icon';
+import { useStyles, IFlagStyles } from './Flag.styles';
+
+export interface IFlagProps extends Pick<ICommonProps<IFlagStyles>, 'tweakStyles'> {
+  /** @default '' */
+  countryCode?: string;
+}
+
+export const Flag: FC<IFlagProps> = ({ countryCode = '', tweakStyles }) => {
+  const classes = useStyles({ theme: tweakStyles });
+  const CC = countryCode.toUpperCase();
+
+  const TheFlag = hasFlag(CC)
+    ? Flags[CC as keyof typeof Flags]
+    : () => (
+        <div className={classes.noFlag}>
+          <Icon type="minus" />
+        </div>
+      );
+
+  return <TheFlag className={classes.root} />;
+};

package/src/components/Flag/augment.d.ts

@@ -1 +1 @@
-declare module 'country-flag-icons/react/3x2';
+declare module 'country-flag-icons/react/3x2';

package/src/components/FlexibleTable/components/FlexibleTableRow/FlexibleTableRow.styles.ts

@@ -1,25 +1,25 @@
-import { ITweakStyles, createThemedStyles } from '../../../../theme';
-import { IFlexibleTableCellStyles } from '../FlexibleTableCell';
-
-export const useStyles = createThemedStyles('FlexibleTableRow', {
-  root: {
-    position: 'relative',
-  },
-
-  active: {},
-
-  editable: {
-    cursor: 'pointer',
-  },
-
-  clickable: {
-    cursor: 'pointer',
-  },
-
-  nestedComponent: {},
-});
-
-export type IFlexibleTableRowStyles = ITweakStyles<
-  typeof useStyles,
-  { tweakTableCell: IFlexibleTableCellStyles }
->;
+import { ITweakStyles, createThemedStyles } from '../../../../theme';
+import { IFlexibleTableCellStyles } from '../FlexibleTableCell';
+
+export const useStyles = createThemedStyles('FlexibleTableRow', {
+  root: {
+    position: 'relative',
+  },
+
+  active: {},
+
+  editable: {
+    cursor: 'pointer',
+  },
+
+  clickable: {
+    cursor: 'pointer',
+  },
+
+  nestedComponent: {},
+});
+
+export type IFlexibleTableRowStyles = ITweakStyles<
+  typeof useStyles,
+  { tweakTableCell: IFlexibleTableCellStyles }
+>;