ФреймворкJavaScript

Tooltip API: подсказки для ваших инструментов

Отображение всплывающих подсказок на элементах интерфейса.

Как получить экземпляр редактора

Методы ниже вызываются на редакторе, созданном через new Blok(). Они доступны после того, как разрешится editor.isReady.

TypeScript

// You already hold the instance returned by the constructor.
const editor = new Blok({ holder: 'editor' });
await editor.isReady;

// Call any API method on it.
editor.caret.setToLastBlock('end');

Методы

tooltip.show(element, content, options?)

void

Show a tooltip on the specified element.

Когда использовать

Императивно показывает подсказку для разовых случаев. Для наведения предпочитайте onHover(), который сам навешивает слушатели.

TypeScript

const button = document.querySelector('button');
editor.tooltip.show(button, 'Click to save', {
  placement: 'top',
  delay: 200 // timeout before showing
});

tooltip.hide()

void

Hide the currently visible tooltip.

Когда использовать

Скрывает текущую подсказку; безопасно вызывать, даже если ничего не показано.

TypeScript

editor.tooltip.hide();

tooltip.onHover(element, content, options?)

void

Show tooltip on hover using event listeners.

Когда использовать

Удобный вариант — подсказка, показываемая при наведении и скрываемая при уходе, без ручного управления слушателями.

TypeScript

const button = document.querySelector('button');
editor.tooltip.onHover(button, 'Click me', {
  placement: 'bottom'
});