# Crosshair Highlighting

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

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

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

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

---

#### Package metadata

```json
{
  "plugins": [
    {
      "client": "@univerjs/sheets-crosshair-highlight",
      "facade": "@univerjs/sheets-crosshair-highlight/facade",
      "locale": "@univerjs/sheets-crosshair-highlight/locale/en-US",
      "style": "@univerjs/sheets-crosshair-highlight/lib/index.css"
    }
  ],
  "server": false
}
```

Crosshair highlighting highlights the row and column of the currently selected cell, making it easier for users to identify the active cell.

> Interactive example: [Open the playground](/playground/sheets/crosshair-highlighting)

## Preset Mode

The crosshair highlighting feature does not provide a preset mode but supports mixing with its plugin.

#### npm

```bash
npm install @univerjs/sheets-crosshair-highlight
```

#### pnpm

```bash
pnpm add @univerjs/sheets-crosshair-highlight
```

#### yarn

```bash
yarn add @univerjs/sheets-crosshair-highlight
```

#### bun

```bash
bun add @univerjs/sheets-crosshair-highlight
```

### Usage

```typescript
import UniverPresetSheetsCoreEnUS from '@univerjs/preset-sheets-core/locales/en-US'
import { UniverSheetsCrosshairHighlightPlugin } from '@univerjs/sheets-crosshair-highlight' // [!code ++]

import '@univerjs/sheets-crosshair-highlight/facade' // [!code ++]

import '@univerjs/sheets-crosshair-highlight/lib/index.css' // [!code ++]

const { univerAPI } = createUniver({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]: mergeLocales(
      UniverPresetSheetsCoreEnUS,
      SheetsCrosshairHighlightEnUS, // [!code ++]
    ),
  },
  presets: [
    UniverSheetsCorePreset(),
  ],
  plugins: [
    UniverSheetsCrosshairHighlightPlugin, // [!code ++]
  ],
})
```

## Plugin Mode

### Installation

#### npm

```bash
npm install @univerjs/sheets-crosshair-highlight
```

#### pnpm

```bash
pnpm add @univerjs/sheets-crosshair-highlight
```

#### yarn

```bash
yarn add @univerjs/sheets-crosshair-highlight
```

#### bun

```bash
bun add @univerjs/sheets-crosshair-highlight
```

### Usage

```typescript
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import { UniverSheetsCrosshairHighlightPlugin } from '@univerjs/sheets-crosshair-highlight'
import SheetsCrosshairHighlightEnUS from '@univerjs/sheets-crosshair-highlight/locale/en-US'

import '@univerjs/sheets-crosshair-highlight/lib/index.css'

import '@univerjs/sheets-crosshair-highlight/facade'

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

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

## Facade API

Complete Facade API type definitions can be found in the [FacadeAPI](https://reference.univer.ai/en-US).

### Importing

> [!INFO: Plugin mode note]
> Only plugin mode requires manually importing the Facade package. Preset mode already includes the corresponding Facade package, so no extra import is needed.

```typescript
import '@univerjs/sheets-crosshair-highlight/facade'
```

### Toggle Crosshair Highlight

```typescript
univerAPI.setCrosshairHighlightEnabled(true)

univerAPI.setCrosshairHighlightEnabled(false)
```

### Get Crosshair Highlight Enabled Status

```typescript
univerAPI.getCrosshairHighlightEnabled()
```

### Event Listeners

Complete event type definitions can be found in the [Events](https://docs.univer.ai/reference/facade/events.md).

`CrosshairHighlightEnabledChanged` event will be triggered when the crosshair highlight enabled status changes.

```typescript
const disposable = univerAPI.addEvent(univerAPI.Event.CrosshairHighlightEnabledChanged, (params) => {
  const { enabled, workbook, worksheet } = params
})

// Remove the event listener using `disposable.dispose()`
```

`CrosshairHighlightColorChanged` event will be triggered when the crosshair highlight color changes.

```typescript
const disposable = univerAPI.addEvent(univerAPI.Event.CrosshairHighlightColorChanged, (params) => {
  const { color, workbook, worksheet } = params
})

// Remove the event listener using `disposable.dispose()`
```