jb-grid 0.4.1 → 0.5.0

package/react/dist/JBGrid.d.ts

@@ -1,26 +1,288 @@
-import React, { type ReactNode } from 'react';
-export { JBGridData } from './JBGridData.js';
-import 'jb-searchbar';
-import type { AnyObject, JBGridBridgeClassInterface, JBGridConfig, JBGridI18nConfig, SearchbarConfig } from './types.js';
-export { JBPagination, type Props as PaginationProps } from './Components/Pagination.js';
-export * from './Components/Row.js';
-export * from './Components/Cell.js';
-export * from './Components/ExpandRow.js';
-export * from './Components/ExpandToggle.js';
-export * from './types.js';
-export type Props<T extends AnyObject> = {
-    searchbarConfig?: SearchbarConfig | null | undefined;
-    config: JBGridConfig<T>;
-    bridge: JBGridBridgeClassInterface;
-    isFullscreen?: boolean;
-    className?: string;
-    style?: React.CSSProperties;
-    onFullscreenChange?: (isFullscreen: boolean) => void;
-    title: string;
-    i18n?: JBGridI18nConfig | null | undefined;
-    contentError?: ReactNode;
-    headerEndComponents?: ReactNode[] | ReactNode;
-    children?: React.ReactNode | React.ReactNode[];
-};
-declare function JBGridComponent<T extends AnyObject>(props: Props<T>): React.JSX.Element;
-export declare const JBGrid: typeof JBGridComponent;
+import React, { DetailedHTMLProps, FormEventHandler, HTMLAttributes, PropsWithChildren, ReactNode } from "react";
+import { JBCellWebComponent, JBExpandToggleWebComponent, JBPaginationWebComponent, JBRowWebComponent, RowTemplate } from "jb-grid";
+import { JBElementStandardProps } from "jb-core/react";
+
+//#region modules/jb-grid/react/lib/types.d.ts
+type AnyObject = Record<string, any>;
+type JBGridRowData<T extends AnyObject> = T;
+type JBGridResponseData<T extends AnyObject> = {
+  pageIndex: number;
+  startItemIndex: number;
+  endItemIndex: number;
+  totalItemsCount: number;
+  totalPages: number;
+  content: JBGridRowData<T>[];
+};
+type JBGridPaginationMeta = {
+  startItemIndex: number;
+  endItemIndex: number;
+  totalItemsCount: number;
+};
+type JBGridI18nMessage = {
+  serverErrorText?: string;
+  serverErrorTitle?: string;
+  serverErrorRefreshButtonTitle?: string;
+  EnterPageNumberMessage?: string;
+  currentAvailableItem?: string;
+  pageItemCount?: string;
+  from?: string;
+};
+type JBGridI18nConfig = {
+  messages?: JBGridI18nMessage;
+  showPersianNumber?: boolean;
+};
+type JBGridRenderContext = Readonly<{
+  refreshView: () => void;
+}>;
+type JBGridCallbacks = {
+  /**
+   * @deprecated use onFullscreen and onExitFullscreen instead
+   */
+  onFullscreenChange?: (isFullscreen: boolean) => unknown;
+  onFullscreen?: () => unknown;
+  onPageIndexChange?: (newPageIndex: number) => unknown;
+  onPageSizeChange?: (newPageSize: number) => unknown;
+  onRefresh?: () => unknown | Promise<unknown>;
+  onExitFullscreen?: () => unknown;
+};
+//#endregion
+//#region modules/jb-grid/react/lib/Components/types.d.ts
+type JBPaginationDirectAttributeProps = {
+  pageIndex?: number;
+  max?: number;
+  min?: number;
+  onChange?: FormEventHandler<JBPaginationWebComponent>;
+  showPersianNumber?: boolean;
+};
+//#endregion
+//#region modules/jb-grid/react/lib/Components/module-declaration.d.ts
+type TableHeaderTemplate$1 = Array<{
+  name: string;
+  size?: string | number;
+}>;
+type JBTableHeaderWebComponent$1 = HTMLElement & {
+  headerTemplate: TableHeaderTemplate$1;
+};
+type JBColumnHeaderSort$1 = "asc" | "desc";
+type JBColumnHeaderWebComponent$1 = HTMLElement & {
+  name: string;
+  sortable: boolean;
+  sort: JBColumnHeaderSort$1 | null;
+};
+type JBPaginationInfoWebComponent$1 = HTMLElement & {
+  pageSize: number;
+  pageSizes: number[];
+  startItemIndex: number;
+  endItemIndex: number;
+  totalItemsCount: number;
+  pageItemCountTitle: string;
+  fromLabel: string;
+  currentAvailableItemTitle: string;
+  showPersianNumber: boolean;
+};
+type JBRefreshIconWebComponent = HTMLElement & {
+  play: () => void;
+  pause: () => void;
+  stop: () => void;
+};
+type JBFullscreenIconState$1 = "enter" | "exit";
+type JBFullscreenIconWebComponent$1 = HTMLElement & {
+  state: JBFullscreenIconState$1;
+};
+type JBPaginationAttributes = DetailedHTMLProps<HTMLAttributes<JBPaginationWebComponent>, JBPaginationWebComponent> & JBPaginationDirectAttributeProps;
+type JBPaginationInfoAttributes = DetailedHTMLProps<HTMLAttributes<JBPaginationInfoWebComponent$1>, JBPaginationInfoWebComponent$1>;
+type JBRefreshIconAttributes = DetailedHTMLProps<HTMLAttributes<JBRefreshIconWebComponent>, JBRefreshIconWebComponent>;
+type JBFullscreenIconAttributes = DetailedHTMLProps<HTMLAttributes<JBFullscreenIconWebComponent$1>, JBFullscreenIconWebComponent$1> & {
+  state?: JBFullscreenIconState$1;
+};
+type JBRowAttributes = DetailedHTMLProps<HTMLAttributes<JBRowWebComponent>, JBRowWebComponent>;
+type JBTableHeaderAttributes = DetailedHTMLProps<HTMLAttributes<JBTableHeaderWebComponent$1>, JBTableHeaderWebComponent$1> & {
+  headerTemplate?: TableHeaderTemplate$1;
+};
+type JBColumnHeaderAttributes = DetailedHTMLProps<HTMLAttributes<JBColumnHeaderWebComponent$1>, JBColumnHeaderWebComponent$1> & {
+  name: string;
+  sortable?: boolean;
+  sort?: JBColumnHeaderSort$1;
+};
+type JBCellAttributes = DetailedHTMLProps<HTMLAttributes<JBCellWebComponent>, JBCellWebComponent> & {
+  ellipsis?: boolean | number;
+};
+type JBExpandToggleAttributes = DetailedHTMLProps<HTMLAttributes<JBExpandToggleWebComponent>, JBExpandToggleWebComponent>;
+declare module "react" {
+  namespace JSX {
+    interface IntrinsicElements {
+      'jb-pagination': JBPaginationAttributes;
+      'jb-pagination-info': JBPaginationInfoAttributes;
+      'jb-refresh-icon': JBRefreshIconAttributes;
+      'jb-fullscreen-icon': JBFullscreenIconAttributes;
+      'jb-row': JBRowAttributes;
+      'jb-table-header': JBTableHeaderAttributes;
+      'jb-col-header': JBColumnHeaderAttributes;
+      'jb-cell': JBCellAttributes;
+      'jb-expand-toggle': JBExpandToggleAttributes;
+    }
+  }
+}
+//#endregion
+//#region modules/jb-grid/react/lib/Components/Pagination.d.ts
+declare function JBPagination(props: Props): React.JSX.Element;
+type Props = JBElementStandardProps<JBPaginationWebComponent, keyof JBPaginationDirectAttributeProps> & JBPaginationDirectAttributeProps;
+//#endregion
+//#region modules/jb-grid/react/lib/Components/PaginationInfo.d.ts
+type JBPaginationInfoWebComponent = HTMLElement & {
+  pageSize: number;
+  pageSizes: number[];
+  startItemIndex: number;
+  endItemIndex: number;
+  totalItemsCount: number;
+  pageItemCountTitle: string;
+  fromLabel: string;
+  currentAvailableItemTitle: string;
+  showPersianNumber: boolean;
+};
+type JBPaginationInfoPageSizeChangeEvent = CustomEvent<{
+  pageSize: number;
+}>;
+type PaginationInfoProps = Omit<JBPaginationInfoAttributes, "onPageSizeChange" | "ref"> & {
+  pageSize: number;
+  pageSizes?: number[];
+  startItemIndex: number;
+  endItemIndex: number;
+  totalItemsCount: number;
+  pageItemCountTitle?: string;
+  fromLabel?: string;
+  currentAvailableItemTitle?: string;
+  showPersianNumber?: boolean;
+  onPageSizeChange?: (event: JBPaginationInfoPageSizeChangeEvent) => void;
+};
+declare const JBPaginationInfo: React.ForwardRefExoticComponent<Omit<JBPaginationInfoAttributes, "ref" | "onPageSizeChange"> & {
+  pageSize: number;
+  pageSizes?: number[];
+  startItemIndex: number;
+  endItemIndex: number;
+  totalItemsCount: number;
+  pageItemCountTitle?: string;
+  fromLabel?: string;
+  currentAvailableItemTitle?: string;
+  showPersianNumber?: boolean;
+  onPageSizeChange?: (event: JBPaginationInfoPageSizeChangeEvent) => void;
+} & React.RefAttributes<JBPaginationInfoWebComponent | null>>;
+//#endregion
+//#region modules/jb-grid/react/lib/Components/RefreshIcon.d.ts
+type RefreshIconProps = Omit<JBRefreshIconAttributes, "ref">;
+declare const JBRefreshIcon: React.ForwardRefExoticComponent<RefreshIconProps & React.RefAttributes<JBRefreshIconWebComponent | null>>;
+//#endregion
+//#region modules/jb-grid/react/lib/Components/FullscreenIcon.d.ts
+type JBFullscreenIconState = "enter" | "exit";
+type JBFullscreenIconWebComponent = HTMLElement & {
+  state: JBFullscreenIconState;
+};
+type FullscreenIconProps = Omit<JBFullscreenIconAttributes, "ref" | "state"> & {
+  state?: JBFullscreenIconState;
+};
+declare const JBFullscreenIcon: React.ForwardRefExoticComponent<Omit<JBFullscreenIconAttributes, "ref" | "state"> & {
+  state?: JBFullscreenIconState;
+} & React.RefAttributes<JBFullscreenIconWebComponent | null>>;
+//#endregion
+//#region modules/jb-grid/react/lib/Components/Row.d.ts
+type RowProps = Omit<JBRowAttributes, "ref" | "rowTemplate" | "isOpen"> & {
+  rowTemplate?: RowTemplate;
+  isOpen?: boolean;
+};
+declare const JBRow: React.ForwardRefExoticComponent<Omit<JBRowAttributes, "ref" | "rowTemplate" | "isOpen"> & {
+  rowTemplate?: RowTemplate;
+  isOpen?: boolean;
+} & React.RefAttributes<JBRowWebComponent | null>>;
+//#endregion
+//#region modules/jb-grid/react/lib/Components/TableHeader.d.ts
+type TableHeaderTemplate = Array<{
+  name: string;
+  size?: string | number;
+}>;
+type JBTableHeaderWebComponent = HTMLElement & {
+  headerTemplate: TableHeaderTemplate;
+};
+type TableHeaderProps = Omit<JBTableHeaderAttributes, "headerTemplate" | "ref"> & {
+  headerTemplate?: TableHeaderTemplate;
+};
+declare const JBTableHeader: React.ForwardRefExoticComponent<Omit<JBTableHeaderAttributes, "ref" | "headerTemplate"> & {
+  headerTemplate?: TableHeaderTemplate;
+} & React.RefAttributes<JBTableHeaderWebComponent | null>>;
+//#endregion
+//#region modules/jb-grid/react/lib/Components/ColumnHeader.d.ts
+type JBColumnHeaderSort = "asc" | "desc";
+type JBColumnHeaderWebComponent = HTMLElement & {
+  name: string;
+  sortable: boolean;
+  sort: JBColumnHeaderSort | null;
+};
+type JBColumnHeaderSortEvent = CustomEvent<{
+  name: string;
+  sort: JBColumnHeaderSort;
+}>;
+type ColumnHeaderProps = Omit<JBColumnHeaderAttributes, "name" | "onSort" | "ref" | "sort" | "sortable"> & {
+  name: string;
+  sortable?: boolean;
+  sort?: JBColumnHeaderSort;
+  onSort?: (event: JBColumnHeaderSortEvent) => void;
+};
+declare const JBColumnHeader: React.ForwardRefExoticComponent<Omit<JBColumnHeaderAttributes, "ref" | "name" | "onSort" | "sort" | "sortable"> & {
+  name: string;
+  sortable?: boolean;
+  sort?: JBColumnHeaderSort;
+  onSort?: (event: JBColumnHeaderSortEvent) => void;
+} & React.RefAttributes<JBColumnHeaderWebComponent | null>>;
+//#endregion
+//#region modules/jb-grid/react/lib/Components/Cell.d.ts
+type CellProps = Omit<JBCellAttributes, "ref" | "name"> & {
+  name: string;
+  label?: string;
+};
+declare const JBCell: React.ForwardRefExoticComponent<Omit<JBCellAttributes, "ref" | "name"> & {
+  name: string;
+  label?: string;
+} & React.RefAttributes<JBCellWebComponent | null>>;
+//#endregion
+//#region modules/jb-grid/react/lib/Components/ExpandRow.d.ts
+declare function ExpandRow(props: ExpandRowProps): React.JSX.Element;
+type ExpandRowProps = PropsWithChildren<React.DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>>;
+//#endregion
+//#region modules/jb-grid/react/lib/Components/ExpandToggle.d.ts
+type ToggleProps = Omit<JBExpandToggleAttributes, "ref">;
+declare const JBExpandToggle: React.ForwardRefExoticComponent<ToggleProps & React.RefAttributes<JBExpandToggleWebComponent | null>>;
+//#endregion
+//#region modules/jb-grid/react/lib/JBGrid.d.ts
+type Props$1<T extends AnyObject> = {
+  searchbarComponent?: ReactNode;
+  tableHeader?: ReactNode;
+  data: JBGridRowData<T>[];
+  pageIndex: number;
+  pageSize: number;
+  totalItemsCount: number;
+  totalPages?: number;
+  startItemIndex?: number;
+  endItemIndex?: number;
+  isLoading?: boolean;
+  isErrorOccurred?: boolean;
+  isFullscreen?: boolean;
+  className?: string;
+  style?: React.CSSProperties;
+  onFullscreen?: JBGridCallbacks["onFullscreen"];
+  onPageIndexChange?: JBGridCallbacks["onPageIndexChange"];
+  onPageSizeChange?: JBGridCallbacks["onPageSizeChange"];
+  onRefresh?: JBGridCallbacks["onRefresh"];
+  onExitFullscreen?: JBGridCallbacks["onExitFullscreen"];
+  /**
+   * @deprecated use onFullscreen and onExitFullscreen instead
+   */
+  onFullscreenChange?: JBGridCallbacks["onFullscreenChange"];
+  title: string;
+  i18n?: JBGridI18nConfig | null | undefined;
+  contentError?: ReactNode;
+  headerEndComponents?: ReactNode[] | ReactNode;
+  children?: React.ReactNode | React.ReactNode[] | ((data: JBGridRowData<T>[], context: JBGridRenderContext) => React.ReactNode | React.ReactNode[]);
+};
+declare function JBGridComponent<T extends AnyObject>(props: Props$1<T>): React.JSX.Element;
+declare const JBGrid: typeof JBGridComponent;
+//#endregion
+export { AnyObject, CellProps, ColumnHeaderProps, ExpandRow, ExpandRowProps, FullscreenIconProps, JBCell, JBColumnHeader, JBExpandToggle, JBFullscreenIcon, JBGrid, JBGridCallbacks, JBGridI18nConfig, JBGridI18nMessage, JBGridPaginationMeta, JBGridRenderContext, JBGridResponseData, JBGridRowData, JBPagination, JBPaginationInfo, JBRefreshIcon, JBRow, JBTableHeader, PaginationInfoProps, type Props as PaginationProps, Props$1 as Props, RefreshIconProps, RowProps, TableHeaderProps, ToggleProps };