Popovers
Tài liệu và ví dụ để thêm các cửa sổ bật lên Bootstrap, như các cửa sổ bật lên được tìm thấy trong iOS, vào bất kỳ phần tử nào trên trang web của bạn.
Tổng quan
Những điều cần biết khi sử dụng plugin popover:
- Popover dựa vào Popper thư viện của bên thứ 3 để định vị. Bạn phải bao gồm popper.min.js trước bootstrap.js hoặc sử dụng
bootstrap.bundle.min.js
/bootstrap.bundle.js
có chứa Popper để popover hoạt động! - Các cửa sổ bật lên yêu cầu plugin chú giải công cụ như một phần phụ thuộc.
- Cửa sổ bật lên được chọn tham gia vì lý do hiệu suất, vì vậy bạn phải tự khởi tạo chúng .
- Độ dài bằng 0
title
vàcontent
các giá trị sẽ không bao giờ hiển thị cửa sổ bật lên. - Chỉ định
container: 'body'
để tránh các sự cố hiển thị trong các thành phần phức tạp hơn (như nhóm đầu vào, nhóm nút của chúng tôi, v.v.). - Kích hoạt cửa sổ bật lên trên các phần tử ẩn sẽ không hoạt động.
- Cửa sổ bật lên cho
.disabled
hoặcdisabled
các phần tử phải được kích hoạt trên một phần tử trình bao bọc. - Khi được kích hoạt từ các neo bao quanh nhiều dòng, các cửa sổ bật lên sẽ được căn giữa giữa chiều rộng tổng thể của các neo. Sử dụng
.text-nowrap
trên<a>
s của bạn để tránh hành vi này. - Các cửa sổ bật lên phải được ẩn trước khi các phần tử tương ứng của chúng bị xóa khỏi DOM.
- Popover có thể được kích hoạt nhờ vào một phần tử bên trong Shadow DOM.
prefers-reduced-motion
truy vấn phương tiện. Xem phần
chuyển động giảm trong tài liệu hỗ trợ tiếp cận của chúng tôi .
Hãy tiếp tục đọc để biết cách hoạt động của các cửa sổ bật lên với một số ví dụ.
Ví dụ: Bật cửa sổ bật lên ở mọi nơi
Một cách để khởi tạo tất cả các cửa sổ bật lên trên một trang là chọn chúng theo data-bs-toggle
thuộc tính của chúng:
var popoverTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="popover"]'))
var popoverList = popoverTriggerList.map(function (popoverTriggerEl) {
return new bootstrap.Popover(popoverTriggerEl)
})
Ví dụ: Sử dụng container
tùy chọn
Khi bạn có một số kiểu trên phần tử mẹ cản trở cửa sổ bật lên, bạn sẽ muốn chỉ định một tùy chỉnh container
để HTML của cửa sổ bật lên xuất hiện bên trong phần tử đó.
var popover = new bootstrap.Popover(document.querySelector('.example-popover'), {
container: 'body'
})
Thí dụ
<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>
Bốn hướng
Bốn tùy chọn có sẵn: trên cùng, bên phải, bên dưới và căn trái. Chỉ đường được phản chiếu khi sử dụng Bootstrap trong RTL.
<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>
Bỏ qua trong lần nhấp tiếp theo
Sử dụng trình focus
kích hoạt để loại bỏ các cửa sổ bật lên trong lần nhấp tiếp theo của người dùng vào một phần tử khác với phần tử bật tắt.
Đánh dấu cụ thể cần thiết để loại bỏ khi nhấp chuột tiếp theo
Để có hành vi trên nhiều trình duyệt và đa nền tảng phù hợp, bạn phải sử dụng thẻ <a>
, không phải<button>
thẻ và bạn cũng phải bao gồm một tabindex
thuộc tính.
<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'
})
Các phần tử bị vô hiệu hóa
Các phần tử có disabled
thuộc tính không tương tác, có nghĩa là người dùng không thể di chuột hoặc nhấp vào chúng để kích hoạt cửa sổ bật lên (hoặc chú giải công cụ). Để giải quyết vấn đề này, bạn sẽ muốn kích hoạt cửa sổ bật lên từ trình bao bọc <div>
hoặc <span>
lý tưởng là có thể lấy tiêu điểm bằng bàn phím tabindex="0"
.
Đối với trình kích hoạt cửa sổ bật lên bị tắt, bạn cũng có thể muốn data-bs-trigger="hover focus"
cửa sổ bật lên xuất hiện dưới dạng phản hồi trực quan ngay lập tức cho người dùng của bạn vì họ có thể không mong đợi nhấp vào phần tử bị vô hiệu hóa.
<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
Biến
$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);
Cách sử dụng
Bật cửa sổ bật lên qua JavaScript:
var exampleEl = document.getElementById('example')
var popover = new bootstrap.Popover(exampleEl, options)
Làm cho cửa sổ bật lên hoạt động đối với người dùng bàn phím và công nghệ hỗ trợ
Để cho phép người dùng bàn phím kích hoạt cửa sổ bật lên của bạn, bạn chỉ nên thêm chúng vào các phần tử HTML truyền thống có thể lấy tiêu điểm và tương tác với bàn phím (chẳng hạn như liên kết hoặc điều khiển biểu mẫu). Mặc dù các phần tử HTML tùy ý (chẳng hạn như <span>
các) có thể được đặt tiêu điểm bằng cách thêm tabindex="0"
thuộc tính, điều này sẽ thêm các điểm dừng tab có thể gây khó chịu và khó hiểu trên các phần tử không tương tác cho người dùng bàn phím và hầu hết các công nghệ hỗ trợ hiện không thông báo nội dung của cửa sổ bật lên trong tình huống này . Ngoài ra, đừng chỉ dựa vào hover
làm trình kích hoạt cho các cửa sổ bật lên của bạn, vì điều này sẽ khiến chúng không thể kích hoạt cho người dùng bàn phím.
Mặc dù bạn có thể chèn HTML có cấu trúc, phong phú vào các cửa sổ bật lên với html
tùy chọn này, chúng tôi thực sự khuyên bạn nên tránh thêm quá nhiều nội dung. Cách hoạt động của cửa sổ bật lên hiện tại là, sau khi được hiển thị, nội dung của chúng được gắn với phần tử trình kích hoạt có aria-describedby
thuộc tính. Do đó, toàn bộ nội dung của cửa sổ bật lên sẽ được thông báo cho người dùng công nghệ hỗ trợ dưới dạng một luồng dài, không bị gián đoạn.
Ngoài ra, mặc dù cũng có thể bao gồm các điều khiển tương tác (chẳng hạn như các phần tử biểu mẫu hoặc liên kết) trong cửa sổ bật lên của bạn (bằng cách thêm các phần tử này vào các allowList
thuộc tính và thẻ được phép), hãy lưu ý rằng hiện tại cửa sổ bật lên không quản lý thứ tự tiêu điểm bàn phím. Khi người dùng bàn phím mở một cửa sổ bật lên, tiêu điểm vẫn ở phần tử kích hoạt và vì cửa sổ bật lên thường không ngay lập tức theo trình kích hoạt trong cấu trúc của tài liệu, không có gì đảm bảo rằng việc di chuyển tiếp / nhấnTABsẽ di chuyển người dùng bàn phím vào chính cửa sổ bật lên. Nói tóm lại, chỉ cần thêm các điều khiển tương tác vào cửa sổ bật lên có thể khiến các điều khiển này không thể truy cập / không sử dụng được đối với người dùng bàn phím và người dùng công nghệ hỗ trợ, hoặc ít nhất là tạo ra một trật tự tiêu điểm tổng thể phi logic. Trong những trường hợp này, hãy xem xét sử dụng hộp thoại phương thức để thay thế.
Tùy chọn
Các tùy chọn có thể được chuyển qua các thuộc tính dữ liệu hoặc JavaScript. Đối với các thuộc tính dữ liệu, hãy nối tên tùy chọn vào data-bs-
, như trong data-bs-animation=""
. Đảm bảo thay đổi kiểu chữ hoa của tên tùy chọn từ camelCase thành kebab-case khi chuyển các tùy chọn qua thuộc tính dữ liệu. Ví dụ, thay vì sử dụng data-bs-customClass="beautifier"
, hãy sử dụng data-bs-custom-class="beautifier"
.
sanitize
,
các tùy chọn sanitizeFn
và và
allowList
không thể được cung cấp bằng các thuộc tính dữ liệu.
Tên | Loại hình | Mặc định | Sự mô tả |
---|---|---|---|
animation |
boolean | true |
Áp dụng chuyển đổi mờ dần CSS cho cửa sổ bật lên |
container |
chuỗi | phần tử | sai | false |
Thêm cửa sổ bật lên cho một phần tử cụ thể. |
content |
chuỗi | phần tử | hàm số | '' |
Giá trị nội dung mặc định nếu Nếu một hàm được cung cấp, nó sẽ được gọi với |
delay |
số | sự vật | 0 |
Độ trễ hiển thị và ẩn cửa sổ bật lên (mili giây) - không áp dụng cho loại kích hoạt thủ công Nếu một số được cung cấp, độ trễ được áp dụng cho cả ẩn / hiện Cấu trúc đối tượng là: |
html |
boolean | false |
Chèn HTML vào cửa sổ bật lên. Nếu sai, innerText thuộc tính sẽ được sử dụng để chèn nội dung vào DOM. Sử dụng văn bản nếu bạn lo lắng về các cuộc tấn công XSS. |
placement |
chuỗi | hàm số | 'right' |
Cách định vị cửa sổ bật lên - tự động | đầu trang | đáy | trái | bên phải. Khi một hàm được sử dụng để xác định vị trí, nó được gọi với nút DOM popover làm đối số đầu tiên và nút DOM phần tử kích hoạt là nút thứ hai của nó. Bối |
selector |
chuỗi | sai | false |
Nếu một bộ chọn được cung cấp, các đối tượng bật lên sẽ được ủy quyền cho các mục tiêu được chỉ định. Trên thực tế, điều này được sử dụng để cho phép nội dung HTML động có thêm cửa sổ bật lên. Xem điều này và một ví dụ thông tin . |
template |
sợi dây | '<div class="popover" role="tooltip"><div class="popover-arrow"></div><h3 class="popover-header"></h3><div class="popover-body"></div></div>' |
HTML cơ sở để sử dụng khi tạo cửa sổ bật lên. Cửa sổ bật lên Cửa sổ bật lên
Phần tử bao bọc ngoài cùng phải có |
title |
chuỗi | phần tử | hàm số | '' |
Giá trị tiêu đề mặc định nếu Nếu một hàm được cung cấp, nó sẽ được gọi với |
trigger |
sợi dây | 'click' |
Cách kích hoạt cửa sổ bật lên - nhấp vào | di chuột qua | tiêu điểm | thủ công. Bạn có thể vượt qua nhiều lần kích hoạt; ngăn cách chúng bằng một khoảng trắng. manual không thể kết hợp với bất kỳ trình kích hoạt nào khác. |
fallbackPlacements |
mảng | ['top', 'right', 'bottom', 'left'] |
Xác định vị trí dự phòng bằng cách cung cấp danh sách các vị trí trong mảng (theo thứ tự ưu tiên). Để biết thêm thông tin, hãy tham khảo tài liệu về hành vi của Popper |
boundary |
chuỗi | yếu tố | 'clippingParents' |
Ranh giới ràng buộc tràn của cửa sổ bật lên (chỉ áp dụng cho công cụ sửa đổi ngăn chặn của Popper). Theo mặc định, nó 'clippingParents' và có thể chấp nhận tham chiếu HTMLElement (chỉ qua JavaScript). Để biết thêm thông tin, hãy tham khảo tài liệu DetOverflow của Popper . |
customClass |
chuỗi | hàm số | '' |
Thêm các lớp vào cửa sổ bật lên khi nó được hiển thị. Lưu ý rằng các lớp này sẽ được thêm vào ngoài bất kỳ lớp nào được chỉ định trong mẫu. Để thêm nhiều lớp, hãy phân tách chúng bằng dấu cách Bạn cũng có thể chuyển một hàm sẽ trả về một chuỗi đơn chứa các tên lớp bổ sung. |
sanitize |
boolean | true |
Bật hoặc tắt tính năng vệ sinh. Nếu được kích hoạt 'template' , 'content' và 'title' các tùy chọn sẽ được làm sạch. Xem phần sanitizer trong tài liệu JavaScript của chúng tôi . |
allowList |
sự vật | Giá trị mặc định | Đối tượng chứa các thuộc tính và thẻ được phép |
sanitizeFn |
null | hàm số | null |
Tại đây bạn có thể cung cấp chức năng khử trùng của riêng mình. Điều này có thể hữu ích nếu bạn muốn sử dụng một thư viện chuyên dụng để thực hiện vệ sinh. |
offset |
mảng | chuỗi | hàm số | [0, 8] |
Phần bù của cửa sổ bật lên so với mục tiêu của nó. Bạn có thể chuyển một chuỗi trong thuộc tính dữ liệu với các giá trị được phân tách bằng dấu phẩy như: Khi một hàm được sử dụng để xác định độ lệch, nó được gọi với một đối tượng chứa vị trí popper, tham chiếu và popper đóng vai trò là đối số đầu tiên của nó. Nút DOM của phần tử kích hoạt được chuyển làm đối số thứ hai. Hàm phải trả về một mảng có hai số :. Để biết thêm thông tin, hãy tham khảo tài liệu bù đắp của Popper . |
popperConfig |
null | đối tượng | hàm số | null |
Để thay đổi cấu hình Popper mặc định của Bootstrap, hãy xem cấu hình của Popper . Khi một hàm được sử dụng để tạo cấu hình Popper, nó được gọi với một đối tượng có chứa cấu hình Popper mặc định của Bootstrap. Nó giúp bạn sử dụng và hợp nhất mặc định với cấu hình của riêng bạn. Hàm phải trả về một đối tượng cấu hình cho Popper. |
Thuộc tính dữ liệu cho các cửa sổ bật lên riêng lẻ
Các tùy chọn cho các cửa sổ bật lên riêng lẻ có thể được chỉ định theo cách khác thông qua việc sử dụng các thuộc tính dữ liệu, như đã giải thích ở trên.
Sử dụng chức năng vớipopperConfig
var popover = new bootstrap.Popover(element, {
popperConfig: function (defaultBsPopperConfig) {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
})
Phương pháp
Các phương thức và chuyển tiếp không đồng bộ
Tất cả các phương thức API là không đồng bộ và bắt đầu quá trình chuyển đổi . Họ quay lại người gọi ngay sau khi quá trình chuyển đổi được bắt đầu nhưng trước khi quá trình chuyển đổi kết thúc . Ngoài ra, một lệnh gọi phương thức trên một thành phần chuyển tiếp sẽ bị bỏ qua .
Xem tài liệu JavaScript của chúng tôi để biết thêm thông tin .
buổi bieu diễn
Hiển thị cửa sổ bật lên của một phần tử. Trả về người gọi trước khi cửa sổ bật lên thực sự được hiển thị (tức là trước khi shown.bs.popover
sự kiện xảy ra). Đây được coi là một "thủ công" kích hoạt cửa sổ bật lên. Các cửa sổ bật lên có tiêu đề và nội dung đều có độ dài bằng 0 sẽ không bao giờ được hiển thị.
myPopover.show()
ẩn giấu
Ẩn cửa sổ bật lên của một phần tử. Trả về người gọi trước khi cửa sổ bật lên thực sự bị ẩn (tức là trước khi hidden.bs.popover
sự kiện xảy ra). Đây được coi là một "thủ công" kích hoạt cửa sổ bật lên.
myPopover.hide()
chuyển đổi
Chuyển đổi cửa sổ bật lên của một phần tử. Trả về người gọi trước khi cửa sổ bật lên thực sự được hiển thị hoặc bị ẩn (tức là trước khi sự kiện shown.bs.popover
hoặc hidden.bs.popover
sự kiện xảy ra). Đây được coi là một "thủ công" kích hoạt cửa sổ bật lên.
myPopover.toggle()
vứt bỏ
Ẩn và phá hủy cửa sổ bật lên của phần tử (Xóa dữ liệu được lưu trữ trên phần tử DOM). Các cửa sổ bật lên sử dụng ủy quyền (được tạo bằng cách sử dụng tùy selector
chọn ) không thể bị hủy riêng lẻ trên các phần tử kích hoạt con cháu.
myPopover.dispose()
cho phép
Cung cấp khả năng hiển thị cửa sổ bật lên của một phần tử. Các cửa sổ bật lên được bật theo mặc định.
myPopover.enable()
vô hiệu hóa
Loại bỏ khả năng hiển thị cửa sổ bật lên của một phần tử. Cửa sổ bật lên sẽ chỉ có thể được hiển thị nếu nó được bật lại.
myPopover.disable()
toggleEnabled
Chuyển đổi khả năng hiển thị hoặc ẩn cửa sổ bật lên của một phần tử.
myPopover.toggleEnabled()
cập nhật
Cập nhật vị trí của cửa sổ bật lên của một phần tử.
myPopover.update()
getInstance
Phương thức tĩnh cho phép bạn nhận được phiên bản popover được liên kết với một phần tử DOM
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
getOrCreateInstance
Phương thức static cho phép bạn lấy phiên bản popover được liên kết với phần tử DOM hoặc tạo một phiên bản mới trong trường hợp nó chưa được khởi tạo
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getOrCreateInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
Sự kiện
Loại sự kiện | Sự mô tả |
---|---|
show.bs.popover | Sự kiện này kích hoạt ngay lập tức khi show phương thức thể hiện được gọi. |
show.bs.popover | Sự kiện này được kích hoạt khi cửa sổ bật lên hiển thị cho người dùng (sẽ đợi quá trình chuyển đổi CSS hoàn tất). |
hide.bs.popover | Sự kiện này được kích hoạt ngay lập tức khi hide phương thức thể hiện đã được gọi. |
hidden.bs.popover | Sự kiện này được kích hoạt khi cửa sổ bật lên hoàn tất bị ẩn khỏi người dùng (sẽ đợi quá trình chuyển đổi CSS hoàn tất). |
insert.bs.popover | Sự kiện này được kích hoạt sau show.bs.popover sự kiện khi mẫu cửa sổ bật lên đã được thêm vào DOM. |
var myPopoverTrigger = document.getElementById('myPopover')
myPopoverTrigger.addEventListener('hidden.bs.popover', function () {
// do something...
})