GitHub에서 보기

팝오버

// Popovers

iOS에서 볼수 있는 Bootstrap 팝오버를 사이트 임의의 요소에 추가하기 위한 문서와 예시입니다.

개요

팝오버 플러그인을 사용할 때 알아두어야 할 점:

팝오버는 Popper에 의존하고 있습니다. 팝오버를 동작시키기 위해서는 bootstrap.js 앞에 popper.min.js를 쓰거나 Popper를 포함한 bootstrap.bundle.min.js / bootstrap.bundle.js를 사용해야 합니다.
팝오버는, 의존관계로 tooltip plugin이 필요합니다.
팝오버는 퍼포먼스를 위해 opt-in 되어 있기 때문에, 스스로 초기화를 해야 합니다.
길이가 0인 title 과 content 값은 팝오버를 표시하지 않습니다.
더 복잡한 컴포넌트(input group, button groups 등)의 렌더링 문제를 피하기 위해 container: 'body'를 지정해 주십시오.
숨겨진 요소에서 팝오버를 트리거 해도 작동하지 않습니다.
.disabled 또는 disabled 요소의 팝오버는 그 위(바깥) 요소에서 트리거 해야 합니다.
여러 라인에 걸쳐 있는 앵커로부터 트리거 된 경우, 팝오버는 앵커의 전체 폭을 중심으로 표시됩니다. 이 동작을 피하기 위해서는 <a>에 .text-nowrap을 사용해 주십시오.
팝오버는 대응 요소가 DOM에서 삭제되기 전에 숨겨야 합니다.
팝오버는 shadow DOM 내의 요소 덕분에 트리거 할 수 있습니다.

이 컴포는트는 기본적으로 명시적으로 허용되지 않는 HTML 요소를 제거하는 내장 콘텐츠 새니타이저를 사용합니다. 자세한 내용은 자바스크립트 문서의 Sanitizer 문단을 참고하세요.

이 컴포넌트의 애니메이션 효과는 prefers-reduced-motion 미디어 쿼리에 따라 다릅니다. 접근성 문서의 모션 감소 문단을 참고하세요.

팝오버가 어떤 기능을 하는지 몇 가지 예를 들어 보겠습니다.

예시: 모든 곳에서 팝오버 활성화

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

var popoverTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="popover"]'))
var popoverList = popoverTriggerList.map(function (popoverTriggerEl) {
  return new bootstrap.Popover(popoverTriggerEl)
})

예시: `container` 옵션 사용하기

부모 요소에 팝오버를 방해하는 몇 가지 스타일이 있다면, 대신 사용자 정의 container를 지정하여 팝오버의 HTML을 해당 요소 내에 표시되도록 합니다.

var popover = new bootstrap.Popover(document.querySelector('.example-popover'), {
  container: 'body'
})

예시

<button type="button" class="btn btn-lg btn-danger" data-bs-toggle="popover" title="Popover title" data-bs-content="And here's some amazing content. It's very engaging. Right?">Click to toggle popover</button>

사방위

4가지 옵션이 있습니다: top, right, bottom, left. RTL에서 Bootstrap을 사용하는 경우 방향은 반대가 됩니다.

<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="top" data-bs-content="Top popover">
  Popover on top
</button>
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="right" data-bs-content="Right popover">
  Popover on right
</button>
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="bottom" data-bs-content="Bottom popover">
  Popover on bottom
</button>
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="left" data-bs-content="Left popover">
  Popover on left
</button>

다음 클릭으로 닫기

사용자가 다음 토글 요소 이외의 요소를 클릭했을 때 팝오버를 닫으려면 focus 트리거를 사용합니다.

다음 클릭으로 닫기를 사용하기 위해서는 특정한 마크업이 필요

브라우저나 플랫폼에 관계없이 제대로 동작하기 위해서는 <button> 태그가 아닌 <a> 태그를 사용해야 하며 tabindex 속성을 포함해야 합니다.

Dismissible popover

<a tabindex="0" class="btn btn-lg btn-danger" role="button" data-bs-toggle="popover" data-bs-trigger="focus" title="Dismissible popover" data-bs-content="And here's some amazing content. It's very engaging. Right?">Dismissible popover</a>

var popover = new bootstrap.Popover(document.querySelector('.popover-dismiss'), {
  trigger: 'focus'
})

비활성화 요소

disabled 속성을 갖는 요소는 인터랙티브하지 않습니다. 즉, 사용자가 팝오버(또는 툴팁)를 일으키기 위해서 호버하거나 클릭할 수 없습니다. 차선책으로 감싼 <div> 및 <span>에서 팝오버를 트리거 되길 원하지만, tabindex="0"을 사용해 키보드 포커스가 가능하도록 이상적으로 만듭니다.

무효화된 팝오버를 트리거 하기 위해서는 data-bs-trigger="hover focus"라고 하면 사용자는 무효가 된 요소를 click 할 것을 기대하지 않기 때문에 팝오버가 바로 시각적으로 표시되게 됩니다.

<span class="d-inline-block" tabindex="0" data-bs-toggle="popover" data-bs-trigger="hover focus" data-bs-content="Disabled popover">
  <button class="btn btn-primary" type="button" disabled>Disabled button</button>
</span>

Sass

변수

$popover-font-size:                 $font-size-sm;
$popover-bg:                        $white;
$popover-max-width:                 276px;
$popover-border-width:              $border-width;
$popover-border-color:              rgba($black, .2);
$popover-border-radius:             $border-radius-lg;
$popover-inner-border-radius:       subtract($popover-border-radius, $popover-border-width);
$popover-box-shadow:                $box-shadow;

$popover-header-bg:                 shade-color($popover-bg, 6%);
$popover-header-color:              $headings-color;
$popover-header-padding-y:          .5rem;
$popover-header-padding-x:          $spacer;

$popover-body-color:                $body-color;
$popover-body-padding-y:            $spacer;
$popover-body-padding-x:            $spacer;

$popover-arrow-width:               1rem;
$popover-arrow-height:              .5rem;
$popover-arrow-color:               $popover-bg;

$popover-arrow-outer-color:         fade-in($popover-border-color, .05);

사용 방법

JavaScript로 팝오버를 유효화 합니다:

var exampleEl = document.getElementById('example')
var popover = new bootstrap.Popover(exampleEl, options)

키보드 및 보조 기술 사용자들을 위해 팝오버 만들기

키보드 사용자가 팝오버를 활성화하려면, 키보드 포커스가 가능하며 상호작용이 가능한 HTML 요소(링크나 폼 컨트톨 등)에만 추가해야 합니다. 임의의 HTML 요소(<span> 등)는 tabindex="0" 속성을 추가함으로써 포커스가 가능한데, 이는 키보드 사용자에게는 상호작용할 수 없는 요소에 탭 멈춤이 추가되어 혼란을 초래할 수 있습니다. 게다가 키보드 사용자가 팝오버를 트리거 할 수 없게 되므로 팝오버의 트리거를 hover에만 의지해서는 안됩니다.

html 옵션에서 리치로 구조화된 HTML을 팝오버에 넣을 수 있지만 과도한 양의 콘텐츠를 추가하는 것은 피하는 것이 좋습니다. 팝오버가 현재 기능을 하는 방법은 한 번 표시되면 해당 콘텐츠는 aria-describedby 속성을 갖는 트리거 요소에 연결됩니다. 그 결과 팝오버 콘텐츠 전체가 스크린 리더 사용자에게 길고 끊기지 않는 스트림으로 알릴 것입니다.

또한, 인터랙티브한 컨트롤(폼 요소나 링크 등)들을 팝오버에 포함할 수도 있지만 (허락된 속성이나 태그의 allowList에 이러한 요소를 추가하여), 현재 팝오버는 키보드 포커스 순서를 관리하지 않는다는 점에 유의하십시오. 키보드 사용자가 팝오버를 열면 포커스는 트리거가 되는 요소에 머무르고, 팝오버는 보통 문서 구조의 트리거를 쉽게 따라가지 않기 때문에 TAB 을 앞으로 이동/눌러도 키보드 사용자가 팝오버 자체로 이동하라는 보장은 없습니다. 요컨대 단순히 팝오버에 상호작용할 수 있는 컨트롤을 추가하는 것만으로도 키보드 사용자나 스크린 리더 사용자들이 이들 컨트롤에 접근할 수 없거나 적어도 전체적으로 비논리적인 포커스 순서가 될 수 있습니다. 이러한 경우는, modal(모달) 사용을 검토해 주십시오.

옵션

옵션은 data 속성이나 JavaScript로 전달할 수 있습니다. data 속성의 경우는, data-bs-animation=""과 같이 data-bs-에 옵션명을 추가합니다. data 속성으로 옵션을 전달하려면 옵션명의 대문자와 소텍스트를 캐멀케이스(camelCase)에서 케밥케이스(kebab-case)로 변경해 주세요. 예를 들어 data-bs-customClass="beautifier"가 아니라 data-bs-custom-class="beautifier"로 해야 합니다.

보안상의 이유로 sanitize, sanitizeFn, allowList 옵션을 data 속성으로 지정할 수 없다는 것에 주의해 주세요.

Name	Type	Default	Description
`animation`	boolean	`true`	팝오버에 CSS fade 트랜지션을 적용합니다.
`container`	string \| element \| false	`false`	팝오버를 특정 요소에 추가합니다. 예를 들어, `container: 'body'`. 이 옵션은 문서 흐름 중에서 팝오버를 트리거 요소 근처에 배치할 수 있어 특히 편리합니다.
`content`	string \| element \| function	`''`	`data-bs-content` 속성이 존재하지 않는 경우의 기본 콘텐츠 값. 함수가 주어졌을 경우, 그 `this` 참조가 팝오버가 어태치 되어 있는 요소로 설정된 상태로 호출됩니다.
`delay`	number \| object	`0`	팝오버 표시 및 숨김 지연(ms) - 수동 트리커 타입에는 적용되지 않습니다. 수치가 부여된 경우 숨김/표시의 양쪽에 지연이 적용됩니다. 객체 구조: `delay: { "show": 500, "hide": 100 }`
`html`	boolean	`false`	팝오버에 HTML 을 삽입합니다. false 의 경우 `innerText` 속성을 사용하여 DOM 에 콘텐츠를 삽입합니다. XSS 공격이 걱정될 경우 텍스트를 사용합니다.
`placement`	string \| function	`'right'`	팝오버의 배치 방법 - auto \| top \| bottom \| left \| right. `auto` 를 지정하면 동적으로 팝오버 배치를 변경합니다. 배치를 변경하기 위해 함수를 사용하는 경우, 팝오버 DOM 노드를 첫번째 인수로, triggering element DOM 노드를 두번째 인수로 호출됩니다.`this` 컨텍스트는 팝오버의 인스턴스로 설정되어 있습니다.
`selector`	string \| false	`false`	셀렉터가 제공되는 경우 팝오버 객체는 지정된 타깃으로 이양됩니다. 실제로 이는 동적인 HTML 콘텐츠에 팝오버를 추가할 수 있도록 하기 위해 사용됩니다. 자세한 내용은 this 과 an informative example 을 참조해 주세요.
`template`	string	`'<div class="popover" role="tooltip"><div class="popover-arrow"></div><h3 class="popover-header"></h3><div class="popover-body"></div></div>'`	팝오버를 작성할때 사용하는 기본 HTML. 팝오버의 `title` 은 `.popover-header` 에 주입됩니다. 팝오버의 `content` 는 `.popover-body` 에 주입됩니다. `.popover-arrow` 가 팝오버의 화살표가 됩니다. 가장 밖에 있는 요소는 `.popover` 클래스를 가지고 있어야 합니다.
`title`	string \| element \| function	`''`	`title` 속성이 존재하지 않는 경우의 기본 타이틀 값. 함수가 주어졌을 경우, 그 `this` 참조가 팝오버가 어태치 되어 있는 요소로 설정뙨 상태로 호출됩니다.
`trigger`	string	`'click'`	팝오버 트리거 방법 - click \| hover \| focus \| manual. 복수의 트리거를 건내줄 수 있습니다; `manual` 은 다른 트리거와 조합할수 없습니다.
`fallbackPlacements`	array	`['top', 'right', 'bottom', 'left']`	폴백 배치를 배열로 지정하여 우선수위가 높은 순으로 배치를 결정할 수 있습니다. 자세한 내용은 behavior docs를 참조해 주세요
`boundary`	string \| element	`'clippingParents'`	팝오버의 오버플로 제약 경계(Popper의 preventOverflow 제어자에만 적용). 기본적으로 `'clippingParents'`로 HTMLElement의 참조를 받을 수 있습니다.(JavaScript만). 자세한 정보는 Popper의 detectOverflow docs를 참조해 주세요.
`customClass`	string \| function	`''`	팝오버가 표시되었을 때 클래스를 추가합니다. 이 클래스는 탬플릿에서 지정된 클래스에 추가되어 추가되므로 주의해 주십시오. 여러 개의 클래스를 추가하려면 공백으로 구분하세요: `'class-1 class-2'` 또한 추가 클래스 이름을 포함한 단일 문자열을 반환하는 함수를 줄 수도 있습니다.
`sanitize`	boolean	`true`	sanitize를 유효 혹은 무효화 합니다. 유효화 하면 `'template'`, `'content'`와 `'title'`의 각 옵션이 sanitize 됩니다. 자세한 정보는 sanitizer section in our JavaScript documentation을 참조해 주세요.
`allowList`	object	Default value	허용된 속성과 태그를 포함하는 객체
`sanitizeFn`	null \| function	`null`	여기에서는 독자적인 sanitize 함수를 지정할 수 있습니다. 이것은 sanitization 를 실행하기 위해 전용 라이브러리를 사용하고 싶은 경우에 편리합니다.
`offset`	array \| string \| function	`[0, 8]`	타깃에 대한 팝오버의 상대적인 오프셋. data 속성에는 `data-bs-offset="10,20"`와 같이 콤마 구분으로 문자열을 건내줄 수 있습니다. 오프셋을 결정하기 위해 함수가 사용되는 경우는 Popper의 배치, 참조, Popper의 직사각형을 포함한 객체를 첫번째 인수로 호출합니다. 트리거 되는 요소의 DOM 노드가 두번째 인수로 전달됩니다. 이 함수는 두 값을 갖는 배열 `[skidding, distance]`을 반환해야 합니다. 보다 자세한 정보는 Popper의 offset docs를 참조해 주세요.
`popperConfig`	null \| object \| function	`null`	Bootstrap의 기본 Popper 설정을 변경하려면 Popper's configuration을 참조해 주세요. Popper 구성을 만들기 위해 함수가 사용될 때 Bootstrap 기본 Popper 구성을 포함한 객체로 호출됩니다. 그것은 당신이 기본을 사용하고, 당신의 구성과 통합하는것을 도와줍니다. 함수는 Popper의 구성 객체를 반환해야 합니다.

독립 팝오버를 위한 데이터 속성

위에서 설명했듯이 각각의 팝오버 data 옵션은 data 속성을 사용하여 지정할 수도 있습니다.

`popperConfig`으로 기능 사용하기

var popover = new bootstrap.Popover(element, {
  popperConfig: function (defaultBsPopperConfig) {
    // var newPopperConfig = {...}
    // use defaultBsPopperConfig if needed...
    // return newPopperConfig
  }
})

메소드

비동기 메서드 및 트렌지션

모든 API 메서드는 비동기이며 트렌지션을 시작합니다. 트렌지션은 시작되자마자 끝나기 전에 호출자에게 돌아갑니다. 또한 트렌지션 컴포넌트에 대한 메서드 호출은 무시됩니다.

자세한 내용은 JavaScript 문서를 참고하세요.

show

요소의 팝오버를 표시합니다. 팝오버가 실제로 나타나기 전에 호출된 곳으로 돌아갑니다. (즉, shown.bs.popover 이벤트가 발생하기 전). 이것은 팝오버의 “manual” 트리거로 간주합니다. 타이틀과 콘텐츠의 양쪽 모두의 길이가 0인 팝오버는 결코 표시되지 않습니다.

myPopover.show()

hide

요소의 팝오버를 숨깁니다. 팝오버가 실제로 숨겨지기 전에 호출한 곳으로 돌아갑니다 (즉, hidden.bs.popover 이벤트 발생 전). 이것은 팝오버의 “manual” 트리거로 간주합니다.

myPopover.hide()

toggle

요소의 팝오버를 토글합니다. 팝오버가 실제로 표시 또는 숨기기 전에 호출된 곳으로 돌아갑니다 (즉, shown.bs.popover 혹은 hidden.bs.popover 이벤트가 발생하기 전). 이것은 팝오버의 “manual” 트리거로 간주합니다.

myPopover.toggle()

dispose

요소의 팝오버를 숨기고 없앱니다 (DOM 요소에 저장된 데이터를 삭제합니다). 위임을 사용하는 팝오버(the selector option를 사용하여 작성된 것) 는 자식의 트리거 요소로 인해 개벌적으로 없앨 수 없습니다.

myPopover.dispose()

enable

요소의 팝오버를 표시하는 기능을 부여합니다. 팝오버는 기본으로 활성화되어 있습니다.

myPopover.enable()

disable

요소의 팝오버를 표시하는 기능을 삭제합니다. 팝오버는 다시 활성화 된 경우에만 표시됩니다.

myPopover.disable()

toggleEnabled

요소의 팝오버를 표시/숨김을 바꿉니다.

myPopover.toggleEnabled()

update

요소의 팝오버 위치를 새로고칩니다.

myPopover.update()

getInstance

DOM 요소와 연관된 팝오버 인스턴스를 가져올 수 있게 하는 Static 메소드

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

getOrCreateInstance

Static method which allows you to get the popover instance associated with a DOM element, or create a new one in case it wasn’t initialised

var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getOrCreateInstance(exampleTriggerEl) // Returns a Bootstrap popover instance

이벤트

Event type	Description
show.bs.popover	이 이벤트는 `show` 인스턴스 메소드가 호출되었을 때 바로 발생합니다.
shown.bs.popover	이 이벤트는 팝오버가 사용자에게 보여질 때 바로 발생합니다 (CSS 트랜지션이 완료되기를 기다립니다).
hide.bs.popover	이 이벤트는 `hide` 인스턴스 메소드가 호출되었을 때 바로 발생합니다.
hidden.bs.popover	이 이벤트는 팝오버의 숨김이 완료될 때 발생합니다 (CSS 트랜지션이 완료되기를 기다립니다).
inserted.bs.popover	이 이벤트는 `show.bs.popover` 이벤트 후에, 팝오버의 템플렛이 DOM 에 추가될 때 발생합니다.

var myPopoverTrigger = document.getElementById('myPopover')
myPopoverTrigger.addEventListener('hidden.bs.popover', function () {
  // do something...
})

팝오버