Подсказки
Документация и примеры добавления настраиваемых всплывающих подсказок Bootstrap с помощью CSS и JavaScript с использованием CSS3 для анимации и атрибутов данных для локального хранения заголовков.
Обзор
Что нужно знать при использовании плагина всплывающей подсказки:
- Всплывающие подсказки полагаются на стороннюю библиотеку Popper для позиционирования. Вы должны включить popper.min.js перед bootstrap.js или использовать
bootstrap.bundle.min.js
/bootstrap.bundle.js
который содержит Popper, чтобы всплывающие подсказки работали! - Если вы создаете наш JavaScript из исходного кода, для этого требуется
util.js
. - Всплывающие подсказки являются обязательными из соображений производительности, поэтому вы должны инициализировать их самостоятельно .
- Подсказки с заголовками нулевой длины никогда не отображаются.
- Укажите
container: 'body'
, чтобы избежать проблем с рендерингом в более сложных компонентах (таких как наши группы ввода, группы кнопок и т. д.). - Запуск всплывающих подсказок для скрытых элементов не будет работать.
- Подсказки для элементов
.disabled
илиdisabled
должны запускаться для элемента-оболочки. - При запуске из гиперссылок, которые охватывают несколько строк, всплывающие подсказки будут центрированы. Используйте
white-space: nowrap;
на вашем<a>
s, чтобы избежать такого поведения. - Всплывающие подсказки должны быть скрыты до того, как соответствующие им элементы будут удалены из модели DOM.
- Всплывающие подсказки могут запускаться благодаря элементу внутри теневого DOM.
prefers-reduced-motion
медиа-запроса. См.
раздел с ограниченным движением в нашей документации по специальным возможностям .
Получил все это? Отлично, давайте посмотрим, как они работают, на нескольких примерах.
Пример: включить всплывающие подсказки везде
Один из способов инициализировать все всплывающие подсказки на странице — выбрать их по их data-toggle
атрибуту:
$(function () {
$('[data-toggle="tooltip"]').tooltip()
})
Примеры
Наведите указатель мыши на ссылки ниже, чтобы увидеть всплывающие подсказки:
Текст-заполнитель для демонстрации некоторых встроенных ссылок с подсказками. Теперь это просто наполнитель, а не убийца. Контент размещен здесь только для того, чтобы имитировать наличие реального текста . И все это только для того, чтобы дать вам представление о том, как будут выглядеть всплывающие подсказки при использовании в реальных ситуациях. Итак, надеюсь, теперь вы увидели, как эти всплывающие подсказки для ссылок могут работать на практике, как только вы используете их на своем собственном сайте или в проекте.
Наведите указатель мыши на кнопки ниже, чтобы увидеть четыре направления всплывающих подсказок: сверху, справа, снизу и слева.
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="top" title="Tooltip on top">
Tooltip on top
</button>
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="right" title="Tooltip on right">
Tooltip on right
</button>
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="bottom" title="Tooltip on bottom">
Tooltip on bottom
</button>
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="left" title="Tooltip on left">
Tooltip on left
</button>
И с добавлением пользовательского HTML:
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-html="true" title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
Tooltip with HTML
</button>
Применение
Плагин всплывающих подсказок генерирует контент и разметку по запросу и по умолчанию размещает всплывающие подсказки после их триггерного элемента.
Запустите всплывающую подсказку через JavaScript:
$('#example').tooltip(options)
Переполнение auto
иscroll
Позиция всплывающей подсказки пытается автоматически измениться, когда родительский контейнер имеет overflow: auto
или overflow: scroll
похож на наш .table-responsive
, но по-прежнему сохраняет исходное положение размещения. Чтобы решить эту проблему, установите для boundary
параметра значение, отличное от значения по умолчанию 'scrollParent'
, например 'window'
:
$('#example').tooltip({ boundary: 'window' })
Разметка
Необходимая разметка для всплывающей подсказки — это только data
атрибут и title
элемент HTML, в котором вы хотите иметь всплывающую подсказку. Сгенерированная разметка всплывающей подсказки довольно проста, хотя для нее требуется позиция (по умолчанию, установленная top
плагином).
Заставить всплывающие подсказки работать с клавиатурой и пользователями вспомогательных технологий
Вы должны добавлять всплывающие подсказки только к элементам HTML, которые традиционно активны с помощью клавиатуры и являются интерактивными (например, ссылки или элементы управления формы). Хотя произвольные элементы HTML (такие как <span>
s) можно сделать фокусируемыми, добавив tabindex="0"
атрибут, это добавит потенциально раздражающие и запутанные табуляции для неинтерактивных элементов для пользователей клавиатуры, и большинство вспомогательных технологий в настоящее время не объявляют всплывающую подсказку в этой ситуации. Кроме того, не полагайтесь исключительно на hover
триггер всплывающей подсказки, так как это сделает ваши всплывающие подсказки невозможными для пользователей клавиатуры.
<!-- HTML to write -->
<a href="#" data-toggle="tooltip" title="Some tooltip text!">Hover over me</a>
<!-- Generated markup by the plugin -->
<div class="tooltip bs-tooltip-top" role="tooltip">
<div class="arrow"></div>
<div class="tooltip-inner">
Some tooltip text!
</div>
</div>
Отключенные элементы
Элементы с этим disabled
атрибутом не являются интерактивными, то есть пользователи не могут сфокусироваться, навести курсор или щелкнуть их, чтобы вызвать всплывающую подсказку (или всплывающее окно). В качестве обходного пути вы захотите вызвать всплывающую подсказку из оболочки <div>
или <span>
, в идеале сделать ее фокусируемой на клавиатуре с помощью tabindex="0"
, и переопределить pointer-events
отключенный элемент.
<span class="d-inline-block" tabindex="0" data-toggle="tooltip" title="Disabled tooltip">
<button class="btn btn-primary" style="pointer-events: none;" type="button" disabled>Disabled button</button>
</span>
Опции
Параметры можно передавать через атрибуты данных или JavaScript. Для атрибутов данных добавьте имя опции к data-
, как в data-animation=""
.
sanitize
,
sanitizeFn
и
whiteList
не могут быть предоставлены с использованием атрибутов данных.
Имя | Тип | По умолчанию | Описание |
---|---|---|---|
анимация | логический | истинный | Применить CSS-переход затухания к всплывающей подсказке |
контейнер | строка | элемент | ЛОЖЬ | ЛОЖЬ | Добавляет всплывающую подсказку к определенному элементу. Пример: |
задерживать | номер | объект | 0 | Задержка отображения и скрытия всплывающей подсказки (мс) — не относится к ручному типу триггера. Если указано число, задержка применяется как к скрытию, так и к показу. Структура объекта: |
HTML | логический | ЛОЖЬ | Разрешить HTML в подсказке. Если задано значение true, теги HTML во всплывающей подсказке Используйте текст, если вы беспокоитесь о XSS-атаках. |
размещение | строка | функция | 'Топ' | Как расположить всплывающую подсказку - авто | топ | дно | слева | Правильно. Когда функция используется для определения размещения, она вызывается с узлом DOM всплывающей подсказки в качестве первого аргумента и узлом DOM триггерного элемента в качестве второго. Контекст |
селектор | строка | ЛОЖЬ | ЛОЖЬ | Если предоставлен селектор, объекты всплывающей подсказки будут делегированы указанным целям. На практике это также используется для применения всплывающих подсказок к динамически добавляемым элементам DOM ( jQuery.on поддержка). См. это и информативный пример . |
шаблон | нить | '<div class="tooltip" role="tooltip"><div class="arrow"></div><div class="tooltip-inner"></div></div>' |
Базовый HTML для использования при создании всплывающей подсказки. Всплывающая подсказка
Самый внешний элемент-оболочка должен иметь |
заглавие | строка | элемент | функция | '' | Значение заголовка по умолчанию, если Если задана функция, она будет вызываться со |
курок | нить | «наведение фокуса» | Как срабатывает всплывающая подсказка - нажмите | парить | фокус | руководство. Вы можете передать несколько триггеров; разделяйте их пробелом.
|
компенсировать | номер | строка | функция | 0 | Смещение всплывающей подсказки относительно ее цели. Когда функция используется для определения смещения, она вызывается с объектом, содержащим данные смещения в качестве первого аргумента. Функция должна возвращать объект с той же структурой. Узел триггерного элемента DOM передается в качестве второго аргумента. Для получения дополнительной информации обратитесь к документации по смещению Поппера . |
резервное размещение | строка | множество | 'кувырок' | Позволяет указать, какую позицию Поппер будет использовать при откате. Для получения дополнительной информации обратитесь к документам поведения Поппера. |
пользовательский класс | строка | функция | '' | Добавляйте классы во всплывающую подсказку, когда она отображается. Обратите внимание, что эти классы будут добавлены в дополнение к любым классам, указанным в шаблоне. Чтобы добавить несколько классов, разделите их пробелами: Вы также можете передать функцию, которая должна возвращать одну строку, содержащую дополнительные имена классов. |
граница | строка | элемент | 'scrollParent' | Граница ограничения переполнения всплывающей подсказки. Принимает значения 'viewport' , 'window' , 'scrollParent' или ссылку HTMLElement (только для JavaScript). Для получения дополнительной информации обратитесь к документации по предотвращению переполнения Поппера . |
дезинфицировать | логический | истинный | Включите или отключите очистку. Если активировано , 'template' и 'title' параметры будут очищены. См. раздел дезинфицирующих средств в нашей документации по JavaScript . |
белый список | объект | Значение по умолчанию | Объект, который содержит разрешенные атрибуты и теги |
дезинфицироватьFn | ноль | функция | нулевой | Здесь вы можете указать свою собственную функцию дезинфекции. Это может быть полезно, если вы предпочитаете использовать выделенную библиотеку для выполнения очистки. |
попперконфиг | ноль | объект | нулевой | Чтобы изменить конфигурацию Popper по умолчанию в Bootstrap, см. раздел Конфигурация Popper. |
Атрибуты данных для отдельных всплывающих подсказок
В качестве альтернативы параметры для отдельных всплывающих подсказок можно указать с помощью атрибутов данных, как описано выше.
Методы
Асинхронные методы и переходы
Все методы API являются асинхронными и запускают переход . Они возвращаются к вызывающей стороне сразу после начала перехода, но до его завершения . Кроме того, вызов метода переходного компонента будет игнорироваться .
Дополнительную информацию см. в нашей документации по JavaScript .
$().tooltip(options)
Присоединяет обработчик всплывающей подсказки к коллекции элементов.
.tooltip('show')
Отображает всплывающую подсказку элемента. Возвращает вызывающему объекту до того, как всплывающая подсказка действительно будет показана (т. е. до того , как shown.bs.tooltip
произойдет событие). Это считается «ручным» срабатыванием всплывающей подсказки. Подсказки с заголовками нулевой длины никогда не отображаются.
$('#element').tooltip('show')
.tooltip('hide')
Скрывает всплывающую подсказку элемента. Возвращает вызывающему объекту до того, как всплывающая подсказка будет фактически скрыта (т. е. до того , как hidden.bs.tooltip
произойдет событие). Это считается «ручным» срабатыванием всплывающей подсказки.
$('#element').tooltip('hide')
.tooltip('toggle')
Переключает всплывающую подсказку элемента. Возвращает вызывающему объекту до того, как всплывающая подсказка действительно была показана или скрыта (т. е. до того, как произошло событие shown.bs.tooltip
или ). hidden.bs.tooltip
Это считается «ручным» срабатыванием всплывающей подсказки.
$('#element').tooltip('toggle')
.tooltip('dispose')
Скрывает и уничтожает всплывающую подсказку элемента. Всплывающие подсказки, использующие делегирование (создаваемые с помощью параметра selector
) , не могут быть уничтожены по отдельности в дочерних элементах триггера.
$('#element').tooltip('dispose')
.tooltip('enable')
Позволяет отображать всплывающую подсказку элемента. Подсказки включены по умолчанию.
$('#element').tooltip('enable')
.tooltip('disable')
Удаляет возможность отображения всплывающей подсказки элемента. Всплывающая подсказка будет отображаться только в том случае, если она снова включена.
$('#element').tooltip('disable')
.tooltip('toggleEnabled')
Переключает возможность отображения или скрытия всплывающей подсказки элемента.
$('#element').tooltip('toggleEnabled')
.tooltip('update')
Обновляет положение всплывающей подсказки элемента.
$('#element').tooltip('update')
События
Тип события | Описание |
---|---|
show.bs.tooltip | Это событие срабатывает сразу же при show вызове метода экземпляра. |
показанная.bs.подсказка | Это событие запускается, когда всплывающая подсказка становится видимой для пользователя (будет ожидать завершения переходов CSS). |
hide.bs.подсказка | Это событие запускается сразу после hide вызова метода экземпляра. |
скрытая.bs.подсказка | Это событие запускается, когда всплывающая подсказка перестает быть скрытой от пользователя (будет ждать завершения переходов CSS). |
вставленная.bs.подсказка | Это событие запускается после show.bs.tooltip события, когда шаблон всплывающей подсказки был добавлен в DOM. |
$('#myTooltip').on('hidden.bs.tooltip', function () {
// do something...
})