@true-engineering/true-react-common-ui-kit 2.0.1 → 2.1.1

package/dist/components/FiltersPane/FiltersPaneSearch/FiltersPaneSearch.d.ts

@@ -1,8 +1,8 @@
 import { ReactNode } from 'react';
+import { ICommonProps } from '../../../types';
 import { IFilterSelectProps } from '../FilterSelect';
 import { IFilterLocaleKey, IPartialFilterLocale } from '../locales';
 import { IFiltersPaneSearchPayload } from '../types';
-import { ICommonProps } from '../../../types';
 import { FiltersPaneSearchStyles } from './FiltersPaneSearch.styles';
 export interface IFiltersPaneSearchProps<Value> extends ICommonProps {
     tweakStyles?: FiltersPaneSearchStyles;

package/dist/components/FiltersPane/types.d.ts

@@ -1,11 +1,11 @@
 import { FC, ReactNode } from 'react';
+import { IMultiSelectListValues } from '../MultiSelectList';
 import { IFilterIntervalProps } from './FilterInterval';
 import { IFilterMultiSelectProps } from './FilterMultiSelect';
 import { IFilterSelectProps } from './FilterSelect';
 import { IFilterWithDatesProps } from './FilterWithDates';
 import { IFilterWithPeriodProps } from './FilterWithPeriod';
 import { IFilterLocaleKey, IPartialFilterLocale } from './locales';
-import { IMultiSelectListValues } from '../MultiSelectList';
 export declare const PERIODS: readonly ["THIS_MONTH", "LAST_MONTH", "THIS_YEAR", "LAST_YEAR", "CUSTOM"];
 export declare type IPeriodType = (typeof PERIODS)[number];
 export declare type IFilterMultiSelectValues<Option = string> = IMultiSelectListValues<Option>;

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

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

package/dist/components/FlexibleTable/FlexibleTable.d.ts

@@ -1,7 +1,7 @@
 import React, { RefObject } from 'react';
 import { ICommonProps } from '../../types';
-import { FlexibleTableConfigType, IInfinityScrollConfig } from './types';
 import { FlexibleTableStyles } from './FlexibleTable.styles';
+import { FlexibleTableConfigType, IInfinityScrollConfig } from './types';
 export interface IFlexibleTableProps<Values extends Record<string, any>> extends ICommonProps {
     tweakStyles?: FlexibleTableStyles;
     content: Values[];

package/dist/components/FlexibleTable/TableRow.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
-import { FlexibleTableConfigType } from './types';
 import { ICommonProps } from '../../types';
+import { FlexibleTableConfigType } from './types';
 interface ITableRowProps<Values extends Record<string, any>> extends ICommonProps {
     item: Values;
     uniqueField?: keyof Values;

package/dist/components/Icon/Icon.d.ts

@@ -1,8 +1,8 @@
 import React from 'react';
 import { ICommonProps } from '../../types';
-import { ICommonIcon } from './icons';
-import { IComplexIcon } from './complexIcons';
 import { IconStyles } from './Icon.styles';
+import { IComplexIcon } from './complexIcons';
+import { ICommonIcon } from './icons';
 export declare type IIconType = ICommonIcon | IComplexIcon;
 export interface IIconProps extends ICommonProps {
     tweakStyles?: IconStyles;

package/dist/components/Icon/complexIcons/augment.d.ts

@@ -1 +1 @@
-declare module '*.svg?raw';
+declare module '*.svg?raw';

package/dist/components/Input/Input.d.ts

@@ -1,7 +1,7 @@
 import { FormEvent, FocusEvent, KeyboardEvent, ClipboardEvent, ReactElement } from 'react';
 import { Props as ReactInputMaskBaseProps } from 'react-input-mask';
-import { IIconType } from '../Icon';
 import { ICommonProps } from '../../types';
+import { IIconType } from '../Icon';
 import { InputStyles } from './Input.styles';
 export declare const DEFAULT_SIZE = 6;
 declare type IReactInputMaskProps = Pick<Partial<ReactInputMaskBaseProps>, 'mask' | 'maskPlaceholder' | 'alwaysShowMask' | 'beforeMaskedStateChange'>;
@@ -10,8 +10,14 @@ export interface IInputProps extends ICommonProps, IReactInputMaskProps {
     value?: string;
     label?: string;
     placeholder?: string;
+    /**
+     * @default `text`
+     */
     type?: 'text' | 'password' | 'email' | 'number';
     isDisabled?: boolean;
+    /**
+     * @default true
+     */
     hasFloatingLabel?: boolean;
     isReadonly?: boolean;
     isInvalid?: boolean;
@@ -19,12 +25,23 @@ export interface IInputProps extends ICommonProps, IReactInputMaskProps {
     isClearable?: boolean;
     infoMessage?: string;
     errorMessage?: string;
+    /**
+     * @default `bottom`
+     */
     errorPosition?: 'top' | 'bottom';
     inlineStyle?: 'top' | 'bottom' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'left' | 'right' | 'middle';
     border?: 'top' | 'bottom' | 'left' | 'right';
     isRequired?: boolean;
     isLoading?: boolean;
+    /**
+     * Должна ли ширина input'а подстраиваться под ширину контента
+     * @default false
+     */
     isAutoSizeable?: boolean;
+    /**
+     * Ширина input'а по умолчанию. Используется только вместе с `isAutoSizeable` равному `true`
+     * @default 6
+     */
     defaultSize?: number;
     iconType?: IIconType | ReactElement;
     units?: string;

package/dist/components/MoreMenu/MoreMenu.d.ts

@@ -6,6 +6,9 @@ export interface IMoreMenuProps extends ICommonProps {
     tweakStyles?: MoreMenuStyles;
     items: IListItem[];
     isDisabled?: boolean;
+    /**
+     * @default true
+     */
     hasDefaultStateBackground?: boolean;
     testId?: string;
     onMenuOpen?(): void;

package/dist/components/MultiSelect/MultiSelectInput/MultiSelectInput.d.ts

@@ -1,6 +1,6 @@
 import { ReactElement } from 'react';
-import { IMultiSelectListValues } from '../../index';
 import { ICommonProps } from '../../../types';
+import { IMultiSelectListValues } from '../../index';
 export interface IMultiSelectInputProps<Value> extends ICommonProps {
     value?: IMultiSelectListValues<Value>;
     isOpen: boolean;

package/dist/components/MultiSelectList/MultiSelectList.d.ts

@@ -1,7 +1,7 @@
 import { ReactNode } from 'react';
 import { ICommonProps } from '../../types';
-import { IMultiSelectLocale, IMultiSelectLocaleKey } from './locales';
 import { MultiSelectListStyles } from './MultiSelectList.styles';
+import { IMultiSelectLocale, IMultiSelectLocaleKey } from './locales';
 export interface IMultiSelectListValues<Option> {
     include: Option[];
 }

package/dist/components/Notification/Notification.d.ts

@@ -5,9 +5,15 @@ export declare type NotificationType = 'error' | 'info' | 'warning' | 'ok' | 'no
 export interface INotificationProps extends ICommonProps {
     tweakStyles?: NotificationStyles;
     type: NotificationType;
+    /**
+     * @default true
+     */
     isFullWidth?: boolean;
     text?: string;
     title?: string;
+    /**
+     * @default `s`
+     */
     size?: 's' | 'm' | 'l';
     testId?: string;
     children?: ReactNode;

package/dist/components/PhoneInput/PhoneInput.d.ts

@@ -1,7 +1,7 @@
 import { FC } from 'react';
 import { IInputProps } from '../Input';
-import { IPhoneValue } from './types';
 import { PhoneInputStyles } from './PhoneInput.styles';
+import { IPhoneValue } from './types';
 export interface IPhoneInputProps extends Omit<IInputProps, 'value' | 'onChange' | 'type' | 'mask' | 'units' | 'placeholder'> {
     tweakStyles?: PhoneInputStyles;
     locale?: string;

package/dist/components/RadioButton/RadioButton.d.ts

@@ -1,13 +1,14 @@
-import { PropsWithChildren } from 'react';
+import { ReactNode } from 'react';
 import { ICommonProps } from '../../types';
 import { RadioButtonStyles } from './RadioButton.styles';
 export interface IRadioButtonProps<Value extends string> extends ICommonProps {
     tweakStyles?: RadioButtonStyles;
+    children?: ReactNode;
     value: Value;
     groupName: string;
     isChecked?: boolean;
     isDisabled?: boolean;
     isInvalid?: boolean;
-    onChange: (value: Value) => void | Promise<void>;
+    onChange(value: Value): void | Promise<void>;
 }
-export declare function RadioButton<Value extends string>({ children, value, groupName, isChecked, isDisabled, isInvalid, onChange, data, tweakStyles, }: PropsWithChildren<IRadioButtonProps<Value>>): JSX.Element;
+export declare function RadioButton<Value extends string>({ children, value, groupName, isChecked, isDisabled, isInvalid, data, tweakStyles, onChange, }: IRadioButtonProps<Value>): JSX.Element;

package/dist/components/Select/Select.d.ts

@@ -1,9 +1,9 @@
 import { ReactNode, SyntheticEvent } from 'react';
-import { IInputProps } from '../Input';
-import { IIconType } from '../Icon';
 import { IDropdownWithPopperOptions } from '../../types';
-import { SelectStyles } from './Select.styles';
+import { IIconType } from '../Icon';
+import { IInputProps } from '../Input';
 import { ISearchInputProps } from '../SearchInput';
+import { SelectStyles } from './Select.styles';
 import { IMultipleSelectValue } from './types';
 export interface ISelectProps<Value> extends Omit<IInputProps, 'value' | 'onChange' | 'onBlur' | 'type'> {
     tweakStyles?: SelectStyles;

package/dist/components/Switch/Switch.d.ts

@@ -1,4 +1,4 @@
-import { PropsWithChildren } from 'react';
+import { ReactNode } from 'react';
 import { ICommonProps } from '../../types';
 import { SwitchStyles } from './Switch.styles';
 export interface ISwitchState<V = string> {
@@ -7,14 +7,20 @@ export interface ISwitchState<V = string> {
 }
 export interface ISwitchProps<V extends string> extends ICommonProps {
     tweakStyles?: SwitchStyles;
+    children?: ReactNode;
     value: V;
     isChecked: boolean;
     isDisabled?: boolean;
     isInvalid?: boolean;
-    label?: string;
+    /**
+     * @default `right`
+     */
     labelPosition?: 'left' | 'right';
+    /**
+     * @default `primary`
+     */
     color?: 'primary' | 'secondary';
-    onChange: (state: ISwitchState<V>) => void;
     testId?: string;
+    onChange(state: ISwitchState<V>): void;
 }
-export declare const Switch: <V extends string>({ isDisabled, isChecked, isInvalid, onChange, value, label, children, labelPosition, color, data, tweakStyles, testId, }: PropsWithChildren<ISwitchProps<V>>) => JSX.Element;
+export declare const Switch: <V extends string>({ isDisabled, isChecked, isInvalid, value, children, labelPosition, color, data, tweakStyles, testId, onChange, }: ISwitchProps<V>) => JSX.Element;

package/dist/components/TextWithTooltip/TextWithTooltip.d.ts

@@ -1,7 +1,7 @@
 import React, { FC } from 'react';
 import { Modifier, Placement } from 'react-overlays/usePopper';
-import { ITooltipProps } from '../Tooltip';
 import { ICommonProps } from '../../types';
+import { ITooltipProps } from '../Tooltip';
 import { TextWithTooltipStyles } from './TextWithTooltip.styles';
 export interface ITextWithTooltipProps extends ICommonProps {
     tweakStyles?: TextWithTooltipStyles;

package/dist/components/ThemedPreloader/ThemedPreloader.d.ts

@@ -5,6 +5,9 @@ declare const svgTypes: readonly ["default", "logo"];
 export declare type IPreloaderSvgType = (typeof svgTypes)[number];
 export interface IThemedPreloaderProps extends ICommonProps {
     tweakStyles?: ThemedPreloaderStyles;
+    /**
+     * @default `default`
+     */
     type?: 'dots' | IPreloaderSvgType;
     useCurrentColor?: boolean;
 }

package/dist/components/Toaster/Toaster.d.ts

@@ -4,12 +4,25 @@ import { ToasterStyles } from './Toaster.styles';
 export declare type ToasterType = 'error' | 'info' | 'warning' | 'ok' | 'not-ok';
 export interface IToasterProps extends ICommonProps {
     tweakStyles?: ToasterStyles;
+    /**
+     * @default `error`
+     */
     type?: ToasterType;
     title?: string;
     text?: string;
     children?: ReactNode;
+    /**
+     * Время автоматического закрытия тостера в миллисекундах
+     * @default 7000
+     */
     timeout?: number;
+    /**
+     * @default false
+     */
     hasCloseButton?: boolean;
+    /**
+     * @default false
+     */
     shouldCloseOnClick?: boolean;
     onClose?(): void;
     onTimeEnd?(): void;

package/dist/components/Tooltip/Tooltip.d.ts

@@ -4,7 +4,13 @@ import { TooltipStyles } from './Tooltip.styles';
 export interface ITooltipProps extends ICommonProps {
     tweakStyles?: TooltipStyles;
     text: ReactNode;
+    /**
+     * @default `tooltip`
+     */
     view?: 'tooltip' | 'hint';
+    /**
+     * @default `info`
+     */
     type?: 'info' | 'error';
 }
 export declare const Tooltip: FC<ITooltipProps>;

package/dist/helpers/snippets.d.ts

@@ -1,3 +1,3 @@
-import { IIconType } from '../components';
 import { ReactElement, ReactNode } from 'react';
+import { IIconType } from '../components';
 export declare const renderIcon: (icon: IIconType | ReactElement) => ReactNode;

package/dist/helpers/utils.d.ts

@@ -1,5 +1,5 @@
-import { IDataAttributes } from '../types';
 import { HTMLAttributes, KeyboardEvent, MouseEvent } from 'react';
+import { IDataAttributes } from '../types';
 export declare const transformToKebab: (string: string) => string;
 export declare const hasExactParent: (element: Element, parent: Element) => boolean;
 export declare const getParentNode: (element: Element | ShadowRoot | Document) => Element;
@@ -15,8 +15,17 @@ export declare const setCaretPosition: (elem: HTMLInputElement, caretPos: number
 export declare const isSpaceChar: (char?: string) => boolean;
 export declare const isInt: (n: number) => boolean;
 export declare const getNumberLength: (n?: number) => number;
+/**
+ * Проверяет, что `val` не `null`, не `undefined` и не пустая строка
+ */
 export declare const isNotEmpty: <T>(val: T | null | undefined) => val is T;
+/**
+ * Проверяет, что переданное значение `null` или `undefined`
+ */
 export declare const isEmpty: <T>(val: T | null | undefined) => val is null | undefined;
+/**
+ * Проверяет, что передана непустая строка
+ */
 export declare const isStringNotEmpty: <T extends string>(value: T | null | undefined) => value is T;
 export declare const trimStringToMaxLength: (val: string, maxLength: number) => string;
 export declare const addDataAttributes: (data?: IDataAttributes) => IDataAttributes;
@@ -26,4 +35,9 @@ export declare const addDataTestId: (testId: string | undefined, postfix?: strin
 export declare const getTestId: (testId: string | undefined, postfix?: string | number) => string | undefined;
 export declare const getSelectKeyHandler: (cb: (e: KeyboardEvent) => void) => (e: KeyboardEvent) => void;
 export declare const addClickHandler: (cb?: ((e: MouseEvent | KeyboardEvent) => void) | undefined, hasAction?: boolean) => HTMLAttributes<unknown>;
+/**
+ * Позволяет создать текстовый фильтр для набора items
+ * @param getter - функция возвращающая набор строковых значений из каждого item,
+ * по которым должен осуществляться поиск
+ */
 export declare const createFilter: <T>(getter: (item: T) => Array<string | undefined>, compareFn?: ((item: string, query: string) => boolean) | undefined) => (items: T[], query: string) => T[];