remirror/remirror

View on GitHub
docs/extensions/positioner-extension.mdx

Summary

Maintainability
Test Coverage
---
hide_title: true
title: 'PositionerExtension'
---

import Basic from '../../website/extension-examples/extension-positioner/basic';

# `PositionerExtension`

## Summary

This is the positioner extension which is used to track the positions of different parts of your editor.

For example, you can track the cursor or all visible paragraph nodes.

:::note

Tip: See this [blog post](/blog/positioner-performance) if you encounter performance issues.

:::note

## Usage

### Installation

This extension is installed for you when you install the main `remirror` package.

You can use the imports in the following way:

```ts
import { PositionerExtension } from 'remirror/extensions';
```

The extension is provided by the `@remirror/extension-positioner` package.

### Examples

<Basic />

## API

- [PositionerExtension](../api/extension-positioner)