Carousel走马灯
- 何时使用
- 代码演示
- API
  - 单独引入此组件
  - nz-carouselcomponent
    - 方法

Carousel走马灯

旋转木马，一组轮播的区域。

何时使用

当有一组平级的内容。
当内容空间不足时，可以用走马灯的形式进行收纳，进行轮播展现。
常用于一组图片或卡片轮播。

代码演示

Carousel走马灯 - 图1

基本

最简单的用法。

import { Component } from '@angular/core';
@Component({
  selector: 'nz-demo-carousel-basic',
  template: `
    <nz-carousel [nzEffect]="effect">
      <div nz-carousel-content *ngFor="let index of array">
        <h3>{{ index }}</h3>
      </div>
    </nz-carousel>
  `,
  styles: [
    `
      [nz-carousel-content] {
        text-align: center;
        height: 160px;
        line-height: 160px;
        background: #364d79;
        color: #fff;
        overflow: hidden;
      }
      h3 {
        color: #fff;
      }
    `
  ]
})
export class NzDemoCarouselBasicComponent {
  array = [1, 2, 3, 4];
  effect = 'scrollx';
}

Carousel走马灯 - 图2

渐显

切换效果为渐显。

import { Component } from '@angular/core';
@Component({
  selector: 'nz-demo-carousel-fade',
  template: `
    <nz-carousel [nzEffect]="'fade'">
      <div nz-carousel-content *ngFor="let index of array">
        <h3>{{ index }}</h3>
      </div>
    </nz-carousel>
  `,
  styles: [
    `
      [nz-carousel-content] {
        text-align: center;
        height: 160px;
        line-height: 160px;
        background: #364d79;
        color: #fff;
        overflow: hidden;
      }
      h3 {
        color: #fff;
      }
    `
  ]
})
export class NzDemoCarouselFadeComponent {
  array = [1, 2, 3, 4];
}

Carousel走马灯 - 图3

垂直

垂直显示。

import { Component } from '@angular/core';
@Component({
  selector: 'nz-demo-carousel-vertical',
  template: `
    <nz-carousel nzVertical>
      <div nz-carousel-content *ngFor="let index of array">
        <h3>{{ index }}</h3>
      </div>
    </nz-carousel>
  `,
  styles: [
    `
      [nz-carousel-content] {
        text-align: center;
        height: 160px;
        line-height: 160px;
        background: #364d79;
        color: #fff;
        overflow: hidden;
      }
      h3 {
        color: #fff;
      }
    `
  ]
})
export class NzDemoCarouselVerticalComponent {
  array = [1, 2, 3];
}

Carousel走马灯 - 图4

自动切换

定时切换下一张。

import { Component } from '@angular/core';
@Component({
  selector: 'nz-demo-carousel-autoplay',
  template: `
    <nz-carousel nzAutoPlay>
      <div nz-carousel-content *ngFor="let index of array">
        <h3>{{ index }}</h3>
      </div>
    </nz-carousel>
  `,
  styles: [
    `
      [nz-carousel-content] {
        text-align: center;
        height: 160px;
        line-height: 160px;
        background: #364d79;
        color: #fff;
        overflow: hidden;
      }
      h3 {
        color: #fff;
      }
    `
  ]
})
export class NzDemoCarouselAutoplayComponent {
  array = [1, 2, 3, 4];
}

API

单独引入此组件

想要了解更多关于单独引入组件的内容，可以在快速上手页面进行查看。

import { NzCarouselModule } from 'ng-zorro-antd';

nz-carouselcomponent

参数	说明	类型	默认值
`[nzAutoPlay]`	是否自动切换	`boolean`	`false`
`[nzAutoPlaySpeed]`	切换时间(毫秒)，当设置为0时不切换	`number`	`3000`
`[nzDots]`	是否显示面板指示点	`boolean`	`true`
`[nzDotRender]`	Dot渲染模板	`TemplateRef<{ $implicit: number }>`	-
`[nzEffect]`	动画效果函数，可取 scrollx, fade	`'scrollx'｜'fade'`	`'scrollx'`
`[nzVertical]`	垂直显示	`boolean`	`false`
`(nzAfterChange)`	切换面板的回调	`EventEmitter<number>`	-
`(nzBeforeChange)`	切换面板的回调	`EventEmitter<{ from: number; to: number }>`	-
`[nzEnableSwipe]`	是否支持手势划动切换	`boolean`	`true`

方法

名称	描述
goTo(slideNumber)	切换到指定面板
next()	切换到下一面板
pre()	切换到上一面板