ຄຳແນະນຳ
ເອກະສານແລະຕົວຢ່າງສໍາລັບການເພີ່ມຄໍາແນະນໍາເຄື່ອງມື Bootstrap ທີ່ມີ CSS ແລະ JavaScript ໂດຍໃຊ້ CSS3 ສໍາລັບພາບເຄື່ອນໄຫວແລະ data-bs-attributes ສໍາລັບການເກັບຮັກສາຫົວຂໍ້ທ້ອງຖິ່ນ.
ພາບລວມ
ສິ່ງທີ່ຄວນຮູ້ໃນເວລາໃຊ້ plugintip ເຄື່ອງມື:
- ຄໍາແນະນໍາເຄື່ອງມືແມ່ນອີງໃສ່ຫ້ອງສະຫມຸດພາກສ່ວນທີສາມ Popper ສໍາລັບການຈັດຕໍາແຫນ່ງ. ທ່ານຕ້ອງ ໃສ່ popper.min.js ກ່ອນ
bootstrap.js
, ຫຼືໃຊ້ອັນbootstrap.bundle.min.js
ທີ່ມີ Popper. - ຄໍາແນະນໍາເຄື່ອງມືແມ່ນເລືອກເຂົ້າສໍາລັບເຫດຜົນການປະຕິບັດ, ດັ່ງນັ້ນ ທ່ານຕ້ອງເລີ່ມຕົ້ນດ້ວຍຕົນເອງ .
- ຄໍາແນະນໍາເຄື່ອງມືທີ່ມີຊື່ສູນແມ່ນບໍ່ເຄີຍສະແດງ.
- ລະບຸ
container: 'body'
ເພື່ອຫຼີກເວັ້ນການສະແດງບັນຫາໃນອົງປະກອບທີ່ສັບສົນຫຼາຍ (ເຊັ່ນ: ກຸ່ມການປ້ອນຂໍ້ມູນຂອງພວກເຮົາ, ກຸ່ມປຸ່ມ, ແລະອື່ນໆ). - ການກະຕຸ້ນຄໍາແນະນໍາກ່ຽວກັບອົງປະກອບທີ່ເຊື່ອງໄວ້ຈະບໍ່ເຮັດວຽກ.
- ຄໍາແນະນໍາເຄື່ອງມືສໍາລັບ
.disabled
ຫຼືdisabled
ອົງປະກອບຕ້ອງໄດ້ຮັບການກະຕຸ້ນຢູ່ໃນອົງປະກອບ wrapper. - ເມື່ອຖືກກະຕຸ້ນຈາກ hyperlinks ທີ່ຂະຫຍາຍຫຼາຍສາຍ, ຄໍາແນະນໍາເຄື່ອງມືຈະຖືກຈຸດສູນກາງ. ໃຊ້
white-space: nowrap;
ໃນ<a>
s ຂອງທ່ານເພື່ອຫຼີກເວັ້ນການພຶດຕິກໍານີ້. - ຄໍາແນະນໍາເຄື່ອງມືຕ້ອງຖືກເຊື່ອງໄວ້ກ່ອນທີ່ອົງປະກອບທີ່ສອດຄ້ອງກັນຂອງພວກມັນຈະຖືກລຶບອອກຈາກ DOM.
- ຄໍາແນະນໍາເຄື່ອງມືສາມາດຖືກກະຕຸ້ນຍ້ອນອົງປະກອບພາຍໃນເງົາ DOM.
ໄດ້ທັງໝົດບໍ? ດີຫຼາຍ, ໃຫ້ເບິ່ງວ່າພວກເຂົາເຮັດວຽກແນວໃດກັບບາງຕົວຢ່າງ.
prefers-reduced-motion
ສອບຖາມສື່. ເບິ່ງ
ພາກສ່ວນການເຄື່ອນໄຫວທີ່ຫຼຸດລົງຂອງເອກະສານການຊ່ວຍເຂົ້າເຖິງຂອງພວກເຮົາ .
ຕົວຢ່າງ
ເປີດໃຊ້ຄໍາແນະນໍາເຄື່ອງມື
ດັ່ງທີ່ໄດ້ກ່າວມາຂ້າງເທິງ, ທ່ານຕ້ອງເລີ່ມຕົ້ນຄໍາແນະນໍາເຄື່ອງມືກ່ອນທີ່ມັນຈະຖືກນໍາໃຊ້. ວິທີໜຶ່ງເພື່ອເລີ່ມຕົ້ນຄຳແນະນຳເຄື່ອງມືທັງໝົດໃນໜ້າໜຶ່ງແມ່ນການເລືອກພວກມັນຕາມ data-bs-toggle
ຄຸນລັກສະນະຂອງພວກມັນ, ເຊັ່ນ:
const tooltipTriggerList = document.querySelectorAll('[data-bs-toggle="tooltip"]')
const tooltipList = [...tooltipTriggerList].map(tooltipTriggerEl => new bootstrap.Tooltip(tooltipTriggerEl))
ຄໍາແນະນໍາກ່ຽວກັບການເຊື່ອມຕໍ່
ເລື່ອນໃສ່ລິ້ງດ້ານລຸ່ມເພື່ອເບິ່ງຄຳແນະນຳ:
ຂໍ້ຄວາມຕົວຍຶດບ່ອນເພື່ອສະແດງການ ເຊື່ອມຕໍ່ໃນ ແຖວທີ່ມີຄໍາແນະນໍາເຄື່ອງມື. ນີ້ແມ່ນພຽງແຕ່ filler, ບໍ່ມີ killer. ເນື້ອໃນທີ່ວາງໄວ້ຢູ່ທີ່ນີ້ພຽງແຕ່ເພື່ອເຮັດໃຫ້ມີການມີຕົວ ຈິງຂອງຂໍ້ຄວາມ . ແລະທັງໝົດນັ້ນພຽງແຕ່ເພື່ອໃຫ້ເຈົ້າຮູ້ວ່າຄໍາແນະນໍາເຄື່ອງມືຈະເບິ່ງແນວໃດເມື່ອໃຊ້ໃນສະຖານະການຕົວຈິງ. ດັ່ງນັ້ນ, ຫວັງວ່າຕອນນີ້ເຈົ້າໄດ້ເຫັນວິທີການ ເຫຼົ່ານີ້ຄໍາແນະນໍາກ່ຽວກັບການເຊື່ອມຕໍ່ ສາມາດເຮັດວຽກໃນການປະຕິບັດ, ເມື່ອທ່ານໃຊ້ພວກມັນຢູ່ໃນ ເວັບໄຊທ໌ຫຼືໂຄງການ ຂອງທ່ານເອງ .
<p class="muted">Placeholder text to demonstrate some <a href="#" data-bs-toggle="tooltip" data-bs-title="Default tooltip">inline links</a> with tooltips. This is now just filler, no killer. Content placed here just to mimic the presence of <a href="#" data-bs-toggle="tooltip" data-bs-title="Another tooltip">real text</a>. And all that just to give you an idea of how tooltips would look when used in real-world situations. So hopefully you've now seen how <a href="#" data-bs-toggle="tooltip" data-bs-title="Another one here too">these tooltips on links</a> can work in practice, once you use them on <a href="#" data-bs-toggle="tooltip" data-bs-title="The last tip!">your own</a> site or project.
</p>
title
ຫຼື
data-bs-title
ໃນ HTML ຂອງທ່ານ. ເມື່ອ
title
ຖືກໃຊ້, Popper ຈະແທນທີ່ມັນໂດຍອັດຕະໂນມັດ
data-bs-title
ເມື່ອອົງປະກອບຖືກສະແດງ.
ຄໍາແນະນໍາເຄື່ອງມືທີ່ກໍາຫນົດເອງ
ເພີ່ມໃນ v5.2.0ທ່ານສາມາດປັບແຕ່ງຮູບລັກສະນະຂອງຄໍາແນະນໍາເຄື່ອງມືໂດຍໃຊ້ ຕົວແປ CSS . ພວກເຮົາກໍານົດຫ້ອງຮຽນແບບກໍານົດເອງ data-bs-custom-class="custom-tooltip"
ເພື່ອກໍານົດຂອບເຂດລັກສະນະທີ່ກໍາຫນົດເອງຂອງພວກເຮົາແລະໃຊ້ມັນເພື່ອ override ຕົວແປ CSS ທ້ອງຖິ່ນ.
.custom-tooltip {
--bs-tooltip-bg: var(--bs-primary);
}
<button type="button" class="btn btn-secondary"
data-bs-toggle="tooltip" data-bs-placement="top"
data-bs-custom-class="custom-tooltip"
data-bs-title="This top tooltip is themed via CSS variables.">
Custom tooltip
</button>
ທິດທາງ
ເລື່ອນໃສ່ປຸ່ມຕ່າງໆຂ້າງລຸ່ມນີ້ເພື່ອເບິ່ງສີ່ທິດທາງຄໍາແນະນໍາ: ເທິງ, ຂວາ, ລຸ່ມ, ແລະຊ້າຍ. ທິດທາງແມ່ນສະທ້ອນເມື່ອໃຊ້ Bootstrap ໃນ RTL.
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="top" data-bs-title="Tooltip on top">
Tooltip on top
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="right" data-bs-title="Tooltip on right">
Tooltip on right
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="bottom" data-bs-title="Tooltip on bottom">
Tooltip on bottom
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="left" data-bs-title="Tooltip on left">
Tooltip on left
</button>
ແລະດ້ວຍການເພີ່ມ HTML ແບບກຳນົດເອງ:
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-html="true" data-bs-title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
Tooltip with HTML
</button>
ດ້ວຍ SVG:
CSS
ຕົວແປ
ເພີ່ມໃນ v5.2.0ເປັນສ່ວນຫນຶ່ງຂອງວິທີການພັດທະນາຕົວແປ CSS ຂອງ Bootstrap, ຄໍາແນະນໍາເຄື່ອງມືໃນປັດຈຸບັນໃຊ້ຕົວແປ CSS ທ້ອງຖິ່ນ .tooltip
ສໍາລັບການປັບແຕ່ງເວລາທີ່ແທ້ຈິງ. ຄ່າສໍາລັບຕົວແປ CSS ແມ່ນຖືກກໍານົດຜ່ານ Sass, ດັ່ງນັ້ນການປັບແຕ່ງ Sass ຍັງຖືກສະຫນັບສະຫນູນ, ເຊັ່ນກັນ.
--#{$prefix}tooltip-zindex: #{$zindex-tooltip};
--#{$prefix}tooltip-max-width: #{$tooltip-max-width};
--#{$prefix}tooltip-padding-x: #{$tooltip-padding-x};
--#{$prefix}tooltip-padding-y: #{$tooltip-padding-y};
--#{$prefix}tooltip-margin: #{$tooltip-margin};
@include rfs($tooltip-font-size, --#{$prefix}tooltip-font-size);
--#{$prefix}tooltip-color: #{$tooltip-color};
--#{$prefix}tooltip-bg: #{$tooltip-bg};
--#{$prefix}tooltip-border-radius: #{$tooltip-border-radius};
--#{$prefix}tooltip-opacity: #{$tooltip-opacity};
--#{$prefix}tooltip-arrow-width: #{$tooltip-arrow-width};
--#{$prefix}tooltip-arrow-height: #{$tooltip-arrow-height};
ຕົວແປ Sass
$tooltip-font-size: $font-size-sm;
$tooltip-max-width: 200px;
$tooltip-color: $white;
$tooltip-bg: $black;
$tooltip-border-radius: $border-radius;
$tooltip-opacity: .9;
$tooltip-padding-y: $spacer * .25;
$tooltip-padding-x: $spacer * .5;
$tooltip-margin: null; // TODO: remove this in v6
$tooltip-arrow-width: .8rem;
$tooltip-arrow-height: .4rem;
// fusv-disable
$tooltip-arrow-color: null; // Deprecated in Bootstrap 5.2.0 for CSS variables
// fusv-enable
ການນໍາໃຊ້
ປັ໊ກອິນຄໍາແນະນໍາເຄື່ອງມືສ້າງເນື້ອຫາແລະເຄື່ອງຫມາຍຕາມຄວາມຕ້ອງການ, ແລະໂດຍຄ່າເລີ່ມຕົ້ນວາງຄໍາແນະນໍາເຄື່ອງມືຫຼັງຈາກອົງປະກອບຂອງຕົວກະຕຸ້ນຂອງພວກເຂົາ.
ກະຕຸ້ນຄໍາແນະນໍາເຄື່ອງມືຜ່ານ JavaScript:
const exampleEl = document.getElementById('example')
const tooltip = new bootstrap.Tooltip(exampleEl, options)
ລົ້ນ auto
ແລະscroll
ຕໍາແໜ່ງຄໍາແນະນໍາເຄື່ອງມືພະຍາຍາມປ່ຽນແປງອັດຕະໂນມັດເມື່ອພາຊະນະ ແມ່ ມີ overflow: auto
ຫຼື overflow: scroll
ມັກຂອງພວກເຮົາ .table-responsive
, ແຕ່ຍັງຄົງຮັກສາການຈັດຕໍາແຫນ່ງຕົ້ນສະບັບໄວ້. ເພື່ອແກ້ໄຂບັນຫານີ້, ກໍານົດ boundary
ທາງເລືອກ (ສໍາລັບຕົວແກ້ໄຂ flip ໂດຍໃຊ້ popperConfig
ທາງເລືອກ) ເປັນ HTMLElement ໃດໆທີ່ຈະ override ຄ່າເລີ່ມຕົ້ນ 'clippingParents'
, ເຊັ່ນ document.body
:
const tooltip = new bootstrap.Tooltip('#example', {
boundary: document.body // or document.querySelector('#boundary')
})
ມາກອັບ
markup ທີ່ຕ້ອງການສໍາລັບຄໍາແນະນໍາເຄື່ອງມືແມ່ນພຽງແຕ່ data
ຄຸນລັກສະນະແລະ title
ໃນອົງປະກອບ HTML ທີ່ທ່ານຕ້ອງການທີ່ຈະມີຄໍາແນະນໍາເຄື່ອງມື. ເຄື່ອງຫມາຍທີ່ສ້າງຂຶ້ນຂອງຄໍາແນະນໍາເຄື່ອງມືແມ່ນງ່າຍດາຍຫຼາຍ, ເຖິງແມ່ນວ່າມັນຕ້ອງການຕໍາແຫນ່ງ (ໂດຍຄ່າເລີ່ມຕົ້ນ, ກໍານົດ top
ໂດຍ plugin).
ເຮັດໃຫ້ຄໍາແນະນໍາເຄື່ອງມືເຮັດວຽກສໍາລັບຜູ້ໃຊ້ແປ້ນພິມແລະເຕັກໂນໂລຢີການຊ່ວຍເຫຼືອ
ທ່ານຄວນເພີ່ມຄໍາແນະນໍາເຄື່ອງມືໃຫ້ກັບອົງປະກອບ HTML ທີ່ເປັນແບບດັ້ງເດີມທີ່ເນັ້ນໃສ່ແປ້ນພິມແລະໂຕ້ຕອບ (ເຊັ່ນ: ການເຊື່ອມຕໍ່ຫຼືການຄວບຄຸມແບບຟອມ). ເຖິງແມ່ນວ່າອົງປະກອບ HTML ທີ່ບໍ່ມັກ (ເຊັ່ນ <span>
s) ສາມາດສຸມໃສ່ໄດ້ໂດຍການເພີ່ມ tabindex="0"
ຄຸນລັກສະນະ, ນີ້ຈະເພີ່ມການຢຸດແຖບທີ່ຫນ້າລໍາຄານແລະສັບສົນໃນອົງປະກອບທີ່ບໍ່ມີການໂຕ້ຕອບສໍາລັບຜູ້ໃຊ້ແປ້ນພິມ, ແລະເຕັກໂນໂລຢີການຊ່ວຍເຫຼືອສ່ວນໃຫຍ່ໃນປະຈຸບັນບໍ່ໄດ້ປະກາດຄໍາແນະນໍາໃນສະຖານະການນີ້. ນອກຈາກນັ້ນ, ຢ່າອີງໃສ່ພຽງແຕ່ hover
ເປັນຕົວກະຕຸ້ນສໍາລັບຄໍາແນະນໍາເຄື່ອງມືຂອງເຈົ້າ, ເພາະວ່ານີ້ຈະເຮັດໃຫ້ຄໍາແນະນໍາເຄື່ອງມືຂອງເຈົ້າບໍ່ສາມາດກະຕຸ້ນໃຫ້ຜູ້ໃຊ້ແປ້ນພິມໄດ້.
<!-- HTML to write -->
<a href="#" data-bs-toggle="tooltip" data-bs-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
ຄຸນລັກສະນະບໍ່ແມ່ນການໂຕ້ຕອບ, ຊຶ່ງຫມາຍຄວາມວ່າຜູ້ໃຊ້ບໍ່ສາມາດສຸມໃສ່, ເລື່ອນ, ຫຼືຄລິກໃສ່ພວກມັນເພື່ອກະຕຸ້ນຄໍາແນະນໍາເຄື່ອງມື (ຫຼື popover). ໃນຖານະເປັນການແກ້ໄຂໄດ້, ທ່ານຈະຕ້ອງການທີ່ຈະກະຕຸ້ນຄໍາແນະນໍາຂອງເຄື່ອງມືຈາກ wrapper <div>
ຫຼື <span>
, ໂດຍສະເພາະແມ່ນເຮັດໃຫ້ແປ້ນພິມສຸມໃສ່ການນໍາໃຊ້ tabindex="0"
.
<span class="d-inline-block" tabindex="0" data-bs-toggle="tooltip" data-bs-title="Disabled tooltip">
<button class="btn btn-primary" type="button" disabled>Disabled button</button>
</span>
ທາງເລືອກ
ເນື່ອງຈາກທາງເລືອກສາມາດຖືກສົ່ງຜ່ານຄຸນລັກສະນະຂໍ້ມູນຫຼື JavaScript, ທ່ານສາມາດເພີ່ມຊື່ທາງເລືອກໃສ່ data-bs-
, ດັ່ງໃນ data-bs-animation="{value}"
. ໃຫ້ແນ່ໃຈວ່າປ່ຽນປະເພດກໍລະນີຂອງຊື່ທາງເລືອກຈາກ " camelCase " ເປັນ " kebab-case " ເມື່ອຖ່າຍທອດທາງເລືອກຜ່ານຄຸນລັກສະນະຂໍ້ມູນ. ຕົວຢ່າງ, ໃຊ້ data-bs-custom-class="beautifier"
ແທນ data-bs-customClass="beautifier"
.
ໃນຖານະເປັນຂອງ Bootstrap 5.2.0, ອົງປະກອບທັງຫມົດສະຫນັບສະຫນູນ ຄຸນລັກສະນະຂໍ້ມູນທີ່ສະຫງວນໄວ້ສໍາ ລັບ ການທົດລອງdata-bs-config
ທີ່ສາມາດຈັດການຕັ້ງຄ່າອົງປະກອບງ່າຍດາຍເປັນ JSON string. ເມື່ອອົງປະກອບມີ data-bs-config='{"delay":0, "title":123}'
ແລະ data-bs-title="456"
ຄຸນລັກສະນະ, ຄ່າສຸດທ້າຍ title
ຈະເປັນ 456
ແລະຄຸນລັກສະນະຂອງຂໍ້ມູນແຍກຕ່າງຫາກຈະ override ຄ່າທີ່ໃຫ້ຢູ່ໃນ data-bs-config
. ນອກຈາກນັ້ນ, ຄຸນລັກສະນະຂໍ້ມູນທີ່ມີຢູ່ແມ່ນສາມາດຈັດວາງຄ່າ JSON ເຊັ່ນ data-bs-delay='{"show":0,"hide":150}'
.
sanitize
,
sanitizeFn
, ແລະ
allowList
ທາງເລືອກບໍ່ສາມາດຖືກສະຫນອງໂດຍໃຊ້ຄຸນລັກສະນະຂໍ້ມູນ.
ຊື່ | ປະເພດ | ຄ່າເລີ່ມຕົ້ນ | ລາຍລະອຽດ |
---|---|---|---|
allowList |
ວັດຖຸ | ຄ່າເລີ່ມຕົ້ນ | ວັດຖຸທີ່ມີຄຸນລັກສະນະ ແລະແທັກທີ່ອະນຸຍາດ. |
animation |
ບູລີນ | true |
ນຳໃຊ້ການປ່ຽນ CSS ຈືດໆໄປຫາຄຳແນະນຳ. |
boundary |
string, ອົງປະກອບ | 'clippingParents' |
ຂອບເຂດຈໍາກັດ overflow ຂອງຄໍາແນະນໍາເຄື່ອງມື (ໃຊ້ກັບຕົວແກ້ໄຂການປ້ອງກັນການ overflow ຂອງ Popper ເທົ່ານັ້ນ). ໂດຍຄ່າເລີ່ມຕົ້ນ, ມັນເປັນ 'clippingParents' ແລະສາມາດຍອມຮັບການອ້າງອີງ HTMLElement (ຜ່ານ JavaScript ເທົ່ານັ້ນ). ສໍາລັບຂໍ້ມູນເພີ່ມເຕີມເບິ່ງ ເອກະສານ detectOverflow ຂອງ Popper . |
container |
string, ອົງປະກອບ, false | false |
ຕື່ມຄໍາແນະນໍາເຄື່ອງມືໃສ່ກັບອົງປະກອບສະເພາະ. ຕົວຢ່າງ: container: 'body' . ຕົວເລືອກນີ້ແມ່ນເປັນປະໂຫຍດໂດຍສະເພາະໃນທີ່ມັນອະນຸຍາດໃຫ້ທ່ານຈັດວາງຄໍາແນະນໍາເຄື່ອງມືໃນການໄຫຼເຂົ້າຂອງເອກະສານຢູ່ໃກ້ກັບອົງປະກອບກະຕຸ້ນ - ເຊິ່ງຈະປ້ອງກັນບໍ່ໃຫ້ຄໍາແນະນໍາເຄື່ອງມືຈາກການເລື່ອນອອກຈາກອົງປະກອບກະຕຸ້ນໃນລະຫວ່າງການປັບຂະຫນາດຂອງປ່ອງຢ້ຽມ. |
customClass |
string, function | '' |
ເພີ່ມຫ້ອງຮຽນໃສ່ຄໍາແນະນໍາເຄື່ອງມືເມື່ອມັນຖືກສະແດງ. ຈົ່ງຈື່ໄວ້ວ່າຊັ້ນຮຽນເຫຼົ່ານີ້ຈະຖືກເພີ່ມໃສ່ນອກເໜືອໄປຈາກຊັ້ນຮຽນໃດນຶ່ງທີ່ລະບຸໄວ້ໃນແມ່ແບບ. ເພື່ອເພີ່ມຫຼາຍຊັ້ນຮຽນ, ແຍກພວກມັນດ້ວຍຍະຫວ່າງ: 'class-1 class-2' . ທ່ານຍັງສາມາດຜ່ານຟັງຊັນທີ່ຄວນສົ່ງຄືນສະຕຣິງດຽວທີ່ມີຊື່ຊັ້ນຮຽນເພີ່ມເຕີມ. |
delay |
ຈໍານວນ, ວັດຖຸ | 0 |
ເລື່ອນການສະແດງ ແລະເຊື່ອງຄໍາແນະນໍາເຄື່ອງມື (ms)—ບໍ່ໃຊ້ກັບປະເພດຕົວກະຕຸ້ນດ້ວຍຕົນເອງ. ຖ້າມີຕົວເລກໃຫ້, ການຊັກຊ້າແມ່ນໃຊ້ກັບທັງເຊື່ອງ / ສະແດງ. ໂຄງສ້າງວັດຖຸແມ່ນ: delay: { "show": 500, "hide": 100 } . |
fallbackPlacements |
array | ['top', 'right', 'bottom', 'left'] |
ກຳນົດການຈັດຕຳແໜ່ງສຳຮອງໂດຍການສະໜອງລາຍຊື່ການຈັດວາງໃນອາເຣ (ຕາມລຳດັບຄວາມມັກ). ສໍາລັບຂໍ້ມູນເພີ່ມເຕີມເບິ່ງ ເອກະສານພຶດຕິກໍາ ຂອງ Popper . |
html |
ບູລີນ | false |
ອະນຸຍາດໃຫ້ HTML ໃນຄໍາແນະນໍາເຄື່ອງມື. ຖ້າເປັນຄວາມຈິງ, ແທັກ HTML ໃນຄໍາແນະນໍາຂອງເຄື່ອງມື title ຈະຖືກສະແດງຢູ່ໃນຄໍາແນະນໍາເຄື່ອງມື. ຖ້າເປັນຜິດ, innerText ຄຸນສົມບັດຈະຖືກໃຊ້ເພື່ອໃສ່ເນື້ອຫາເຂົ້າໄປໃນ DOM. ໃຊ້ຂໍ້ຄວາມຖ້າທ່ານກັງວົນກ່ຽວກັບການໂຈມຕີ XSS. |
offset |
array, string, function | [0, 0] |
ຊົດເຊີຍຂອງຄໍາແນະນໍາເຄື່ອງມືທຽບກັບເປົ້າຫມາຍຂອງມັນ. ທ່ານສາມາດຖ່າຍທອດສະຕຣິງໃນຄຸນລັກສະນະຂໍ້ມູນດ້ວຍຄ່າທີ່ແຍກດ້ວຍເຄື່ອງໝາຍຈຸດເຊັ່ນ: data-bs-offset="10,20" . ເມື່ອຟັງຊັນຖືກນໍາໃຊ້ເພື່ອກໍານົດການຊົດເຊີຍ, ມັນຖືກເອີ້ນວ່າວັດຖຸທີ່ມີການຈັດວາງ popper, ການອ້າງອີງ, ແລະ popper rects ເປັນການໂຕ້ຖຽງທໍາອິດຂອງມັນ. ອົງປະກອບກະຕຸ້ນ DOM node ແມ່ນຜ່ານເປັນອາກິວເມັນທີສອງ. ຟັງຊັນຕ້ອງສົ່ງຄືນ array ທີ່ມີສອງຕົວເລກ: skidding , distance . ສໍາລັບຂໍ້ມູນເພີ່ມເຕີມເບິ່ງ ເອກະສານຊົດເຊີຍ ຂອງ Popper . |
placement |
string, function | 'top' |
ວິທີການຈັດຕໍາແຫນ່ງຄໍາແນະນໍາເຄື່ອງມື: ອັດຕະໂນມັດ, ເທິງ, ລຸ່ມ, ຊ້າຍ, ຂວາ. ເມື່ອ auto ຖືກລະບຸໄວ້, ມັນຈະປ່ຽນທິດທາງເຄື່ອງມືແບບໄດນາມິກ. ເມື່ອຟັງຊັນໃດນຶ່ງຖືກໃຊ້ເພື່ອກໍານົດການຈັດວາງ, ມັນຖືກເອີ້ນດ້ວຍແຖບເຄື່ອງມື DOM node ເປັນອາກິວເມັນທຳອິດຂອງມັນ ແລະອົງປະກອບທີ່ກະຕຸ້ນ DOM node ເປັນອັນທີສອງຂອງມັນ. ສະ this ພາບການຖືກຕັ້ງເປັນຕົວຢ່າງເຄື່ອງມື. |
popperConfig |
null, object, function | null |
ເພື່ອປ່ຽນການຕັ້ງຄ່າ Popper ເລີ່ມຕົ້ນຂອງ Bootstrap, ເບິ່ງ ການຕັ້ງຄ່າຂອງ Popper . ເມື່ອຟັງຊັນຖືກໃຊ້ເພື່ອສ້າງການຕັ້ງຄ່າ Popper, ມັນຖືກເອີ້ນດ້ວຍວັດຖຸທີ່ມີການຕັ້ງຄ່າ Popper ເລີ່ມຕົ້ນຂອງ Bootstrap. ມັນຊ່ວຍໃຫ້ທ່ານໃຊ້ແລະລວມຄ່າເລີ່ມຕົ້ນກັບການຕັ້ງຄ່າຂອງທ່ານເອງ. ຟັງຊັນຕ້ອງສົ່ງຄືນວັດຖຸການຕັ້ງຄ່າສໍາລັບ Popper. |
sanitize |
ບູລີນ | true |
ເປີດຫຼືປິດການອະນາໄມ. ຖ້າເປີດໃຊ້ 'template' , 'content' ແລະ 'title' ຕົວເລືອກຕ່າງໆຈະຖືກອະນາໄມ. |
sanitizeFn |
null, ຟັງຊັນ | null |
ໃນທີ່ນີ້ທ່ານສາມາດສະຫນອງຫນ້າທີ່ສຸຂາພິບານຂອງທ່ານເອງ. ນີ້ສາມາດເປັນປະໂຫຍດຖ້າທ່ານຕ້ອງການໃຊ້ຫ້ອງສະຫມຸດສະເພາະເພື່ອເຮັດການອະນາໄມ. |
selector |
string, false | false |
ຖ້າຕົວເລືອກຖືກສະໜອງໃຫ້, ເຄື່ອງມືແນະນຳວັດຖຸຈະຖືກມອບໝາຍໃຫ້ເປົ້າໝາຍທີ່ລະບຸໄວ້. ໃນທາງປະຕິບັດ, ນີ້ຖືກນໍາໃຊ້ເພື່ອນໍາໃຊ້ຄໍາແນະນໍາເຄື່ອງມືເພື່ອເພີ່ມອົງປະກອບ DOM ( jQuery.on ສະຫນັບສະຫນູນ). ເບິ່ງ ບັນຫານີ້ ແລະ ຕົວຢ່າງທີ່ໃຫ້ຂໍ້ມູນ . |
template |
ສາຍ | '<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>' |
ພື້ນຖານ HTML ທີ່ຈະໃຊ້ໃນເວລາສ້າງຄໍາແນະນໍາເຄື່ອງມື. ຄໍາແນະນໍາຂອງເຄື່ອງມື title ຈະຖືກສີດເຂົ້າໄປໃນ .tooltip-inner . .tooltip-arrow ຈະກາຍເປັນລູກສອນຂອງຄໍາແນະນໍາ. ອົງປະກອບ wrapper ຊັ້ນນອກທີ່ສຸດຄວນຈະມີ .tooltip ຊັ້ນຮຽນແລະ role="tooltip" . |
title |
string, ອົງປະກອບ, function | '' |
ຄ່າເລີ່ມຕົ້ນຂອງຫົວຂໍ້ຖ້າ title ຄຸນສົມບັດບໍ່ມີຢູ່. ຖ້າຟັງຊັນຖືກມອບໃຫ້, ມັນຈະຖືກເອີ້ນໂດຍ this ອ້າງອີງໃສ່ອົງປະກອບທີ່ popover ຕິດກັບ. |
trigger |
ສາຍ | 'hover focus' |
ຄໍາແນະນໍາເຄື່ອງມືຖືກກະຕຸ້ນແນວໃດ: ຄລິກ, ເລື່ອນ, ໂຟກັສ, ຄູ່ມື. ທ່ານອາດຈະຜ່ານຫຼາຍ triggers; ແຍກພວກມັນດ້ວຍຊ່ອງຫວ່າງ. 'manual' ຊີ້ໃຫ້ເຫັນວ່າຄໍາແນະນໍາເຄື່ອງມືຈະຖືກກະຕຸ້ນດ້ວຍໂປຣແກຣມໂດຍຜ່ານ .tooltip('show') , .tooltip('hide') ແລະ .tooltip('toggle') ວິທີການ; ຄ່ານີ້ບໍ່ສາມາດຖືກລວມເຂົ້າກັບຕົວກະຕຸ້ນອື່ນໆໄດ້. 'hover' ຂອງມັນເອງຈະສົ່ງຜົນໃຫ້ຄໍາແນະນໍາເຄື່ອງມືທີ່ບໍ່ສາມາດຖືກກະຕຸ້ນຜ່ານແປ້ນພິມໄດ້, ແລະຄວນຈະຖືກນໍາໃຊ້ພຽງແຕ່ຖ້າວິທີການທາງເລືອກໃນການຖ່າຍທອດຂໍ້ມູນດຽວກັນສໍາລັບຜູ້ໃຊ້ແປ້ນພິມ. |
ຄຸນລັກສະນະຂໍ້ມູນສໍາລັບຄໍາແນະນໍາເຄື່ອງມືສ່ວນບຸກຄົນ
ທາງເລືອກສໍາລັບຄໍາແນະນໍາຂອງບຸກຄົນເປັນທາງເລືອກທີ່ສາມາດໄດ້ຮັບການລະບຸໂດຍການນໍາໃຊ້ຄຸນລັກສະນະຂໍ້ມູນ, ດັ່ງທີ່ອະທິບາຍຂ້າງເທິງ.
ການນໍາໃຊ້ຟັງຊັນທີ່ມີpopperConfig
const tooltip = new bootstrap.Tooltip(element, {
popperConfig(defaultBsPopperConfig) {
// const newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
})
ວິທີການ
ວິທີການ asynchronous ແລະການຫັນປ່ຽນ
ວິທີການ API ທັງໝົດແມ່ນ asynchronous ແລະເລີ່ມການ ຫັນປ່ຽນ . ພວກເຂົາກັບຄືນໄປຫາຜູ້ໂທທັນທີທີ່ການຫັນປ່ຽນເລີ່ມຕົ້ນແຕ່ ກ່ອນທີ່ມັນຈະສິ້ນສຸດລົງ . ນອກຈາກນັ້ນ, ການໂທຫາວິທີການກ່ຽວກັບ ອົງປະກອບຂອງການປ່ຽນແປງຈະຖືກລະເລີຍ .
ວິທີການ | ລາຍລະອຽດ |
---|---|
disable |
ເອົາຄວາມສາມາດອອກສໍາລັບຄໍາແນະນໍາເຄື່ອງມືຂອງອົງປະກອບທີ່ຈະສະແດງໃຫ້ເຫັນ. ຄໍາແນະນໍາເຄື່ອງມືຈະສາມາດສະແດງໄດ້ພຽງແຕ່ຖ້າມັນຖືກເປີດໃຊ້ໃຫມ່. |
dispose |
ເຊື່ອງ ແລະທຳລາຍຄຳແນະນຳຂອງອົງປະກອບໃດໜຶ່ງ (ລຶບຂໍ້ມູນທີ່ເກັບໄວ້ໃນອົງປະກອບ DOM). ຄໍາແນະນໍາເຄື່ອງມືທີ່ໃຊ້ການມອບຫມາຍ (ທີ່ຖືກສ້າງຂຶ້ນໂດຍໃຊ້ ຕົວ selector ເລືອກ ) ບໍ່ສາມາດຖືກທໍາລາຍເປັນສ່ວນບຸກຄົນໃນອົງປະກອບ trigger ສືບທອດ. |
enable |
ໃຫ້ຄໍາແນະນໍາເຄື່ອງມືຂອງອົງປະກອບທີ່ມີຄວາມສາມາດໃນການສະແດງໃຫ້ເຫັນ. ຄໍາແນະນໍາເຄື່ອງມືຖືກເປີດໃຊ້ໂດຍຄ່າເລີ່ມຕົ້ນ. |
getInstance |
ວິທີການ ຄົງ ທີ່ທີ່ຊ່ວຍໃຫ້ທ່ານໄດ້ຮັບຕົວຢ່າງຄໍາແນະນໍາເຄື່ອງມືທີ່ກ່ຽວຂ້ອງກັບອົງປະກອບ DOM, ຫຼືສ້າງໃຫມ່ໃນກໍລະນີທີ່ມັນບໍ່ໄດ້ຖືກເລີ່ມຕົ້ນ. |
getOrCreateInstance |
ວິທີການ ຄົງ ທີ່ທີ່ຊ່ວຍໃຫ້ທ່ານໄດ້ຮັບຕົວຢ່າງຄໍາແນະນໍາເຄື່ອງມືທີ່ກ່ຽວຂ້ອງກັບອົງປະກອບ DOM, ຫຼືສ້າງໃຫມ່ໃນກໍລະນີທີ່ມັນບໍ່ໄດ້ຖືກເລີ່ມຕົ້ນ. |
hide |
ເຊື່ອງຄໍາແນະນໍາຂອງອົງປະກອບ. ກັບຄືນໄປຫາຜູ້ໂທກ່ອນທີ່ຄໍາແນະນໍາເຄື່ອງມືໄດ້ຖືກເຊື່ອງໄວ້ຕົວຈິງ (ເຊັ່ນ: ກ່ອນທີ່ hidden.bs.tooltip ເຫດການຈະເກີດຂື້ນ). ນີ້ຖືວ່າເປັນ "ຄູ່ມື" ການກະຕຸ້ນຂອງຄໍາແນະນໍາເຄື່ອງມື. |
setContent |
ໃຫ້ວິທີການປ່ຽນເນື້ອໃນຄໍາແນະນໍາຂອງເຄື່ອງມືຫຼັງຈາກການເລີ່ມຕົ້ນຂອງມັນ. |
show |
ເປີດເຜີຍຄໍາແນະນໍາຂອງອົງປະກອບ. ກັບຄືນໄປຫາຜູ້ໂທກ່ອນທີ່ຄໍາແນະນໍາເຄື່ອງມືໄດ້ຖືກສະແດງໃຫ້ເຫັນຕົວຈິງ (ເຊັ່ນ: ກ່ອນທີ່ shown.bs.tooltip ເຫດການຈະເກີດຂື້ນ). ນີ້ຖືວ່າເປັນ "ຄູ່ມື" ການກະຕຸ້ນຂອງຄໍາແນະນໍາເຄື່ອງມື. ຄໍາແນະນໍາເຄື່ອງມືທີ່ມີຊື່ສູນແມ່ນບໍ່ເຄີຍສະແດງ. |
toggle |
ສະຫຼັບຄຳແນະນຳຂອງອົງປະກອບໃດໜຶ່ງ. ກັບຄືນໄປຫາຜູ້ໂທກ່ອນທີ່ຄໍາແນະນໍາເຄື່ອງມືໄດ້ຖືກສະແດງໃຫ້ເຫັນຫຼືເຊື່ອງໄວ້ (ເຊັ່ນວ່າກ່ອນທີ່ເຫດການ shown.bs.tooltip ຫຼື hidden.bs.tooltip ເຫດການຈະເກີດຂື້ນ). ນີ້ຖືວ່າເປັນ "ຄູ່ມື" ການກະຕຸ້ນຂອງຄໍາແນະນໍາເຄື່ອງມື. |
toggleEnabled |
ສະຫຼັບຄວາມສາມາດສໍາລັບຄໍາແນະນໍາເຄື່ອງມືຂອງອົງປະກອບທີ່ຈະສະແດງໃຫ້ເຫັນຫຼືເຊື່ອງໄວ້. |
update |
ອັບເດດຕຳແໜ່ງຂອງຄຳແນະນຳຂອງອົງປະກອບໃດໜຶ່ງ. |
const tooltip = bootstrap.Tooltip.getInstance('#example') // Returns a Bootstrap tooltip instance
// setContent example
tooltip.setContent({ '.tooltip-inner': 'another title' })
setContent
ທີການຍອມຮັບການ
object
ໂຕ້ຖຽງ, ເຊິ່ງແຕ່ລະຄຸນສົມບັດ
-key ເປັນ string
ຕົວເລືອກທີ່ຖືກຕ້ອງພາຍໃນແມ່ແບບ popover, ແລະແຕ່ລະຊັບສິນ-ຄ່າທີ່ກ່ຽວຂ້ອງສາມາດເປັນ
string
|
element
|
function
|
null
ເຫດການ
ເຫດການ | ລາຍລະອຽດ |
---|---|
hide.bs.tooltip |
ເຫດການນີ້ຈະຖືກຍິງອອກທັນທີເມື່ອ hide ວິທີການຕົວຢ່າງຖືກເອີ້ນ. |
hidden.bs.tooltip |
ເຫດການນີ້ຖືກຍິງອອກເມື່ອ popover ສໍາເລັດການຖືກເຊື່ອງໄວ້ຈາກຜູ້ໃຊ້ (ຈະລໍຖ້າໃຫ້ CSS transitions ສໍາເລັດ). |
inserted.bs.tooltip |
ເຫດການນີ້ຖືກໄລ່ອອກຫຼັງຈາກ show.bs.tooltip ເຫດການເມື່ອແມ່ແບບຄໍາແນະນໍາເຄື່ອງມືໄດ້ຖືກເພີ່ມໃສ່ DOM. |
show.bs.tooltip |
ເຫດການນີ້ໄຟໄຫມ້ທັນທີເມື່ອ show ວິທີການຕົວຢ່າງຖືກເອີ້ນ. |
shown.bs.tooltip |
ເຫດການນີ້ຖືກຍິງອອກເມື່ອ popover ໄດ້ຖືກເຮັດໃຫ້ຜູ້ໃຊ້ສາມາດເຫັນໄດ້ (ຈະລໍຖ້າໃຫ້ CSS transitions ສໍາເລັດ). |
const myTooltipEl = document.getElementById('myTooltip')
const tooltip = bootstrap.Tooltip.getOrCreateInstance(myTooltipEl)
myTooltipEl.addEventListener('hidden.bs.tooltip', () => {
// do something...
})
tooltip.hide()