내용으로 건너뛰기 문서 내비게이션으로 건너뛰기
GitHub에서 보기

Tooltips(툴팁)

CSS3 를 사용한 애니메이션이나 data-bs-attributes 를 사용한 CSS 와 JavaScript 로 커스텀 Bootstrap 의 툴팁을 추가하기 위한 문서와 예시입니다.

Overview

툴팁 플러그인을 사용할 때 알아두어야 할 점:

  • 툴팁의 배치는 Popper 에 의존하고 있습니다. bootstrap.js 앞에 popper.min.js 을 쓰거나, 툴팁을 동작시키기 위해 팝오버를 포함한 bootstrap.bundle.min.js / bootstrap.bundle.js 를 사용해야 합니다.
  • 툴팁은 퍼포먼스를 위해 opt-in 되어 있기 때문에 스스로 초기화를 해야 합니다.
  • 길이가 0 의 타이틀을 가진 툴팁은 표시되지 않습니다.
  • 더 복잡한 컴포넌트(input group, button groups 등)의 랜더링 문제를 피하기 위해 container: 'body' 를 지정해 주십시오.
  • 숨겨진 요소에서 툴팁을 트리거해도 제 기능을 하지 않습니다.
  • .disableddisabled 요소의 툴팁은 그 위(바깥) 요소에서 트리거해야 합니다.
  • 여러 라인에 걸쳐 있는 하이퍼링크에서 트리거된 툴팁은 중앙에 배치됩니다. 이 동작을 피하기 위해서는 <a>white-space: nowrap; 을 사용해 주십시오.
  • 툴팁은 대응 요소가 DOM 에서 삭제되기 전에 숨겨야 합니다.
  • 툴팁은 shadow DOM 내의 요소 덕분에 트리거할 수 있습니다.
The animation effect of this component is dependent on the prefers-reduced-motion media query. See the reduced motion section of our accessibility documentation.

몇 가지 예를 들어보겠습니다.

Example: Enable tooltips everywhere

페이지 상의 모든 툴팁을 초기화 하는 방법 중 하나는 data-bs-toggle 속성으로 선택하는 것입니다:

var tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]'))
var tooltipList = tooltipTriggerList.map(function (tooltipTriggerEl) {
  return new bootstrap.Tooltip(tooltipTriggerEl)
})

Examples

아래 링크에 커서를 맞추면 툴팁이 나타납니다:

Tight pants next level keffiyeh you probably haven't heard of them. Photo booth beard raw denim letterpress vegan messenger bag stumptown. Farm-to-table seitan, mcsweeney's fixie sustainable quinoa 8-bit american apparel have a terry richardson vinyl chambray. Beard stumptown, cardigans banh mi lomo thundercats. Tofu biodiesel williamsburg marfa, four loko mcsweeney's cleanse vegan chambray. A really ironic artisan whatever keytar, scenester farm-to-table banksy Austin twitter handle freegan cred raw denim single-origin coffee viral.

아래 버튼에 커서를 맞추면 top, right, bottom, left의 4개 툴팁이 나타납니다: RTL 에서 Bootstrap 를 사용하는 경우 방향은 반대가 됩니다.

<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="top" title="Tooltip on top">
  Tooltip on top
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="right" title="Tooltip on right">
  Tooltip on right
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Tooltip on bottom">
  Tooltip on bottom
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="left" title="Tooltip on left">
  Tooltip on left
</button>

그리고 커스텀 HTML 을 추가할 수 있습니다:

<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-html="true" title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
  Tooltip with HTML
</button>

SVG 와 함께:

Usage

툴팁 플러그인은 필요에 따라 컨텐츠와 마크업을 생성하고 기본 값으로는 트리거 요소 뒤에 툴팁을 배치합니다.

JavaScript 를 사용해 툴팁을 트리거 합니다:

var exampleEl = document.getElementById('example')
var tooltip = new bootstrap.Tooltip(exampleEl, options)
Overflow auto and scroll

툴팁의 위치는 부모 컨테이너에 .table-responsive 처럼 overflow: autooverflow: scroll 이 있는 경우 자동으로 변경되지만, 원래 배치 위치는 유지됩니다. 이를 해결하려면 boundary 옵션을 기본 값 'scrollParent' 이외의 값, 예를 들어 'window' 같은 것을 설정합니다:

var exampleEl = document.getElementById('example')
var tooltip = new bootstrap.Tooltip(exampleEl, {
  boundary: 'window'
})

Markup

툴팁에 필요한 마크업은 툴팁을 작성하고자 하는 HTML 요소의 data 속성과 title 뿐입니다. 툴팁 마크업은 단순하지만 위치를 지정해야 합니다 (플러그인에 의해 기본 top 이 설정되어 있습니다).

Making tooltips work for keyboard and assistive technology users

툴팁을 추가해야 하는 것은 키보드 포커스가 가능하고 인터랙티브한 HTML 요소(링크나 폼 컨트롤 등)뿐 입니다. 임의의 HTML 요소(<span> 등)는 tabindex="0" 속성을 추가하여 포커스 가능하게 할 수 있지만 이는 키보드 사용자에게는 비인터랙티브적인 요소의 탭 멈춤이 추가되어 버리기 때문에 키보드 사용자를 곤란하게 하거나 혼란스럽게 할 수 있으며 현재 대부분의 스크린 리더는 이러한 상황에서 툴팁을 제공하지 않습니다. 게다가 툴팁의 트리거로서 hover 에만 의지해서는 안됩니다. 이것은 키보드 사용자가 툴팁을 트리거 할 수 없게 되기 때문입니다.

<!-- HTML to write -->
<a href="#" data-bs-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="tooltip-arrow"></div>
  <div class="tooltip-inner">
    Some tooltip text!
  </div>
</div>

Disabled elements

Disabled 속성을 갖는 요소는 인터랙티브 하지 않습니다. 즉, 사용자가 포커스를 맞추거나 호버하거나 클릭하여 툴팁(혹은 팝오버)을 구동할 수 없습니다. 해결책으로는 <div><span> 으로 툴팁을 트리거하여, 이상적으로 tabindex="0" 으로 키보드 포커스 가능하게 하고, disabled 요소인 pointer-events 를 오버라이드 해야 합니다.

<span class="d-inline-block" tabindex="0" data-bs-toggle="tooltip" title="Disabled tooltip">
  <button class="btn btn-primary" style="pointer-events: none;" type="button" disabled>Disabled button</button>
</span>

Options

옵션은 data 속성 또는 JavaScript 로 줄 수 있습니다. data 속성의 경우는 data-bs-animation="" 처럼 data-bs- 에 옵션명을 추가합니다.

보안상의 이유로, sanitize, sanitizeFn, allowList 옵션을 data 속성으로 지정할 수 없다는 것에 주의해 주세요.
Name Type Default Description
animation boolean true 툴팁에 CSS fade 트렌지션을 적용합니다.
container string | element | false false

특정 요소에 툴팁을 추가합니다. 예를 들어: container: 'body'. 이 옵션은 문서 흐름 안에서 툴팁을 트리거 요소 근처에 배치할 수 있어 특히 편리합니다.

delay number | object 0

툴팁 표시/숨김 지연시간(ms) - 수동 트리거 타입에는 적용되지 않습니다.

수치를 지정한 경우는 숨김/표시 모두 지연이 적용됩니다.

Object 구조는: delay: { "show": 500, "hide": 100 }

html boolean false

툴팁내의 HTML 을 허용합니다.

true 의 경우, 툴팁의 title 에 있는 HTML 태그가 툴팁에 나타납니다. false 의 경우는, innerText 속성이 DOM 에 컨텐츠를 삽입하기 위해 사용됩니다.

XSS 공격이 걱정된다면 텍스트를 사용하세요.

placement string | function 'top'

툴팁 배치 방법 - auto | top | bottom | left | right.
auto 를 지정하면 동적으로 툴팁의 방향을 바꿉니다.

배치를 결정하기 위해 함수를 사용할 경우 툴팁 DOM 노드를 제 1인수로, 트리거 요소 DOM 노드를 제2인수로 하여 호출됩니다. this 콘텍스트에는 툴팁의 인스턴스가 설정됩니다.

selector string | false false 셀렉터가 제공되는 경우 툴팁 오브젝트는 지정된 타겟으로 이양됩니다. 실제로는 동적으로 추가된 DOM 요소에 툴팁을 적용하기 위해서도 사용됩니다.(jQuery.on 지원). thisan informative example 을 참조해 주세요.
template string '<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>'

툴팁을 작성할때 사용하는 기본.

툴팁의 title.tooltip-inner 로 주입됩니다.

.tooltip-arrow 가 툴팁의 화살표가 됩니다.

가장 바깥쪽 요소는 .tooltiprole="tooltip" 를 가지고 있어야 합니다.

title string | element | function ''

title 속성이 존재하지 않는 경우 기본 타이틀 값.

함수가 주어졌을 경우 그 this 참조가 툴팁이 첨부되어 있는 요소로 설정된 상태로 호출됩니다.

trigger string 'hover focus'

툴팁의 트리거 방법 - click | hover | focus | manual. 여러 트리거를 전달할 수 있습니다.

'manual'.tooltip('show'), .tooltip('hide') 그리고 .tooltip('toggle') 메소드를 통해 프로그램으로 트리거 되는 것을 나타냅니다. 이 값은 다른 트리거와 조합할 수 없습니다.

'hover' 를 단독으로 사용하면, 키보드를 통해 트리거 할 수 없는 툴팁이 되며, 키보드 사용자에게 동일한 정보를 전달하기 위한 대체수단이 존재할 경우에만 사용해야 합니다.

fallbackPlacement null | array null Fallback 시 팝오버가 어떤 위치를 사용하는지 지정할 수 있습니다. 자체한 것은 팝오버의 behavior docs 를 참조해 주세요.
boundary string | element 'clippingParents' 툴팁의 Overflow 제약경계. 기본 값은 'clippingParents' 로 HTMLElement 참조를 받을 수 있습니다.(JavaScript only). 자세한 것은 팝오버의 preventOverflow docs 를 참조해 주세요.
customClass string | function ''

툴팁이 표시될 때 클래스를 추가합니다. 이 클래스는 템플릿에서 지정뙨 클래스에 추가되어 추가되므로 주의해 주십시오. 여러 개의 클래스를 추가하려면 공백으로 구분해 주세요: 'class-1 class-2'

추가 클래스 이름을 포함한 단일 문자열을 반환하는 함수를 줄 수도 있습니다.

sanitize boolean true sanitization 을 유효화 하거나 무효화합니다. 유효로 했을 경우 'template''title' 옵션은 sanitize 됩니다.
allowList object Default value 허용된 속성과 태그를 포함하는 Object
sanitizeFn null | function null 여기세어는 독자적인 sanitize 함수를 지정할 수 있습니다. 이것은 sanitize 를 실행하기 위해 전용 라이브러리를 사용하고 싶은 경우에 편리합니다.
popperConfig null | object null Bootstrap 기본 팝오버의 설정을 변경하려면 Popper's configuration 를 참조해 주세요.

Data attributes for individual tooltips

개별 툴팁 옵션은 위에서 설명한 것처럼 data 속성을 사용해 지정할 수도 있습니다.

Methods

Asynchronous methods and transitions

All API methods are asynchronous and start a transition. They return to the caller as soon as the transition is started but before it ends. In addition, a method call on a transitioning component will be ignored.

See our JavaScript documentation for more information.

show

요소의 툴팁을 표시합니다. 툴팁이 실제로 나타나기 전에 호출한 곳으로 돌아갑니다 (즉, shown.bs.tooltip 이벤트가 발생하기 전). 이것은 툴팁의 “수동” 트리거로 간주합니다. 길이가 0 을 가진 타이틀은 절대 표시되지 않습니다.

tooltip.show()

hide

요소의 툴팁을 숨깁니다. 툴팁이 실제로 숨겨지기 전에 호출한 곳으로 돌아갑니다 (즉, hidden.bs.tooltip 이벤트가 발생하기 전). 이것은 툴팁의 “수동” 트리거로 간주됩니다.

tooltip.hide()

toggle

요소의 툴팁을 토글합니다. 툴팁이 실제로 표시되거나 숨겨지기 전에 호출한 곳으로 돌아갑니다 (즉, shown.bs.tooltip 혹은 hidden.bs.tooltip 이벤트가 발생하기 전). 이것은 툴팁의 “수동” 트리거로 간주됩니다.

tooltip.toggle()

dispose

요소의 툴팁을 숨기고 업앱니다(DOM 요소에 보존되어 있는 데이타를 삭제). 위임을 사용하는 툴팁(the selector option 을 사용하여 작성된 것)은 후손의 트리거 요소상에서 개별적으로 없앨수 없습니다.

tooltip.dispose()

enable

요소의 툴팁을 표시하는 기능을 부여합니다. 툴팁은 기본적으로 활성화되어 있습니다.

tooltip.enable()

disable

요소의 툴팁을 표시하는 기능을 삭제합니다. 툴팁은 재활성화 된 경우에만 표시합니다.

tooltip.disable()

toggleEnabled

요소의 툴팁 표시 및 숨김을 변경합니다.

tooltip.toggleEnabled()

update

요소의 툴팁 위치를 갱신합니다.

tooltip.update()

getInstance

DOM 요소와 연관된 툴팁의 인스턴스를 취득하는 Static 메소드

var exampleTriggerEl = document.getElementById('example')
var tooltip = bootstrap.Tooltip.getInstance(exampleTriggerEl) // Returns a Bootstrap tooltip instance

Events

Event type Description
show.bs.tooltip 이 이벤트는 show 인스턴스 메소드가 호출되었을 때 바로 발생합니다.
shown.bs.tooltip 이 이벤트는 툴팁이 사용자에게 보일 때 발생합니다(CSS 트렌지션이 완료되기를 기다립니다).
hide.bs.tooltip 이 이벤트는 hide 인스턴스 메소드가 호출되었을 때 바로 발생합니다.
hidden.bs.tooltip 이 이벤트는 툴팁이 사용자로부터 숨김 상태가 되었을 때 발생합니다.(CSS 트렌지션이 완료되기를 기다립니다).
inserted.bs.tooltip 이 이벤트는 show.bs.tooltip 이벤트 후 툴팁 템플릿이 DOM에 추가되었을 때 발생합니다.
var myTooltipEl = document.getElementById('myTooltip')
var tooltip = new bootstrap.Tooltip(myTooltipEl)

myTooltipEl.addEventListener('hidden.bs.tooltip', function () {
  // do something...
})

tooltip.hide()