@syook/react-tabulous 3.0.3 → 4.0.0-beta-0.1

package/lib/types/reactTabulous/models/props/dataGridProps.d.ts

@@ -0,0 +1,158 @@
+import { type ReactNode } from 'react';
+import { type GridColDef } from '../columnDef';
+import { type GridDensity } from '../gridDensity';
+import { type GridSortDirection } from '../gridSortModel';
+import { type Logger } from '../logger';
+import { type GridRowId, type GridValidRowModel } from '../gridRows';
+import { type FilterFieldProps } from '../gridFiltersModel';
+export interface DataGridPropsWithDefaultValues {
+    data: any;
+    rootData: [];
+    filteredAndSortedData: [];
+    defaultPageSize: number;
+    columns: GridColDef[];
+    density: GridDensity;
+    emptyPlaceholder: string;
+    loading: boolean;
+    page: number;
+    pageSizeOptions: number[];
+    sortingOrder: GridSortDirection[];
+    sortField: string;
+    sortFieldType: string;
+    sortBy: GridSortDirection;
+    logger: Logger;
+    showColumnToolbar: boolean;
+    showFilterToolbar: boolean;
+    searchKeys: string[];
+    searchText: string;
+    /**
+     * If `true`, column filters are disabled.
+     * @default false
+     */
+    disableColumnFilter: boolean;
+    /**
+     * If `true`, the column menu is disabled.
+     * @default false
+     */
+    disableColumnMenu: boolean;
+    /**
+     * If `true`, the column pinning is disabled.
+     * @default false
+     */
+    disableColumnPinning: boolean;
+    /**
+     * If `true`, reordering columns is disabled.
+     * @default false
+     */
+    disableColumnReorder: boolean;
+    /**
+     * If `true`, resizing columns is disabled.
+     * @default false
+     */
+    disableColumnResize: boolean;
+    /**
+     * If `true`, hiding/showing columns is disabled.
+     * @default false
+     */
+    disableColumnSelector: boolean;
+    /**
+     * If `true`, the density selector is disabled.
+     * @default false
+     */
+    disableDensitySelector: boolean;
+    /**
+     * If `true`, sorting with multiple columns is disabled.
+     * @default false
+     */
+    disableMultipleColumnsSorting: boolean;
+    /**
+     * If `true`, quick search will be disabled.
+     * @default false
+     */
+    disableSearch: boolean;
+    /**
+     * If `true`, export will be disabled.
+     * @default false
+     */
+    disableColumnExport: boolean;
+    /**
+     * If `true`, there won't be any footer or pagination.
+     * @default false
+     */
+    hideFooter: boolean;
+    /**
+     * If `true`, the row count in pagination component in the footer is hidden.
+     * @default false
+     */
+    hideFooterRowCount: boolean;
+    /**
+     * If `true`, the pagination component in the footer is hidden but row count will be shown.
+     * @default false
+     */
+    hidePagination: boolean;
+    /**
+     * If `true`, the selected row count in the footer is hidden.
+     * @default false
+     */
+    pagination: boolean;
+    /**
+     * Pagination can be processed on the server or client-side.
+     * Set it to 'client' if you would like to handle the pagination on the client-side.
+     * Set it to 'server' if you would like to handle the pagination on the server-side.
+     * @default "client"
+     */
+    filters: FilterFieldProps[];
+    /**
+     * If `true`, the grid will have checkbox selection.
+     * @default false
+     */
+    checkboxSelection: boolean;
+    selectedRows: GridRowId[];
+    paginatedSelectedRows: GridRowId[];
+    /**
+     * Bulk actions to be displayed in the toolbar.
+     * @default []
+     * @example ['delete']
+     */
+    bulkActions: string[] | any[];
+    /**
+     * Callback fired when a bulk action is clicked.
+     * @param {string} action The action clicked.
+     * @param {GridRowId[]} selectedRows The selected rows.
+     */
+    onBulkActionClick: (action: string, selectedRows: GridRowId[]) => void;
+    /**
+     * The text to be displayed when the grid is empty.
+     * @default 'No rows'
+     * @example 'No rows'
+     * @example <span>No rows</span>
+     * @example <MyEmptyPlaceholder />
+     */
+    noRowsOverlay: ReactNode | string;
+    /**
+     * The custom component to render next to search.
+     */
+    children: null | ((filteredAndSortedData: any, searchText: string, columns: any) => JSX.Element | ReactNode);
+    /**
+     * Callback fired when the page, page size, sort or sort direction is changed.
+     * @param {number} page The page selected.
+     * @param {number} pageSize The number of rows in a page.
+     * @param {string} sort The field sorted.
+     * @param {string} sortDirection The direction of the sort.
+     * @param {boolean} fetchOnPageChange If `true`, the callback is fired when the page is changed.
+     */
+    fetchOnPageChange: null | ((page: number, pageSize: number, searchText: string, sort: string, sortDirection: GridSortDirection) => void);
+    /**
+     * for paginated api as the table does not have all the data to calculate the total number of rows
+     */
+    rowsCount: null | number;
+    /**
+     *
+     * if the export is custom.
+     *
+     */
+    customExport: null | ((filteredAndSortedData: any, searchText: string, columns: any) => void);
+}
+export type DataGridProps<R extends GridValidRowModel = any> = Partial<DataGridPropsWithDefaultValues> & {
+    pagination?: true;
+};

package/lib/types/reactTabulous/models/props/index.d.ts

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

package/lib/types/reactTabulous/reactTabulous/index.d.ts

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

package/lib/types/reactTabulous/reactTabulous/reactTabulous.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+import { type DataGridProps, type GridValidRowModel } from '../models';
+type DataGridComponent = React.ForwardRefExoticComponent<DataGridProps<GridValidRowModel> & React.RefAttributes<HTMLDivElement>>;
+export declare const ReactTabulous: DataGridComponent;
+export {};

package/lib/types/reactTabulous/reactTabulous/reactTabulousStyle.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export declare const DataGridStyle: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme | undefined;
+    as?: import("react").ElementType<any> | undefined;
+}, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;

package/lib/types/setupTests.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/package.json

@@ -1,77 +1,109 @@
 {
-  "name": "@syook/react-tabulous",
-  "version": "3.0.3",
-  "description": "Terrifically fabulous React Table",
-  "main": "lib/react-tabulous.min.js",
-  "files": [
-    "README.md",
-    "lib/"
-  ],
-  "keywords": [
-    "syook",
-    "table",
-    "react"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/syook/react-tabulous.git"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "author": "Syook",
-  "bugs": {
-    "url": "https://github.com/syook/react-tabulous/issues"
-  },
-  "scripts": {
-    "prepare": "husky install",
-    "start": "react-scripts start",
-    "build": "mkdir -p lib && rm -rf lib/* && NODE_ENV=production webpack --config webpack.config.js",
-    "test": "react-scripts test",
-    "eject": "react-scripts eject",
-    "npm-publish": "npm i && npm run build && npm publish",
-    "prettify": "prettier . -c --config .prettierrc",
-    "prettify:fix": "prettier . -c --config .prettierrc --write"
-  },
-  "eslintConfig": {
-    "extends": "react-app"
-  },
-  "browserslist": [
-    ">0.2%",
-    "not dead",
-    "not ie <= 11",
-    "not op_mini all"
-  ],
-  "devDependencies": {
-    "@babel/core": "^7.17.5",
-    "@babel/preset-env": "^7.16.11",
-    "@babel/preset-react": "^7.16.7",
-    "babel-loader": "8.1.0",
-    "css-loader": "^4.3.0",
-    "html-webpack-plugin": "^4.5.0",
-    "husky": "^7.0.4",
-    "prettier": "^2.5.1",
-    "prop-types": "^15.8.1",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "react-error-overlay": "6.0.9",
-    "react-scripts": "^4.0.3",
-    "react-overlays": "^5.2.0",
-    "style-loader": "^1.3.0",
-    "webpack": "4.44.2",
-    "webpack-cli": "^4.9.2"
-  },
-  "dependencies": {
-    "date-fns": "^2.28.0",
-    "lodash": "^4.17.21",
-    "moment": "^2.29.1",
-    "react-datepicker": "^4.6.0",
-    "react-select": "^5.2.2",
-    "semantic-ui-css": "^2.4.1",
-    "semantic-ui-react": "^2.1.2"
-  },
-  "peerDependencies": {
-    "react": "17",
-    "react-dom": "17"
-  }
+	"name": "@syook/react-tabulous",
+	"version": "4.0.0-beta-0.1",
+	"description": "Terrifically fabulous React Table",
+	"main": "lib/index.js",
+	"module": "lib/index.esm.js",
+	"types": "lib/index.d.ts",
+	"files": [
+		"README.md",
+		"lib"
+	],
+	"keywords": [
+		"syook",
+		"table",
+		"react"
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/syook/react-tabulous.git"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"author": "Syook",
+	"bugs": {
+		"url": "https://github.com/syook/react-tabulous/issues"
+	},
+	"lint-staged": {
+		"*.{js,jsx,json,css}": [
+			"npm run prettier:fix"
+		],
+		"*.{js, jsx, ts, tsx}": [
+			"npm run lint:fix"
+		]
+	},
+	"scripts": {
+		"prepare": "husky install",
+		"start": "react-scripts start",
+		"build": "react-scripts build",
+		"test": "react-scripts test",
+		"coverage": "npm test -- --coverage --watchAll --collectCoverageFrom='!src/data/**/*.{ts,tsx}'",
+		"eject": "react-scripts eject",
+		"lint": "eslint --ignore-path .eslintignore ./src",
+		"lint:fix": "npm run lint --fix",
+		"prettier": "prettier . -c --config .prettierrc",
+		"prettier:fix": "prettier . -c --config .prettierrc --write",
+		"rollup": "rm -rf lib && rollup -c",
+		"build:dev": "npm run rollup && npm pack",
+		"npm-publish": "yarn install && npm run build:dev && npm publish"
+	},
+	"dependencies": {
+		"@popperjs/core": "2.11.7"
+	},
+	"devDependencies": {
+		"@emotion/react": "11.11.0",
+		"@emotion/styled": "11.11.0",
+		"@rollup/plugin-babel": "6.0.3",
+		"@rollup/plugin-commonjs": "^25.0.0",
+		"@rollup/plugin-image": "3.0.2",
+		"@rollup/plugin-node-resolve": "^15.0.2",
+		"@rollup/plugin-terser": "0.4.3",
+		"@rollup/plugin-typescript": "11.1.1",
+		"@testing-library/jest-dom": "^5.16.5",
+		"@testing-library/react": "^14.0.0",
+		"@testing-library/user-event": "^14.4.3",
+		"@types/jest": "^29.5.1",
+		"@types/node": "^20.2.1",
+		"@types/react": "^18.2.6",
+		"@types/react-dom": "^18.2.4",
+		"@typescript-eslint/eslint-plugin": "^5.59.6",
+		"eslint": "^8.40.0",
+		"eslint-config-prettier": "8.8.0",
+		"eslint-config-standard-with-typescript": "^34.0.1",
+		"eslint-plugin-import": "^2.27.5",
+		"eslint-plugin-n": "^16.0.0",
+		"eslint-plugin-prettier": "^4.2.1",
+		"eslint-plugin-promise": "^6.1.1",
+		"eslint-plugin-react": "^7.32.2",
+		"eslint-plugin-react-hooks": "4.6.0",
+		"husky": "^8.0.3",
+		"prettier": "2.8.8",
+		"react": "^18.2.0",
+		"react-dom": "^18.2.0",
+		"react-scripts": "5.0.1",
+		"rollup": "^3.22.0",
+		"rollup-plugin-dts": "5.3.0",
+		"rollup-plugin-peer-deps-external": "^2.2.4",
+		"rollup-plugin-postcss": "^4.0.2",
+		"rollup-plugin-react-svg": "3.0.3",
+		"typescript": "^5.0.4",
+		"web-vitals": "^3.3.1"
+	},
+	"peerDependencies": {
+		"react": "^version",
+		"react-dom": "^version"
+	},
+	"browserslist": {
+		"production": [
+			">0.2%",
+			"not dead",
+			"not op_mini all"
+		],
+		"development": [
+			"last 1 chrome version",
+			"last 1 firefox version",
+			"last 1 safari version"
+		]
+	}
 }

package/CHANGELOG.md

@@ -1,27 +0,0 @@
-# react-tabulous change log
-
-All notable changes to this project will be documented in this file.
-
-Project versioning adheres to [Semantic Versioning](http://semver.org/).
-
-Commit convention is based on [Conventional Commits](http://conventionalcommits.org).
-
-Change log format is based on [Keep a Changelog](http://keepachangelog.com/).
-
-## [Unreleased]
-
--
-
-## [Released]
-
-## [2.7.7](https://github.com/syook/react-tabulous/releases/tag/2.7.7) - 2021-07-08
-
-### Fixes
-
-- fix pagination not working on changing the rows per page option (#74)
-
-## 2.7.6 - 2021-05-17
-
-### Fixes
-
-- Fix selected rows in bulk actions updating to object type (#79)