@handsontable/react 14.0.0 → 14.1.0-next-ba8c2b0-20240110

package/hotTableClass.d.ts

@@ -0,0 +1,237 @@
+import React from 'react';
+import Handsontable from 'handsontable/base';
+import { RenderersPortalManager } from './renderersPortalManager';
+import { HotTableProps, HotEditorElement, HotEditorCache, EditorScopeIdentifier } from './types';
+/**
+ * A Handsontable-ReactJS wrapper.
+ *
+ * To implement, use the `HotTable` tag with properties corresponding to Handsontable options.
+ * For example:
+ *
+ * ```js
+ * <HotTable id="hot" data={dataObject} contextMenu={true} colHeaders={true} width={600} height={300} stretchH="all" />
+ *
+ * // is analogous to
+ * let hot = new Handsontable(document.getElementById('hot'), {
+ *    data: dataObject,
+ *    contextMenu: true,
+ *    colHeaders: true,
+ *    width: 600
+ *    height: 300
+ * });
+ *
+ * ```
+ *
+ * @class HotTableCB
+ */
+declare class HotTableClass extends React.Component<HotTableProps, {}> {
+    /**
+     * The `id` of the main Handsontable DOM element.
+     *
+     * @type {String}
+     */
+    id: string;
+    /**
+     * Reference to the Handsontable instance.
+     *
+     * @private
+     * @type {Object}
+     */
+    __hotInstance: Handsontable | null;
+    /**
+     * Reference to the main Handsontable DOM element.
+     *
+     * @type {HTMLElement}
+     */
+    hotElementRef: HTMLElement;
+    /**
+     * Class name added to the component DOM element.
+     *
+     * @type {String}
+     */
+    className: string;
+    /**
+     * Style object passed to the component.
+     *
+     * @type {React.CSSProperties}
+     */
+    style: React.CSSProperties;
+    /**
+     * Array of object containing the column settings.
+     *
+     * @type {Array}
+     */
+    columnSettings: Handsontable.ColumnSettings[];
+    /**
+     * Component used to manage the renderer portals.
+     *
+     * @type {React.Component}
+     */
+    renderersPortalManager: RenderersPortalManager;
+    /**
+     * Array containing the portals cashed to be rendered in bulk after Handsontable's render cycle.
+     */
+    portalCacheArray: React.ReactPortal[];
+    /**
+     * The rendered cells cache.
+     *
+     * @private
+     * @type {Map}
+     */
+    private renderedCellCache;
+    /**
+     * Editor cache.
+     *
+     * @private
+     * @type {Map}
+     */
+    private editorCache;
+    /**
+     * Map with column indexes (or a string = 'global') as keys, and booleans as values. Each key represents a component-based editor
+     * declared for the used column index, or a global one, if the key is the `global` string.
+     *
+     * @private
+     * @type {Map}
+     */
+    private componentRendererColumns;
+    /**
+     * Package version getter.
+     *
+     * @returns The version number of the package.
+     */
+    static get version(): string;
+    /**
+     * Getter for the property storing the Handsontable instance.
+     */
+    get hotInstance(): Handsontable | null;
+    /**
+     * Setter for the property storing the Handsontable instance.
+     * @param {Handsontable} hotInstance The Handsontable instance.
+     */
+    set hotInstance(hotInstance: Handsontable | null);
+    /**
+     * Prop types to be checked at runtime.
+     */
+    static propTypes: object;
+    /**
+     * Get the rendered table cell cache.
+     *
+     * @returns {Map}
+     */
+    getRenderedCellCache(): Map<string, HTMLTableCellElement>;
+    /**
+     * Get the editor cache and return it.
+     *
+     * @returns {Map}
+     */
+    getEditorCache(): HotEditorCache;
+    /**
+     * Clear both the editor and the renderer cache.
+     */
+    clearCache(): void;
+    /**
+     * Get the `Document` object corresponding to the main component element.
+     *
+     * @returns The `Document` object used by the component.
+     */
+    getOwnerDocument(): Document | null;
+    /**
+     * Set the reference to the main Handsontable DOM element.
+     *
+     * @param {HTMLElement} element The main Handsontable DOM element.
+     */
+    private setHotElementRef;
+    /**
+     * Return a renderer wrapper function for the provided renderer component.
+     *
+     * @param {React.ReactElement} rendererElement React renderer component.
+     * @returns {Handsontable.renderers.Base} The Handsontable rendering function.
+     */
+    getRendererWrapper(rendererElement: React.ReactElement): typeof Handsontable.renderers.BaseRenderer | any;
+    /**
+     * Create a fresh class to be used as an editor, based on the provided editor React element.
+     *
+     * @param {React.ReactElement} editorElement React editor component.
+     * @param {string|number} [editorColumnScope] The editor scope (column index or a 'global' string). Defaults to
+     * 'global'.
+     * @returns {Function} A class to be passed to the Handsontable editor settings.
+     */
+    getEditorClass(editorElement: HotEditorElement, editorColumnScope?: EditorScopeIdentifier): typeof Handsontable.editors.BaseEditor;
+    /**
+     * Create a class to be passed to the Handsontable's settings.
+     *
+     * @param {React.ReactElement} editorComponent React editor component.
+     * @returns {Function} A class to be passed to the Handsontable editor settings.
+     */
+    makeEditorClass(editorComponent: React.Component): typeof Handsontable.editors.BaseEditor;
+    /**
+     * Get the renderer element for the entire HotTable instance.
+     *
+     * @returns {React.ReactElement} React renderer component element.
+     */
+    getGlobalRendererElement(): React.ReactElement;
+    /**
+     * Get the editor element for the entire HotTable instance.
+     *
+     * @param {React.ReactNode} [children] Children of the HotTable instance. Defaults to `this.props.children`.
+     * @returns {React.ReactElement} React editor component element.
+     */
+    getGlobalEditorElement(): HotEditorElement | null;
+    /**
+     * Create a new settings object containing the column settings and global editors and renderers.
+     *
+     * @returns {Handsontable.GridSettings} New global set of settings for Handsontable.
+     */
+    createNewGlobalSettings(): Handsontable.GridSettings;
+    /**
+     * Detect if `autoRowSize` or `autoColumnSize` is defined, and if so, throw an incompatibility warning.
+     *
+     * @param {Handsontable.GridSettings} newGlobalSettings New global settings passed as Handsontable config.
+     */
+    displayAutoSizeWarning(newGlobalSettings: Handsontable.GridSettings): void;
+    /**
+     * Sets the column settings based on information received from HotColumn.
+     *
+     * @param {HotTableProps} columnSettings Column settings object.
+     * @param {Number} columnIndex Column index.
+     */
+    setHotColumnSettings(columnSettings: Handsontable.ColumnSettings, columnIndex: number): void;
+    /**
+     * Handsontable's `beforeViewRender` hook callback.
+     */
+    handsontableBeforeViewRender(): void;
+    /**
+     * Handsontable's `afterViewRender` hook callback.
+     */
+    handsontableAfterViewRender(): void;
+    /**
+     * Call the `updateSettings` method for the Handsontable instance.
+     *
+     * @param {Object} newSettings The settings object.
+     */
+    private updateHot;
+    /**
+     * Set the renderers portal manager ref.
+     *
+     * @param {React.ReactComponent} pmComponent The PortalManager component.
+     */
+    private setRenderersPortalManagerRef;
+    /**
+     * Initialize Handsontable after the component has mounted.
+     */
+    componentDidMount(): void;
+    /**
+     * Logic performed after the component update.
+     */
+    componentDidUpdate(): void;
+    /**
+     * Destroy the Handsontable instance when the parent component unmounts.
+     */
+    componentWillUnmount(): void;
+    /**
+     * Render the component.
+     */
+    render(): React.ReactElement;
+}
+export default HotTableClass;
+export { HotTableClass };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@handsontable/react",
-  "version": "14.0.0",
+  "version": "14.1.0-next-ba8c2b0-20240110",
   "description": "Best Data Grid for React with Spreadsheet Look and Feel.",
   "author": "Handsoncode <hello@handsoncode.net> (https://handsoncode.net)",
   "homepage": "https://handsontable.com",
@@ -11,8 +11,8 @@
   "unpkg": "./dist/react-handsontable.min.js",
   "types": "./index.d.ts",
   "exports": {
-    "./dist/react-handsontable.js" : "./dist/react-handsontable.js",
-    "./dist/react-handsontable.min.js" : "./dist/react-handsontable.min.js",
+    "./dist/react-handsontable.js": "./dist/react-handsontable.js",
+    "./dist/react-handsontable.min.js": "./dist/react-handsontable.min.js",
     ".": {
       "types": "./index.d.ts",
       "import": "./es/react-handsontable.mjs",
@@ -61,20 +61,22 @@
     "@babel/preset-react": "^7.9.4",
     "@babel/preset-typescript": "^7.9.0",
     "@babel/runtime": "^7.9.2",
-    "@types/react-dom": "^16.9.1",
+    "@testing-library/react": "^14.1.2",
+    "@types/react": "^18.2.0",
+    "@types/react-dom": "^18.2.0",
     "@types/react-redux": "^7.1.7",
-    "@types/react": "^16.9.5",
     "babel-core": "^7.0.0-bridge.0",
     "cpy-cli": "^3.1.1",
     "cross-env": "^7.0.3",
-    "handsontable": "^14.0.0",
+    "handsontable": "14.1.0-next-ba8c2b0-20240110",
     "jest": "^25.1.0",
     "prop-types": "^15.7.2",
-    "react-dom": "^16.10.2",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "react-redux": "^7.1.1",
-    "react": "^16.10.2",
     "redux": "^4.0.4",
     "rimraf": "^3.0.2",
+    "rollup": "^2.58.0",
     "rollup-plugin-alias": "^1.5.2",
     "rollup-plugin-babel": "^4.3.3",
     "rollup-plugin-commonjs": "^10.0.1",
@@ -83,12 +85,11 @@
     "rollup-plugin-replace": "^2.2.0",
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-typescript2": "^0.22.1",
-    "rollup": "^2.58.0",
     "typescript": "3.8.2",
     "uglify-js": "^3.4.9"
   },
   "peerDependencies": {
-    "handsontable": ">=14.0.0"
+    "handsontable": "14.1.0-next-ba8c2b0-20240110"
   },
   "scripts": {
     "build": "npm run clean && npm run build:commonjs && npm run build:es && npm run build:umd && npm run build:min",
@@ -99,6 +100,7 @@
     "clean": "rimraf ./es/ && rimraf ./commonjs/ && rimraf ./dist/ && rimraf ./*.d.ts",
     "publish-package": "npm publish",
     "test": "jest",
+    "test.watch": "jest --watch",
     "watch:commonjs": "cross-env NODE_ENV=cjs rollup -c --watch",
     "watch:es": "cross-env NODE_ENV=es rollup -c --watch"
   },

package/types.d.ts

@@ -37,6 +37,7 @@ export interface HotEditorProps {
  * Properties related to the HotColumn architecture.
  */
 export interface HotColumnProps extends Handsontable.ColumnSettings {
+    settings?: Handsontable.ColumnSettings;
     _componentRendererColumns?: Map<number | string, boolean>;
     _emitColumnSettings?: (columnSettings: Handsontable.ColumnSettings, columnIndex: number) => void;
     _columnIndex?: number;