Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@remirror/extension-positioner

remirror184.3kMIT3.0.1TypeScript support: included

Reposition your elements with every state update.

remirror, extension, positioning, text-editor

readme

@remirror/extension-positioner

Reposition your elements with every state update.

Version Weekly Downloads Bundled size Typed Codebase MIT License

Installation

# yarn
yarn add @remirror/extension-positioner

# pnpm
pnpm add @remirror/extension-positioner

# npm
npm install @remirror/extension-positioner

This is included by default when you install the recommended remirror package. All exports are also available via the entry-point, remirror/extensions.

Usage

An extension for tracking the position of the provided element relative to the prosemirror editor. Can be used to find the top / left position in order to position the element as a hover menu.

import { PositionerExtension } from 'remirror/extensions';

const extension = new PositionerExtension();

const dispose = extension.addCustomHandler({
  positioner: 'bubble',
  element,
  onChange: ({ isActive, top, left }) => {
    // do something
  },
});

// Later in the app
dispose(); // Remove the positioner.