@dhtmlx/trial-react-spreadsheet 6.0.0

package/README.md

@@ -0,0 +1,111 @@
+# DHTMLX React Spreadsheet
+
+[![dhtmlx.com](https://img.shields.io/badge/made%20by-DHTMLX-blue)](https://dhtmlx.com/)
+[![npm: v.6.0.0](https://img.shields.io/badge/npm-v.6.0.0-blue.svg)](https://www.npmjs.com/package/@dhtmlx/trial-react-spreadsheet)
+[![License: Evaluation](https://img.shields.io/badge/license-Evaluation-important.svg)](https://dhtmlx.com/docs/products/license.shtml?eval)
+
+[Getting started](#getting-started) | [API overview](#api-overview) | [License](#license) | [Useful links](#links)
+
+[DHTMLX React Spreadsheet](https://dhtmlx.com/docs/products/dhtmlxSpreadsheet/) is a React wrapper for the [DHTMLX Spreadsheet](https://dhtmlx.com/docs/products/dhtmlxSpreadsheet/) library.
+
+[![dhtmlx-spreadsheet-data-filtering](https://dhtmlx.com/blog/wp-content/uploads/2022/11/filtering-by-condition.gif)](https://snippet.dhtmlx.com/uulux27v?tag=spreadsheet&mode=wide)
+
+It provides a declarative way to integrate DHTMLX Spreadsheet's Excel-like functionality — cell editing, formulas, formatting, filtering, sorting, multi-sheet support, and more — directly into React apps.
+
+> **Important:** this npm package is a _trial_ build intended for evaluation only.
+> For access to commercial licenses and technical support, please visit:
+> https://dhtmlx.com/docs/products/dhtmlxSpreadsheet/download.shtml
+
+<a name="getting-started"></a>
+
+## Getting started
+
+**Install package**
+
+Professional Evaluation version:
+
+```bash
+npm install @dhtmlx/trial-react-spreadsheet
+```
+
+And initialize:
+
+```tsx
+import ReactSpreadsheet from "@dhtmlx/trial-react-spreadsheet";
+import "@dhtmlx/trial-react-spreadsheet/spreadsheet.react.css";
+import type { SheetData } from "@dhtmlx/trial-react-spreadsheet";
+
+const sheets: SheetData[] = [
+	{
+		id: "sheet1",
+		name: "Sales",
+		cells: {
+			A1: { value: "Product" },
+			B1: { value: "Revenue", format: "currency" },
+			A2: { value: "Widget A" },
+			B2: { value: 1500, format: "currency" },
+		},
+	},
+];
+
+export default function App() {
+	return (
+		<div style={{ width: "100%", height: "500px" }}>
+			<ReactSpreadsheet
+				sheets={sheets}
+				onAfterEditEnd={(cell, value) => {
+					console.log(`Cell ${cell} updated to: ${value}`);
+				}}
+			/>
+		</div>
+	);
+}
+```
+
+### Requirements
+
+- React `18.x` or newer
+
+### Complete guides
+
+- https://docs.dhtmlx.com/spreadsheet/
+
+<a name="api-overview"></a>
+
+## API overview
+
+**Data** — `sheets`, `styles`, `activeSheet`, `search`, `loadUrl`
+
+**Configuration** — `menu`, `editLine`, `toolbarBlocks`, `multiSheets`, `formats`, `readonly`, `rowsCount`, `colsCount`, `localization`, `importModulePath`, `exportModulePath`
+
+**Appearance** — `theme` (light, dark, contrast-light, contrast-dark), `className`, `style`
+
+**Events** — 21 callbacks covering actions, selection, editing, sheets, and data lifecycle (e.g. `onBeforeAction`, `onAfterEditEnd`, `onAfterSheetChange`, `onStateChange`)
+
+**Ref API** — access the underlying DHTMLX instance via `SpreadsheetRef` for imperative operations (serialize, undo/redo, programmatic selection)
+
+**TypeScript** — full type exports: `SheetData`, `CellData`, `SearchConfig`, `Actions` enum, and all event handler types
+
+<a name="license"></a>
+
+## License
+
+@license
+
+DHTMLX Spreadsheet for React v.6.0.0 Evaluation
+
+This software is covered by DHTMLX Evaluation License and purposed only for evaluation.
+Contact sales@dhtmlx.com to get Commercial or Enterprise license.
+Usage without proper license is prohibited.
+
+(c) XB Software.
+
+
+<a name="links"></a>
+
+## Useful links
+
+- [DHTMLX Spreadsheet product page](https://dhtmlx.com/docs/products/dhtmlxSpreadsheet/)
+- [Official documentation](https://docs.dhtmlx.com/spreadsheet/)
+- [Online examples](https://dhtmlx.com/react/demos/spreadsheet/)
+- [Support forum](https://forum.dhtmlx.com/c/spreadsheet)