gantri-components 2.109.0 → 2.110.0-beta.1

package/dist/components/image/image.constants.d.ts

@@ -1,4 +1,3 @@
-import { ResolutionAwareProp } from '../../types/resolution-aware-prop.type';
-import { ImageTransformationsVariant, Transformations } from './image.types';
-import { Optional } from '../../types/common';
-export declare const TRANSFORMATION_VARIANTS_MAP: Record<ImageTransformationsVariant, Optional<ResolutionAwareProp<Transformations>>>;
+import { ResolutionAwarePropBase } from '../../types/resolution-aware-prop.type';
+import { ImageTransformationsVariantOption, Transformations } from './image.types';
+export declare const TRANSFORMATION_VARIANTS_MAP: Record<ImageTransformationsVariantOption, ResolutionAwarePropBase<Transformations>>;

package/dist/components/image/image.helpers.d.ts

@@ -1,7 +1,9 @@
 import { IGravity } from '@cloudinary/url-gen/qualifiers/gravity/GravityQualifier';
-import { AspectRatio, Dpr, ImageDimension, ImageProps, ImageSource, TransformationMode, TransformationQuality, TransformationType } from './image.types';
+import { AspectRatio, Dpr, ImageDimension, ImageProps, ImageSource, ImageTransformationsVariant, TransformationMode, TransformationQuality, Transformations, TransformationType } from './image.types';
 import { ResolutionAwarePropBase } from '../../types/resolution-aware-prop.type';
 import { Optional } from '../../types/common';
 export declare const extractSizePropertyValue: (prop: Optional<ImageDimension>) => Optional<ImageDimension>;
 export declare const generateCloudinaryUrl: (source: ImageSource, imageName?: string, aspectRatio?: AspectRatio, width?: Optional<ImageDimension>, height?: Optional<ImageDimension>, mode?: Optional<TransformationMode>, quality?: Optional<TransformationQuality>, dpr?: Optional<Dpr>, type?: Optional<TransformationType>, gravity?: Optional<IGravity>) => string;
 export declare const generateImages: (params: Partial<ImageProps>, type?: TransformationType) => string | ResolutionAwarePropBase<string>;
+/** Converts transformation variant shorthand to full transformations. */
+export declare const getVariantTransformation: (transformationsVariant: Optional<ImageTransformationsVariant>) => ResolutionAwarePropBase<Transformations> | null;

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

@@ -7,7 +7,8 @@ import { Optional } from '../../types/common';
 export type AspectRatio = 'unset' | string | number;
 export type ImageDimension = string | number | 'unset';
 export type Dpr = number | 'auto';
-export type ImageTransformationsVariant = 'f' | 'h' | 'q' | 'ffh' | 'hff' | 'hhf';
+export type ImageTransformationsVariantOption = 'f' | 'h' | 'q';
+export type ImageTransformationsVariant = ImageTransformationsVariantOption | `${ImageTransformationsVariantOption}${ImageTransformationsVariantOption}` | `${ImageTransformationsVariantOption}${ImageTransformationsVariantOption}${ImageTransformationsVariantOption}`;
 export interface ImageProps {
     alt: string;
     className?: string;
@@ -40,12 +41,21 @@ export interface ImageProps {
     transformations?: Optional<ResolutionAwareProp<Transformations>>;
     /**
      * Used to define common transformation for images.
+     *
+     * @example
+     * ```text
      * f => full width
+     *
      * h => half width
+     *
      * q => quarter width
+     *
      * ffh => desktop full width, tablet full width, mobile half width
+     *
      * hff => desktop half width, tablet full width, mobile full width
+     *
      * hhf => desktop half width, tablet half width, mobile full width
+     * ```
      */
     transformationsVariant?: Optional<ImageTransformationsVariant>;
     width?: Optional<ResolutionAwareProp<ImageDimension>>;

package/dist/components/table/components/table-draggable-row/table-draggable-row.styles.d.ts

@@ -1,4 +1 @@
-export declare const StyledDraggableRowTr: import("styled-components").StyledComponent<"tr", import("styled-components").DefaultTheme, {
-    reorderEnabled: boolean;
-}, never>;
 export declare const StyledDraggableRowWrapper: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;

package/dist/components/table/hooks/use-selectable-table-rows/components/clear-selected-rows/clear-selected-rows.d.ts

@@ -0,0 +1,2 @@
+export declare const dataAttrClearSelected = "data-clear-selected";
+export declare const ClearSelectedRows: () => JSX.Element;

package/dist/components/table/hooks/use-selectable-table-rows/components/clear-selected-rows/clear-selected-rows.styles.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const StyledPointerFlex: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("../../../../../flex/flex.types").FlexProps & import("react").RefAttributes<import("../../../../../flex/flex.types").FlexProps>>, import("styled-components").DefaultTheme, {}, never>;

package/dist/components/table/hooks/use-selectable-table-rows/components/clear-selected-rows/index.d.ts

@@ -0,0 +1 @@
+export * from './clear-selected-rows';

package/dist/components/table/hooks/use-selectable-table-rows/components/selectable-row-cell/index.d.ts

@@ -0,0 +1 @@
+export * from './selectable-row-cell';

package/dist/components/table/hooks/use-selectable-table-rows/components/selectable-row-cell/selectable-row-cell.d.ts

@@ -0,0 +1,4 @@
+import React, { PropsWithChildren } from 'react';
+import { RowData } from '@tanstack/react-table';
+import { SelectableRowCellProps } from './selectable-row-cell.types';
+export declare const SelectableRowCell: <TData extends RowData<import("../../../..").CustomTData>>(props: React.PropsWithChildren<SelectableRowCellProps<TData>>) => JSX.Element;

package/dist/components/table/hooks/use-selectable-table-rows/components/selectable-row-cell/selectable-row-cell.styles.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const StyledCheckboxCell: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("../../../../../cell/cell.types").CellProps & import("react").RefAttributes<import("../../../../../cell/cell.types").CellProps>>, import("styled-components").DefaultTheme, {}, never>;

package/dist/components/table/hooks/use-selectable-table-rows/components/selectable-row-cell/selectable-row-cell.types.d.ts

@@ -0,0 +1,6 @@
+import { Row, RowData, Table } from '@tanstack/react-table';
+export interface SelectableRowCellProps<TData extends RowData> {
+    index: number;
+    row: Row<TData>;
+    table: Table<TData>;
+}

package/dist/components/table/hooks/use-selectable-table-rows/components/selectable-table-row-footer/index.d.ts

@@ -0,0 +1 @@
+export * from './selectable-table-row-footer';

package/dist/components/table/hooks/use-selectable-table-rows/components/selectable-table-row-footer/selectable-table-row-footer.d.ts

@@ -0,0 +1,3 @@
+import { PropsWithChildren } from 'react';
+import { SelectableRowFooterProps } from './selectable-table-row-footer.types';
+export declare const SelectableRowFooter: (props: PropsWithChildren<SelectableRowFooterProps>) => JSX.Element;

package/dist/components/table/hooks/use-selectable-table-rows/components/selectable-table-row-footer/selectable-table-row-footer.types.d.ts

@@ -0,0 +1,3 @@
+export interface SelectableRowFooterProps {
+    index: number;
+}

package/dist/components/table/hooks/use-selectable-table-rows/components/selectable-table-row-header/index.d.ts

@@ -0,0 +1 @@
+export * from './selectable-table-row-header';

package/dist/components/table/hooks/use-selectable-table-rows/components/selectable-table-row-header/selectable-table-row-header.d.ts

@@ -0,0 +1,4 @@
+import React, { PropsWithChildren } from 'react';
+import { RowData } from '@tanstack/react-table';
+import { SelectableRowHeaderProps } from './selectable-table-row-header.types';
+export declare const SelectableRowHeader: <TData extends RowData<import("../../../..").CustomTData>>(props: React.PropsWithChildren<SelectableRowHeaderProps<TData>>) => JSX.Element;

package/dist/components/table/hooks/use-selectable-table-rows/components/selectable-table-row-header/selectable-table-row-header.types.d.ts

@@ -0,0 +1,5 @@
+import { RowData, Table } from '@tanstack/react-table';
+export interface SelectableRowHeaderProps<TData extends RowData> {
+    index: number;
+    table: Table<TData>;
+}

package/dist/components/table/hooks/use-selectable-table-rows/helpers/get-row-range/get-row-range.d.ts

@@ -0,0 +1,3 @@
+import { Row, RowData } from '@tanstack/react-table';
+import { GetRowRangeProps } from './get-row-range.types';
+export declare const getRowRange: <TData extends RowData<import("../../../..").CustomTData>>(props: GetRowRangeProps<TData>) => Row<TData>[];

package/dist/components/table/hooks/use-selectable-table-rows/helpers/get-row-range/get-row-range.types.d.ts

@@ -0,0 +1,6 @@
+import { Row, RowData } from '@tanstack/react-table';
+export interface GetRowRangeProps<TData extends RowData> {
+    currentIndex: number;
+    prevIndex: number;
+    rows: Row<TData>[];
+}

package/dist/components/table/hooks/use-selectable-table-rows/helpers/get-row-range/index.d.ts

@@ -0,0 +1 @@
+export * from './get-row-range';

package/dist/components/table/hooks/use-selectable-table-rows/index.d.ts

@@ -0,0 +1 @@
+export * from './use-selectable-table-rows';

package/dist/components/table/hooks/use-selectable-table-rows/use-selectable-table-rows.constants.d.ts

@@ -0,0 +1,6 @@
+export declare const selectableRowsCheckboxSize = "2rem";
+export declare const dataAttrIsRowSelected = "data-is-row-selected";
+export declare const rowSelectionTypes: {
+    readonly checkboxes: "checkboxes";
+    readonly custom: "custom";
+};

package/dist/components/table/hooks/use-selectable-table-rows/use-selectable-table-rows.d.ts

@@ -0,0 +1,10 @@
+import { RowData } from '@tanstack/react-table';
+export declare const useSelectableTableRows: <TData extends RowData<import("../..").CustomTData>>() => {
+    deselectRows: (rowIds: (string | number)[]) => void;
+    getIsRowSelected: (rowId: number | string) => boolean;
+    getSelectedRowData: (props: {
+        idProperty: keyof TData;
+        records: TData[];
+    }) => (TData | undefined)[];
+    selectRows: (rowIds: (string | number)[]) => void;
+};

package/dist/components/table/hooks/use-selectable-table-rows/use-selectable-table-rows.types.d.ts

@@ -0,0 +1,9 @@
+import { RowData } from '@tanstack/react-table';
+import { rowSelectionTypes } from './use-selectable-table-rows.constants';
+export interface RowSelection<TData extends RowData> {
+    disabled?: boolean;
+    idProperty?: keyof TData;
+    onSelect?: (selectedRecords: TData[]) => void;
+    type: RowSelectionType;
+}
+export type RowSelectionType = typeof rowSelectionTypes[keyof typeof rowSelectionTypes];

package/dist/hooks/index.d.ts

@@ -0,0 +1 @@
+export * from './use-provider';

package/dist/hooks/use-provider/index.d.ts

@@ -0,0 +1 @@
+export * from './use-provider';

package/dist/hooks/use-provider/use-provider.d.ts

@@ -0,0 +1,33 @@
+import React, { PropsWithChildren } from 'react';
+import { GenericContextValue } from './use-provider.types';
+export declare const createGenericContext: <Type>(defaultValue: Type) => React.Context<GenericContextValue<Type>>;
+/**
+ * ```
+ * const defaultMyValue = 'foo';
+ *
+ * const MyContext = createGenericContext(defaultMyValue);
+ *
+ * const OuterWrapper = () => {
+ *   const MyProvider = useProvider({
+ *     Context: MyContext,
+ *     defaultValue: defaultMyValue,
+ *   });
+ *
+ *   return (
+ *     <MyProvider>
+ *       <InnerComponent />
+ *     </MyProvider>
+ *   );
+ * }
+ *
+ * const InnerComponent = () => {
+ *   const [myValue, setMyValue] = useContext(MyContext);
+ *
+ *   // ...
+ * }
+ * ```
+ */
+export declare const useProvider: <Type>(props: {
+    Context: React.Context<GenericContextValue<Type>>;
+    defaultValue: Type;
+}) => React.MemoExoticComponent<({ children }: PropsWithChildren<Record<never, never>>) => JSX.Element>;

package/dist/hooks/use-provider/use-provider.types.d.ts

@@ -0,0 +1,2 @@
+import { Dispatch, SetStateAction } from 'react';
+export type GenericContextValue<Type> = [Type, Dispatch<SetStateAction<Type>>];