@univerjs/sheets-formula/README.md

| Package Name | UMD Namespace | Version | License | Downloads | Contains CSS | Contains i18n locales | | --- | --- | --- | --- | --- | :---: | :---: | | `@univerjs/sheets-formula` | `UniverSheetsFormula` | [![][npm-version-shield]][npm-version-link] | ![

# @univerjs/sheets-formula

## Package Overview

| Package Name | UMD Namespace | Version | License | Downloads | Contains CSS | Contains i18n locales |
| --- | --- | --- | --- | --- | :---: | :---: |
| `@univerjs/sheets-formula` | `UniverSheetsFormula` | [![][npm-version-shield]][npm-version-link] | ![][npm-license-shield] | ![][npm-downloads-shield] | ⭕️ | ⭕️ |

## Introduction

`@univerjs/sheets-formula` provides the ability to edit formulas in spreadsheets, including features such as auto-completion, formula suggestions, drop-down filling for formulas, and copy-paste functionality.

> [!NOTE]
> Formula calculation is one of the core functionalities of spreadsheets, and formula calculation scheduling is done in `@univerjs/sheets`.

## Usage

### Installation

```shell
# Using npm
npm install @univerjs/sheets-formula

# Using pnpm
pnpm add @univerjs/sheets-formula
```

### How To Customize Formulas

If the officially provided formula does not meet your needs, you can expand the formula yourself. Depending on different needs, we provide multiple ways to support registering one or more custom formulas.

- [Register formula using Facade API](https://reference.univer.ai/zh-CN/classes/FFormula#registerfunction)
- [Custom Formula](https://docs.univer.ai/guides/recipes/tutorials/custom-formula)

<!-- Links -->
[npm-version-shield]: https://img.shields.io/npm/v/@univerjs/sheets-formula?style=flat-square
[npm-version-link]: https://npmjs.com/package/@univerjs/sheets-formula
[npm-license-shield]: https://img.shields.io/npm/l/@univerjs/sheets-formula?style=flat-square
[npm-downloads-shield]: https://img.shields.io/npm/dm/@univerjs/sheets-formula?style=flat-square