Scrollspy
อัปเดตการนำทาง Bootstrap หรือส่วนประกอบกลุ่มรายการโดยอัตโนมัติตามตำแหน่งการเลื่อนเพื่อระบุว่าลิงก์ใดที่ใช้งานอยู่ในวิวพอร์ต
มันทำงานอย่างไร
Scrollspy สลับ.active
คลาสบนองค์ประกอบสมอ ( <a>
) เมื่อองค์ประกอบที่มีการid
อ้างอิงโดยสมอhref
เลื่อนเข้าสู่มุมมอง ควรใช้ Scrollspy ร่วมกับส่วนประกอบการนำ ทาง Bootstrap หรือกลุ่มรายการแต่จะทำงานร่วมกับองค์ประกอบจุดยึดในหน้าปัจจุบันด้วย นี่คือวิธีการทำงาน
-
ในการเริ่มต้น scrollspy จำเป็นต้องมีสองสิ่ง: การนำทาง กลุ่มรายการ หรือชุดลิงก์อย่างง่าย บวกกับคอนเทนเนอร์แบบเลื่อนได้ คอนเทนเนอร์แบบเลื่อนได้สามารถเป็น องค์ประกอบหรือแบบกำหนด เอง
<body>
ที่มีชุดheight
และoverflow-y: scroll
-
บนคอนเทนเนอร์ที่เลื่อนได้ ให้เพิ่ม
data-bs-spy="scroll"
และdata-bs-target="#navId"
ตำแหน่งที่navId
ไม่ซ้ำกันid
ของการนำทางที่เกี่ยวข้อง อย่าลืมใส่ atabindex="0"
เพื่อให้แน่ใจว่าการเข้าถึงแป้นพิมพ์ -
เมื่อคุณเลื่อนคอนเทนเนอร์ "สอดแนม"
.active
คลาสจะถูกเพิ่มและลบออกจากลิงก์สมอภายในการนำทางที่เกี่ยวข้อง ลิงก์ต้องมีid
เป้าหมายที่แก้ไขได้ มิฉะนั้นจะถูกละเว้น ตัวอย่างเช่น<a href="#home">home</a>
ต้องสอดคล้องกับบางสิ่งใน DOM เช่น<div id="home"></div>
-
องค์ประกอบเป้าหมายที่ไม่สามารถมองเห็นได้จะถูกละเว้น ดู ส่วน องค์ประกอบที่มองไม่เห็นด้านล่าง
ตัวอย่าง
แถบนำทาง
เลื่อนพื้นที่ด้านล่างแถบนำทางและดูการเปลี่ยนแปลงชั้นเรียนที่ใช้งานอยู่ เปิดเมนูแบบเลื่อนลงและดูรายการแบบเลื่อนลงที่ถูกเน้นด้วย
หัวเรื่องแรก
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
หัวเรื่องที่สอง
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
หัวเรื่องที่สาม
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
หัวข้อที่สี่
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
หัวข้อที่ห้า
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
<nav id="navbar-example2" class="navbar bg-light px-3 mb-3">
<a class="navbar-brand" href="#">Navbar</a>
<ul class="nav nav-pills">
<li class="nav-item">
<a class="nav-link" href="#scrollspyHeading1">First</a>
</li>
<li class="nav-item">
<a class="nav-link" href="#scrollspyHeading2">Second</a>
</li>
<li class="nav-item dropdown">
<a class="nav-link dropdown-toggle" data-bs-toggle="dropdown" href="#" role="button" aria-expanded="false">Dropdown</a>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#scrollspyHeading3">Third</a></li>
<li><a class="dropdown-item" href="#scrollspyHeading4">Fourth</a></li>
<li><hr class="dropdown-divider"></li>
<li><a class="dropdown-item" href="#scrollspyHeading5">Fifth</a></li>
</ul>
</li>
</ul>
</nav>
<div data-bs-spy="scroll" data-bs-target="#navbar-example2" data-bs-root-margin="0px 0px -40%" data-bs-smooth-scroll="true" class="scrollspy-example bg-light p-3 rounded-2" tabindex="0">
<h4 id="scrollspyHeading1">First heading</h4>
<p>...</p>
<h4 id="scrollspyHeading2">Second heading</h4>
<p>...</p>
<h4 id="scrollspyHeading3">Third heading</h4>
<p>...</p>
<h4 id="scrollspyHeading4">Fourth heading</h4>
<p>...</p>
<h4 id="scrollspyHeading5">Fifth heading</h4>
<p>...</p>
</div>
การนำทางที่ซ้อนกัน
Scrollspy ยังใช้งานได้กับ nested .nav
s ถ้าซ้อนกัน.nav
อยู่.active
ผู้ปกครองก็จะ.active
เป็น เลื่อนพื้นที่ถัดจากแถบนำทางและดูการเปลี่ยนแปลงชั้นเรียนที่ใช้งานอยู่
รายการที่ 1
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
โปรดทราบว่าปลั๊กอิน JavaScript พยายามเลือกองค์ประกอบที่เหมาะสมจากองค์ประกอบทั้งหมดที่อาจมองเห็นได้ เป้าหมาย scrollspy ที่มองเห็นได้หลายรายการพร้อมกันอาจทำให้เกิดปัญหาบางอย่าง
รายการ 1-1
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
โปรดทราบว่าปลั๊กอิน JavaScript พยายามเลือกองค์ประกอบที่เหมาะสมจากองค์ประกอบทั้งหมดที่อาจมองเห็นได้ เป้าหมาย scrollspy ที่มองเห็นได้หลายรายการพร้อมกันอาจทำให้เกิดปัญหาบางอย่าง
ข้อ 1-2
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
โปรดทราบว่าปลั๊กอิน JavaScript พยายามเลือกองค์ประกอบที่เหมาะสมจากองค์ประกอบทั้งหมดที่อาจมองเห็นได้ เป้าหมาย scrollspy ที่มองเห็นได้หลายรายการพร้อมกันอาจทำให้เกิดปัญหาบางอย่าง
รายการที่ 2
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
โปรดทราบว่าปลั๊กอิน JavaScript พยายามเลือกองค์ประกอบที่เหมาะสมจากองค์ประกอบทั้งหมดที่อาจมองเห็นได้ เป้าหมาย scrollspy ที่มองเห็นได้หลายรายการพร้อมกันอาจทำให้เกิดปัญหาบางอย่าง
รายการที่ 3
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
โปรดทราบว่าปลั๊กอิน JavaScript พยายามเลือกองค์ประกอบที่เหมาะสมจากองค์ประกอบทั้งหมดที่อาจมองเห็นได้ เป้าหมาย scrollspy ที่มองเห็นได้หลายรายการพร้อมกันอาจทำให้เกิดปัญหาบางอย่าง
ข้อ 3-1
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
โปรดทราบว่าปลั๊กอิน JavaScript พยายามเลือกองค์ประกอบที่เหมาะสมจากองค์ประกอบทั้งหมดที่อาจมองเห็นได้ เป้าหมาย scrollspy ที่มองเห็นได้หลายรายการพร้อมกันอาจทำให้เกิดปัญหาบางอย่าง
ข้อ 3-2
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
โปรดทราบว่าปลั๊กอิน JavaScript พยายามเลือกองค์ประกอบที่เหมาะสมจากองค์ประกอบทั้งหมดที่อาจมองเห็นได้ เป้าหมาย scrollspy ที่มองเห็นได้หลายรายการพร้อมกันอาจทำให้เกิดปัญหาบางอย่าง
<div class="row">
<div class="col-4">
<nav id="navbar-example3" class="h-100 flex-column align-items-stretch pe-4 border-end">
<nav class="nav nav-pills flex-column">
<a class="nav-link" href="#item-1">Item 1</a>
<nav class="nav nav-pills flex-column">
<a class="nav-link ms-3 my-1" href="#item-1-1">Item 1-1</a>
<a class="nav-link ms-3 my-1" href="#item-1-2">Item 1-2</a>
</nav>
<a class="nav-link" href="#item-2">Item 2</a>
<a class="nav-link" href="#item-3">Item 3</a>
<nav class="nav nav-pills flex-column">
<a class="nav-link ms-3 my-1" href="#item-3-1">Item 3-1</a>
<a class="nav-link ms-3 my-1" href="#item-3-2">Item 3-2</a>
</nav>
</nav>
</nav>
</div>
<div class="col-8">
<div data-bs-spy="scroll" data-bs-target="#navbar-example3" data-bs-smooth-scroll="true" class="scrollspy-example-2" tabindex="0">
<div id="item-1">
<h4>Item 1</h4>
<p>...</p>
</div>
<div id="item-1-1">
<h5>Item 1-1</h5>
<p>...</p>
</div>
<div id="item-1-2">
<h5>Item 1-2</h5>
<p>...</p>
</div>
<div id="item-2">
<h4>Item 2</h4>
<p>...</p>
</div>
<div id="item-3">
<h4>Item 3</h4>
<p>...</p>
</div>
<div id="item-3-1">
<h5>Item 3-1</h5>
<p>...</p>
</div>
<div id="item-3-2">
<h5>Item 3-2</h5>
<p>...</p>
</div>
</div>
</div>
</div>
รายการกลุ่ม
Scrollspy ยังใช้งานได้กับ.list-group
s เลื่อนพื้นที่ถัดจากกลุ่มรายการและดูการเปลี่ยนแปลงชั้นเรียนที่ใช้งานอยู่
รายการที่ 1
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
รายการที่ 2
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
รายการที่ 3
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
รายการที่ 4
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
<div class="row">
<div class="col-4">
<div id="list-example" class="list-group">
<a class="list-group-item list-group-item-action" href="#list-item-1">Item 1</a>
<a class="list-group-item list-group-item-action" href="#list-item-2">Item 2</a>
<a class="list-group-item list-group-item-action" href="#list-item-3">Item 3</a>
<a class="list-group-item list-group-item-action" href="#list-item-4">Item 4</a>
</div>
</div>
<div class="col-8">
<div data-bs-spy="scroll" data-bs-target="#list-example" data-bs-smooth-scroll="true" class="scrollspy-example" tabindex="0">
<h4 id="list-item-1">Item 1</h4>
<p>...</p>
<h4 id="list-item-2">Item 2</h4>
<p>...</p>
<h4 id="list-item-3">Item 3</h4>
<p>...</p>
<h4 id="list-item-4">Item 4</h4>
<p>...</p>
</div>
</div>
</div>
สมอง่าย
Scrollspy ไม่ได้จำกัดเฉพาะส่วนประกอบการนำทางและกลุ่มรายการ ดังนั้นมันจะทำงานกับ<a>
องค์ประกอบจุดยึดในเอกสารปัจจุบัน เลื่อนพื้นที่และดูการ.active
เปลี่ยนแปลงชั้นเรียน
รายการที่ 1
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
รายการที่ 2
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
รายการที่ 3
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
รายการที่ 4
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
รายการที่ 5
นี่คือเนื้อหาตัวยึดตำแหน่งบางส่วนสำหรับหน้า scrollspy โปรดทราบว่าเมื่อคุณเลื่อนหน้าลง ลิงก์การนำทางที่เหมาะสมจะถูกเน้น มีการทำซ้ำตลอดตัวอย่างส่วนประกอบ เรายังคงเพิ่มสำเนาตัวอย่างเพิ่มเติมที่นี่เพื่อเน้นการเลื่อนและการเน้น
<div class="row">
<div class="col-4">
<div id="simple-list-example" class="d-flex flex-column gap-2 simple-list-example-scrollspy text-center">
<a class="p-1 rounded" href="#simple-list-item-1">Item 1</a>
<a class="p-1 rounded" href="#simple-list-item-2">Item 2</a>
<a class="p-1 rounded" href="#simple-list-item-3">Item 3</a>
<a class="p-1 rounded" href="#simple-list-item-4">Item 4</a>
<a class="p-1 rounded" href="#simple-list-item-5">Item 5</a>
</div>
</div>
<div class="col-8">
<div data-bs-spy="scroll" data-bs-target="#simple-list-example" data-bs-offset="0" data-bs-smooth-scroll="true" class="scrollspy-example" tabindex="0">
<h4 id="simple-list-item-1">Item 1</h4>
<p>...</p>
<h4 id="simple-list-item-2">Item 2</h4>
<p>...</p>
<h4 id="simple-list-item-3">Item 3</h4>
<p>...</p>
<h4 id="simple-list-item-4">Item 4</h4>
<p>...</p>
<h4 id="simple-list-item-5">Item 5</h4>
<p>...</p>
</div>
</div>
</div>
องค์ประกอบที่มองไม่เห็น
องค์ประกอบเป้าหมายที่ไม่สามารถมองเห็นได้จะถูกละเว้นและรายการนำทางที่เกี่ยวข้องจะไม่ได้รับ.active
คลาส อินสแตนซ์ Scrollspy ที่เริ่มต้นใน Wrapper ที่มองไม่เห็นจะละเว้นองค์ประกอบเป้าหมายทั้งหมด ใช้refresh
วิธีการนี้เพื่อตรวจสอบองค์ประกอบที่สังเกตได้เมื่อมองเห็นเสื้อคลุม
document.querySelectorAll('#nav-tab>[data-bs-toggle="tab"]').forEach(el => {
el.addEventListener('shown.bs.tab', () => {
const target = el.getAttribute('data-bs-target')
const scrollElem = document.querySelector(`${target} [data-bs-spy="scroll"]`)
bootstrap.ScrollSpy.getOrCreateInstance(scrollElem).refresh()
})
})
การใช้งาน
ผ่านแอตทริบิวต์ข้อมูล
หากต้องการเพิ่มลักษณะการทำงานของ scrollspy ให้กับการนำทางบนแถบด้านบนของคุณอย่างง่ายดาย ให้เพิ่มdata-bs-spy="scroll"
องค์ประกอบที่คุณต้องการสอดแนม (โดยทั่วไปแล้วจะเป็น<body>
) จากนั้นเพิ่มdata-bs-target
แอตทริบิวต์ด้วยid
ชื่อหรือคลาสขององค์ประกอบหลักขององค์ประกอบ.nav
Bootstrap
<body data-bs-spy="scroll" data-bs-target="#navbar-example">
...
<div id="navbar-example">
<ul class="nav nav-tabs" role="tablist">
...
</ul>
</div>
...
</body>
ผ่านจาวาสคริปต์
const scrollSpy = new bootstrap.ScrollSpy(document.body, {
target: '#navbar-example'
})
ตัวเลือก
เนื่องจากตัวเลือกสามารถส่งผ่านแอตทริบิวต์ข้อมูลหรือ JavaScript คุณจึงเพิ่มชื่อตัวเลือกต่อท้ายได้ เช่น เดียวdata-bs-
กับใน data-bs-animation="{value}"
ตรวจสอบให้แน่ใจว่าได้เปลี่ยนประเภทเคสของชื่อตัวเลือกจาก “ camelCase ” เป็น “ kebab-case ” เมื่อส่งตัวเลือกผ่านแอตทริบิวต์ data เช่น ใช้data-bs-custom-class="beautifier"
แทนdata-bs-customClass="beautifier"
.
ใน Bootstrap 5.2.0 ส่วนประกอบทั้งหมดสนับสนุนแอตทริบิวต์ข้อมูลที่สงวนไว้สำหรับทดลองdata-bs-config
ซึ่งสามารถจัดเก็บการกำหนดค่าส่วนประกอบอย่างง่ายเป็นสตริง JSON เมื่อองค์ประกอบมีdata-bs-config='{"delay":0, "title":123}'
และdata-bs-title="456"
แอตทริบิวต์ ค่าสุดท้ายtitle
จะเป็น456
และแอตทริบิวต์ข้อมูลที่แยกจากกันจะแทนที่ค่าที่ให้ไว้data-bs-config
ใน นอกจากนี้ แอตทริบิวต์ข้อมูลที่มีอยู่ยังสามารถเก็บค่า JSON เช่นdata-bs-delay='{"show":0,"hide":150}'
.
ชื่อ | พิมพ์ | ค่าเริ่มต้น | คำอธิบาย |
---|---|---|---|
rootMargin |
สตริง | 0px 0px -25% |
Intersection Observer rootMarginหน่วยที่ถูกต้อง เมื่อคำนวณตำแหน่งการเลื่อน |
smoothScroll |
บูลีน | false |
เปิดใช้งานการเลื่อนอย่างราบรื่นเมื่อผู้ใช้คลิกที่ลิงก์ที่อ้างถึงสิ่งที่สังเกตได้ของ ScrollSpy |
target |
สตริง องค์ประกอบ DOM | null |
ระบุองค์ประกอบที่จะใช้ปลั๊กอิน Scrollspy |
threshold |
อาร์เรย์ | [0.1, 0.5, 1] |
IntersectionObserver อินพุตที่ถูกต้อง ตามเกณฑ์เมื่อคำนวณตำแหน่งการเลื่อน |
ตัวเลือกที่เลิกใช้
จนถึง v5.1.3 เราใช้offset
& method
options ซึ่งตอนนี้เลิกใช้แล้วและแทนที่ด้วยrootMargin
. เพื่อรักษาความเข้ากันได้แบบย้อนหลัง เราจะยังคงแยกวิเคราะห์ที่กำหนดให้offset
กับrootMargin
แต่คุณลักษณะนี้จะถูกลบออกในv6
วิธีการ
วิธี | คำอธิบาย |
---|---|
dispose |
ทำลาย scrollspy ขององค์ประกอบ (ลบข้อมูลที่เก็บไว้ในองค์ประกอบ DOM) |
getInstance |
เมธอด แบบคงที่เพื่อรับอินสแตนซ์ scrollspy ที่เชื่อมโยงกับองค์ประกอบ DOM |
getOrCreateInstance |
วิธี คงที่เพื่อรับอินสแตนซ์ scrollspy ที่เชื่อมโยงกับองค์ประกอบ DOM หรือสร้างใหม่ในกรณีที่ไม่ได้เริ่มต้น |
refresh |
เมื่อเพิ่มหรือลบองค์ประกอบใน DOM คุณจะต้องเรียกวิธีการรีเฟรช |
นี่คือตัวอย่างโดยใช้วิธีการรีเฟรช:
const dataSpyList = document.querySelectorAll('[data-bs-spy="scroll"]')
dataSpyList.forEach(dataSpyEl => {
bootstrap.ScrollSpy.getInstance(dataSpyEl).refresh()
})
เหตุการณ์
เหตุการณ์ | คำอธิบาย |
---|---|
activate.bs.scrollspy |
เหตุการณ์นี้จะเริ่มทำงานกับองค์ประกอบการเลื่อนทุกครั้งที่มีการเปิดใช้งานจุดยึดโดย scrollspy |
const firstScrollSpyEl = document.querySelector('[data-bs-spy="scroll"]')
firstScrollSpyEl.addEventListener('activate.bs.scrollspy', () => {
// do something...
})