index.en-US.md

category	Components
type	Navigation
cols	1
title	Steps
cover	https://gw.alipayobjects.com/zos/antfincdn/UZYqMizXHaj/Steps.svg
description	A navigation bar that guides users through the steps of a task.

When To Use

When a given task is complicated or has a certain sequence in the series of subtasks, we can decompose it into several steps to make things easier.

API

<nz-steps>
  <nz-step nzTitle="first step"></nz-step>
  <nz-step nzTitle="second step"></nz-step>
  <nz-step nzTitle="third step"></nz-step>
</nz-steps>

nz-steps

The whole of the step bar.

Property	Description	Type	Default
[nzType]	type of steps, can be set to one of the following values: default, navigation	'default' | 'navigation'	'default'
[nzCurrent]	To set the current step, counting from 0. You can overwrite this state by using nzStatus of nz-step	number	0
[nzDirection]	To specify the direction of the step bar, horizontal and vertical are currently supported	'vertical' | 'horizontal'	'horizontal'
[nzLabelPlacement]	Support vertical title and description	'vertical' | 'horizontal'	'horizontal'
[nzProgressDot]	Steps with progress dot style, customize the progress dot by setting it with TemplateRef	boolean | TemplateRef<{ $implicit: TemplateRef<void>, status: string, index: number }>	false
[nzSize]	To specify the size of the step bar, default and small are currently supported	'small' | 'default'	'default'
[nzStatus]	To specify the status of current step, can be set to one of the following values: wait process finish error	'wait' | 'process' | 'finish' | 'error'	'process'
[nzStartIndex]	To specify the starting number	number	0
(nzIndexChange)	Trigger event when step click	number	-

nz-step

A single step in the step bar.

Property	Description	Type	Default
[nzDescription]	description of the step, optional property	string | TemplateRef<void>	-
[nzIcon]	icon of the step, optional property	string | string[] | Set<string> | { [klass: string]: any; } | TemplateRef<void>	-
[nzStatus]	to specify the status. It will be automatically set by nzCurrent of nz-steps if not configured. Optional values are: wait process finish error	'wait' | 'process' | 'finish' | 'error'	'wait'
[nzTitle]	title of the step (optional). When omitted, only the description is shown and it renders below the horizontal line	string | TemplateRef<void>	-
[nzSubtitle]	subTitle of the step	string | TemplateRef<void>	-
[nzDisabled]	disable click	boolean	false
[nzPercentage]	Progress percentage of the step in process status (only works on basic Steps)	number	-