To use the parser, instantiate the Parser class.

Node.js:

var FormulaParser = require("hot-formula-parser").Parser;
var parser = new FormulaParser();

Browser:

<script src="/node_modules/hot-formula-parser/dist/formula-parser.min.js"></script>
<script>
  var parser = new formulaParser.Parser();
</script>

To merge cells, you must update both the cell objects and the sheet configuration.

1. Update Cell Objects: Set the mc attribute in the main (top-left) cell and in all other cells within the range. The mc object requires r (row), c (column), rs (rowspan), and cs (colspan).
2. Update Config: Set config.merge using a key format of "r_c" (e.g., "0_0") pointing to the same mc settings.

Example to merge A1:B2:

Cell Data:

[
    [
        {
            "m": "merge cell",
            "mc": { "r": 0, "c": 0, "rs": 2, "cs": 2 }
        },
        { "mc": { "r": 0, "c": 0 } }
    ],
    [
        { "mc": { "r": 0, "c": 0 } },
        { "mc": { "r": 0, "c": 0 } }
    ]
]

Config:

{
    "0_0": {
        "r": 0,
        "c": 0,
        "rs": 2,
        "cs": 2
    }
}

Borders are managed via the config.borderInfo property rather than the individual cell objects. To apply a border to a specific range, define the borderType, color, style, and the range (rows and columns).

Example: Setting a red, solid border for cell A1:

{
    "rangeType": "range",
    "borderType": "border-all",
    "color": "#000",
    "style": "1",
    "range": [
        {
            "row": [ 0, 0 ],
            "column": [0, 0]
        }
    ]
}

Install the core spreadsheet library using npm or yarn to integrate FortuneSheet's spreadsheet capabilities into your JavaScript project.

$ npm install --save @fortune-sheet/core

or

$ yarn add @fortune-sheet/core

You can install the hot-formula-parser library via NPM.

Note: This repository is deprecated. It is recommended to use the HyperFormula engine instead.

$ npm install hot-formula-parser --save

FortuneSheet supports online collaboration and backend synchronization via an onOp callback. This callback emits a list of Op objects whenever a user performs an action. Each Op describes the transformation required to move from the current state to the new state.

Example of an Op representing a cell formatting change (e.g., setting cell A2 to bold):

[
    {
        "op": "replace",
        "index": "0",
        "path": ["data", 1, 0, "bl"],
        "value": 1
    }
]

These operations are useful for updating backend databases and synchronizing state across multiple clients.

FortuneSheet is mostly compatible with Luckysheet's data structure, but requires the following naming updates:

1. Change sheet.index to sheet.id
2. Change sheet.calcChain[].id to sheet.calcChain[].id (Note: The README implies a structural change or specific mapping for calcChain IDs).

To use FortuneSheet in a React project, install the @fortune-sheet/react package using npm or yarn.

$ npm install --save @fortune-sheet/react
# or
$ yarn add @fortune-sheet/react

To render a spreadsheet, ensure your container (e.g., #root) has a defined width and height (setting them to auto may prevent the table from appearing). Import the Workbook component and its associated CSS, then pass a data array containing sheet objects.

import React from 'react';
import ReactDOM from 'react-dom';
import { Workbook } from "@fortune-sheet/react";
import "@fortune-sheet/react/dist/index.css"

ReactDOM.render(
  <Workbook data={[{ name: "Sheet1" }]} />,
  document.getElementById('root')
);