# Table

- Human documentation: [https://docs.univer.ai/guides/docs/features/table](https://docs.univer.ai/guides/docs/features/table)

- Agent Markdown: [https://docs.univer.ai/guides/docs/features/table.md](https://docs.univer.ai/guides/docs/features/table.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [docs/features/table.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/docs/features/table.mdx)

---

#### Package metadata

```json
{
  "plugins": [
    {
      "client": "@univerjs-pro/docs-table",
      "facade": "@univerjs-pro/docs-table/facade"
    },
    {
      "client": "@univerjs-pro/docs-table-ui",
      "locale": "@univerjs-pro/docs-table-ui/locale/en-US",
      "style": "@univerjs-pro/docs-table-ui/lib/index.css"
    }
  ],
  "server": false
}
```

The enhanced table feature provides rich table editing capabilities for Univer Docs, including cell styling, border customization, row and column manipulation, and data population.

## Introduction

In Univer Docs, enhanced tables enable you to:

* **Insert tables programmatically**: Create tables with specified dimensions.
* **Manipulate structure**: Add, delete, and move rows and columns.
* **Style cells**: Apply borders, backgrounds, and text formatting.
* **Merge and split cells**: Combine cells for complex layouts.

## Plugin Mode

### Installation

#### npm

```bash
npm install @univerjs-pro/docs-table @univerjs-pro/docs-table-ui
```

#### pnpm

```bash
pnpm add @univerjs-pro/docs-table @univerjs-pro/docs-table-ui
```

#### yarn

```bash
yarn add @univerjs-pro/docs-table @univerjs-pro/docs-table-ui
```

#### bun

```bash
bun add @univerjs-pro/docs-table @univerjs-pro/docs-table-ui
```

### Usage

```typescript
import { UniverDocsTablePlugin } from '@univerjs-pro/docs-table' // [!code ++]
import { UniverDocsTableUIPlugin } from '@univerjs-pro/docs-table-ui' // [!code ++]
import DocsTableUIEnUS from '@univerjs-pro/docs-table-ui/locale/en-US' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'

import '@univerjs-pro/docs-table-ui/lib/index.css' // [!code ++]

const univer = new Univer({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]: mergeLocales(
      DocsTableUIEnUS, // [!code ++]
    ),
  },
})

univer.registerPlugin(UniverDocsTablePlugin) // [!code ++]
univer.registerPlugin(UniverDocsTableUIPlugin) // [!code ++]
```

If you have a commercial license for Univer, please refer to [Using License in Client](https://docs.univer.ai/server/license.md#in-plugin-mode) for configuration.

## Facade API

Make sure to import the facade before using the API:

```typescript
import '@univerjs-pro/docs-table/facade'
```

### Insert a Table

```typescript
const doc = univerAPI.getActiveDocument()
const table = doc?.insertTable(3, 4, { tableId: 'my-table' })
table?.setCellText(0, 0, 'Name')
```

### Insert a Table from Data

```typescript
const doc = univerAPI.getActiveDocument()
doc?.insertTableFromData([
  ['Name', 'Status'],
  ['Facade', 'Ready'],
], { headerRowCount: 1 })
```

### Get All Tables

```typescript
const doc = univerAPI.getActiveDocument()
const tables = doc?.getTables() ?? []
```

### Delete a Table

```typescript
const doc = univerAPI.getActiveDocument()
doc?.deleteTable('my-table')
```