轮播幻灯片
用于循环浏览元素(图像或文本幻灯片)的幻灯片组件,如旋转木马。
怎么运行的
-
旋转木马是一个幻灯片,用于循环浏览一系列内容,使用 CSS 3D 转换和一些 JavaScript 构建。它适用于一系列图像、文本或自定义标记。它还包括对上一个/下一个控件和指示器的支持。
-
出于性能原因,轮播必须使用轮播构造方法手动初始化。如果没有初始化,一些事件侦听器(具体来说,需要触摸/滑动支持的事件)将不会被注册,直到用户明确激活控件或指示器。
唯一的例外是具有该属性的自动播放轮播
data-bs-ride="carousel"
,因为它们会在页面加载时自动初始化。如果您使用带有数据属性的自动播放轮播,请不要使用构造函数方法显式初始化相同的轮播。 -
不支持嵌套轮播。您还应该意识到,轮播通常会导致可用性和可访问性方面的挑战。
prefers-reduced-motion
媒体查询。请参阅我们的辅助功能文档的减少运动部分。
基本示例
这是一个包含三张幻灯片的旋转木马的基本示例。注意上一个/下一个控件。我们建议使用<button>
元素,但您也可以将<a>
元素与role="button"
.
<div id="carouselExample" class="carousel slide">
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
<button class="carousel-control-prev" type="button" data-bs-target="#carouselExample" data-bs-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-bs-target="#carouselExample" data-bs-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
轮播不会自动标准化幻灯片尺寸。因此,您可能需要使用其他实用程序或自定义样式来适当调整内容的大小。虽然轮播支持上一个/下一个控件和指示器,但它们并不是明确要求的。根据需要添加和自定义。
您必须将.active
课程添加到其中一张幻灯片,否则轮播将不可见。还要确保为可选控件设置唯一id
性.carousel
,尤其是当您在单个页面上使用多个轮播时。控件和指示器元素必须具有与元素的 匹配的data-bs-target
属性(或href
链接)。id
.carousel
指标
您可以将指示器添加到轮播中,以及上一个/下一个控件。这些指示器让用户可以直接跳转到特定的幻灯片。
<div id="carouselExampleIndicators" class="carousel slide">
<div class="carousel-indicators">
<button type="button" data-bs-target="#carouselExampleIndicators" data-bs-slide-to="0" class="active" aria-current="true" aria-label="Slide 1"></button>
<button type="button" data-bs-target="#carouselExampleIndicators" data-bs-slide-to="1" aria-label="Slide 2"></button>
<button type="button" data-bs-target="#carouselExampleIndicators" data-bs-slide-to="2" aria-label="Slide 3"></button>
</div>
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
<button class="carousel-control-prev" type="button" data-bs-target="#carouselExampleIndicators" data-bs-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-bs-target="#carouselExampleIndicators" data-bs-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
字幕
.carousel-caption
您可以使用any 中的元素向幻灯片添加字幕.carousel-item
。它们可以很容易地隐藏在较小的视口中,如下所示,使用可选的显示实用程序。我们最初使用 隐藏它们,.d-none
然后使用 将它们带回中型设备.d-md-block
。
<div id="carouselExampleCaptions" class="carousel slide">
<div class="carousel-indicators">
<button type="button" data-bs-target="#carouselExampleCaptions" data-bs-slide-to="0" class="active" aria-current="true" aria-label="Slide 1"></button>
<button type="button" data-bs-target="#carouselExampleCaptions" data-bs-slide-to="1" aria-label="Slide 2"></button>
<button type="button" data-bs-target="#carouselExampleCaptions" data-bs-slide-to="2" aria-label="Slide 3"></button>
</div>
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
<div class="carousel-caption d-none d-md-block">
<h5>First slide label</h5>
<p>Some representative placeholder content for the first slide.</p>
</div>
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
<div class="carousel-caption d-none d-md-block">
<h5>Second slide label</h5>
<p>Some representative placeholder content for the second slide.</p>
</div>
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
<div class="carousel-caption d-none d-md-block">
<h5>Third slide label</h5>
<p>Some representative placeholder content for the third slide.</p>
</div>
</div>
</div>
<button class="carousel-control-prev" type="button" data-bs-target="#carouselExampleCaptions" data-bs-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-bs-target="#carouselExampleCaptions" data-bs-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
淡入淡出
添加.carousel-fade
到您的轮播以使用淡入淡出过渡而不是幻灯片来制作幻灯片动画。根据您的轮播内容(例如,纯文本幻灯片),您可能希望向 s 添加.bg-body
或一些自定义 CSS 以.carousel-item
实现适当的淡入淡出。
<div id="carouselExampleFade" class="carousel slide carousel-fade">
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
<button class="carousel-control-prev" type="button" data-bs-target="#carouselExampleFade" data-bs-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-bs-target="#carouselExampleFade" data-bs-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
自动播放轮播
您可以通过将ride
选项设置为 使轮播在页面加载时自动播放carousel
。自动播放轮播会在鼠标悬停时自动暂停。可以使用该pause
选项控制此行为。在支持Page Visibility API的浏览器中,当网页对用户不可见时(例如浏览器选项卡处于非活动状态或浏览器窗口最小化时),轮播将停止循环。
出于可访问性原因,我们建议避免使用自动播放轮播。如果您的页面确实包含自动播放轮播,我们建议提供额外的按钮或控件以明确暂停/停止轮播。
<div id="carouselExampleAutoplaying" class="carousel slide" data-bs-ride="carousel">
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
<button class="carousel-control-prev" type="button" data-bs-target="#carouselExampleAutoplaying" data-bs-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-bs-target="#carouselExampleAutoplaying" data-bs-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
当该ride
选项设置为true
, 而不是carousel
时,轮播不会在页面加载时自动开始循环。相反,它只会在第一次用户交互后启动。
<div id="carouselExampleRide" class="carousel slide" data-bs-ride="true">
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
<button class="carousel-control-prev" type="button" data-bs-target="#carouselExampleRide" data-bs-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-bs-target="#carouselExampleRide" data-bs-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
个人.carousel-item
间隔
添加data-bs-interval=""
到 a.carousel-item
以更改自动循环到下一个项目之间的延迟时间量。
<div id="carouselExampleInterval" class="carousel slide" data-bs-ride="carousel">
<div class="carousel-inner">
<div class="carousel-item active" data-bs-interval="10000">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item" data-bs-interval="2000">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
<button class="carousel-control-prev" type="button" data-bs-target="#carouselExampleInterval" data-bs-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-bs-target="#carouselExampleInterval" data-bs-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
没有控件的自动播放轮播
这是一个只有幻灯片的旋转木马。.d-block
请注意旋转木马图像上的和的存在,.w-100
以防止浏览器默认图像对齐。
<div id="carouselExampleSlidesOnly" class="carousel slide" data-bs-ride="carousel">
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
</div>
禁用触摸滑动
轮播支持在触摸屏设备上向左/向右滑动以在幻灯片之间移动。这可以通过将touch
选项设置为来禁用false
。
<div id="carouselExampleControlsNoTouching" class="carousel slide" data-bs-touch="false">
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
<button class="carousel-control-prev" type="button" data-bs-target="#carouselExampleControlsNoTouching" data-bs-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-bs-target="#carouselExampleControlsNoTouching" data-bs-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
暗变种
在 v5.3.0 中弃用添加.carousel-dark
到.carousel
较暗的控件、指示器和标题。filter
与使用CSS 属性的默认白色填充相比,控件是倒置的。字幕和控件有额外的 Sass 变量来自定义color
和background-color
。
小心!随着颜色模式的引入,组件的深色变体在 v5.3.0 中被弃用。不是在根元素、父包装器或组件本身上
添加.carousel-dark
,而是设置。data-bs-theme="dark"
<div id="carouselExampleDark" class="carousel carousel-dark slide">
<div class="carousel-indicators">
<button type="button" data-bs-target="#carouselExampleDark" data-bs-slide-to="0" class="active" aria-current="true" aria-label="Slide 1"></button>
<button type="button" data-bs-target="#carouselExampleDark" data-bs-slide-to="1" aria-label="Slide 2"></button>
<button type="button" data-bs-target="#carouselExampleDark" data-bs-slide-to="2" aria-label="Slide 3"></button>
</div>
<div class="carousel-inner">
<div class="carousel-item active" data-bs-interval="10000">
<img src="..." class="d-block w-100" alt="...">
<div class="carousel-caption d-none d-md-block">
<h5>First slide label</h5>
<p>Some representative placeholder content for the first slide.</p>
</div>
</div>
<div class="carousel-item" data-bs-interval="2000">
<img src="..." class="d-block w-100" alt="...">
<div class="carousel-caption d-none d-md-block">
<h5>Second slide label</h5>
<p>Some representative placeholder content for the second slide.</p>
</div>
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
<div class="carousel-caption d-none d-md-block">
<h5>Third slide label</h5>
<p>Some representative placeholder content for the third slide.</p>
</div>
</div>
</div>
<button class="carousel-control-prev" type="button" data-bs-target="#carouselExampleDark" data-bs-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-bs-target="#carouselExampleDark" data-bs-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
自定义过渡
如果您使用的是编译后的 CSS,则可以在编译前.carousel-item
使用 Sass 变量或自定义样式更改过渡持续时间。$carousel-transition-duration
如果应用了多个过渡,请确保首先定义变换过渡(例如transition: transform 2s ease, opacity .5s ease-out
)。
萨斯
变量
所有轮播的变量:
$carousel-control-color: $white;
$carousel-control-width: 15%;
$carousel-control-opacity: .5;
$carousel-control-hover-opacity: .9;
$carousel-control-transition: opacity .15s ease;
$carousel-indicator-width: 30px;
$carousel-indicator-height: 3px;
$carousel-indicator-hit-area-height: 10px;
$carousel-indicator-spacer: 3px;
$carousel-indicator-opacity: .5;
$carousel-indicator-active-bg: $white;
$carousel-indicator-active-opacity: 1;
$carousel-indicator-transition: opacity .6s ease;
$carousel-caption-width: 70%;
$carousel-caption-color: $white;
$carousel-caption-padding-y: 1.25rem;
$carousel-caption-spacer: 1.25rem;
$carousel-control-icon-width: 2rem;
$carousel-control-prev-icon-bg: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='#{$carousel-control-color}'><path d='M11.354 1.646a.5.5 0 0 1 0 .708L5.707 8l5.647 5.646a.5.5 0 0 1-.708.708l-6-6a.5.5 0 0 1 0-.708l6-6a.5.5 0 0 1 .708 0z'/></svg>");
$carousel-control-next-icon-bg: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='#{$carousel-control-color}'><path d='M4.646 1.646a.5.5 0 0 1 .708 0l6 6a.5.5 0 0 1 0 .708l-6 6a.5.5 0 0 1-.708-.708L10.293 8 4.646 2.354a.5.5 0 0 1 0-.708z'/></svg>");
$carousel-transition-duration: .6s;
$carousel-transition: transform $carousel-transition-duration ease-in-out; // Define transform transition first if using multiple transitions (e.g., `transform 2s ease, opacity .5s ease-out`)
深色旋转木马的变量:
$carousel-dark-indicator-active-bg: $black;
$carousel-dark-caption-color: $black;
$carousel-dark-control-icon-filter: invert(1) grayscale(100);
用法
通过数据属性
使用数据属性轻松控制轮播的位置。data-bs-slide
接受关键字prev
or next
,它会改变幻灯片相对于当前位置的位置。或者,使用data-bs-slide-to
将原始幻灯片索引传递给 carousel data-bs-slide-to="2"
,这会将幻灯片位置移动到以 开头的特定索引0
。
通过 JavaScript
手动调用轮播:
const carousel = new bootstrap.Carousel('#myCarousel')
选项
由于可以通过数据属性或 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 字符串进行存储。当元素具有data-bs-config='{"delay":0, "title":123}'
和data-bs-title="456"
属性时,最终title
值将是456
并且单独的数据属性将覆盖 上给出的值data-bs-config
。此外,现有的数据属性能够容纳 JSON 值,例如data-bs-delay='{"show":0,"hide":150}'
.
名称 | 类型 | 默认 | 描述 |
---|---|---|---|
interval |
数字 | 5000 |
自动循环项目之间延迟的时间量。 |
keyboard |
布尔值 | true |
轮播是否应对键盘事件做出反应。 |
pause |
字符串,布尔值 | "hover" |
如果设置为"hover" ,则在 上暂停旋转木马的mouseenter 循环并在 上恢复旋转木马的循环mouseleave 。如果设置为false ,将鼠标悬停在轮播图上不会暂停它。在启用触摸的设备上,当设置为 时"hover" ,循环将暂停touchend (一旦用户完成与轮播的交互)两个间隔,然后自动恢复。这是鼠标行为的补充。 |
ride |
字符串,布尔值 | false |
如果设置为true ,则在用户手动循环第一个项目后自动播放轮播。如果设置为"carousel" ,则在加载时自动播放轮播。 |
touch |
布尔值 | true |
旋转木马是否应支持触摸屏设备上的左/右滑动交互。 |
wrap |
布尔值 | true |
轮播是否应连续循环或硬停止。 |
方法
您可以使用 carousel 构造函数创建一个 carousel 实例,并传递任何其他选项。例如,要以特定间隔手动初始化自动播放轮播(假设您没有使用data-bs-ride="carousel"
标记本身的属性)并禁用触摸支持,您可以使用:
const myCarouselElement = document.querySelector('#myCarousel')
const carousel = new bootstrap.Carousel(myCarouselElement, {
interval: 2000,
touch: false
})
方法 | 描述 |
---|---|
cycle |
开始从左到右循环浏览轮播项目。 |
dispose |
销毁元素的旋转木马。(删除存储在 DOM 元素上的数据) |
getInstance |
允许您获取与 DOM 元素关联的轮播实例的静态方法。你可以像这样使用它bootstrap.Carousel.getInstance(element) : |
getOrCreateInstance |
返回与 DOM 元素关联的轮播实例的静态方法,或者在未初始化的情况下创建一个新轮播实例。你可以像这样使用它bootstrap.Carousel.getOrCreateInstance(element) : |
next |
循环到下一个项目。在显示下一个项目之前返回给调用者(例如,在slid.bs.carousel 事件发生之前)。 |
nextWhenVisible |
当页面、轮播或轮播的父级不可见时,不要将轮播循环到下一个。在显示目标项之前返回给调用者。 |
pause |
阻止旋转木马循环浏览项目。 |
prev |
循环到上一个项目。在显示上一个项目之前(例如,在slid.bs.carousel 事件发生之前)返回给调用者。 |
to |
将轮播循环到特定帧(基于 0,类似于数组)。在显示目标项之前(例如,在slid.bs.carousel 事件发生之前)返回给调用者。 |
事件
Bootstrap 的 carousel 类公开了两个用于连接到 carousel 功能的事件。这两个事件都具有以下附加属性:
direction
: 旋转木马滑动的方向(或者"left"
或"right"
)。relatedTarget
:作为活动项滑入适当位置的 DOM 元素。from
: 当前项目的索引to
: 下一项的索引
所有轮播事件都在轮播本身(即在<div class="carousel">
)上触发。
事件类型 | 描述 |
---|---|
slid.bs.carousel |
当轮播完成其幻灯片过渡时触发。 |
slide.bs.carousel |
slide 调用实例方法时立即触发。 |
const myCarousel = document.getElementById('myCarousel')
myCarousel.addEventListener('slide.bs.carousel', event => {
// do something...
})