Step"

From Documentation
Line 3: Line 3:
 
= Step =
 
= Step =
  
*Demonstration:  
+
*Demonstration: [https://www.zkoss.org/zkdemo/menu/stepbar| Step]
 
*Java API: <javadoc>org.zkoss.zkmax.zul.Step</javadoc>
 
*Java API: <javadoc>org.zkoss.zkmax.zul.Step</javadoc>
 
*JavaScript API: <javadoc directory="jsdoc">zkmax.wgt.Step</javadoc>
 
*JavaScript API: <javadoc directory="jsdoc">zkmax.wgt.Step</javadoc>

Revision as of 04:47, 4 February 2021

Step

  • Available for ZK:
  • http://www.zkoss.org/product/zkhttp://www.zkoss.org/whyzk/zkeeVersion ee.png

Since 9.0.0

Employment/Purpose

A step is used for displaying user navigation, it should be placed inside a Stepbar and shouldn't be used without a Stepbar.

Example

Stepbar-example.png

<zk>
    <stepbar linear="false" activeIndex="2" width="600px">
        <step title="First Step" iconSclass="z-icon-home"/>
        <step title="Second Step" complete="true" />
        <step title="Third Step" error="true" />
    </stepbar>
</zk>

Properties

Complete

Whether this step is completed. (Default: false)

The default visual style: Step-complete-default.png

Error

Whether this step is in error. (Default: false)

The default visual style: Step-error-default.png

The priority of error is higher than complete. If both properties are set, the result will be an error state visually.

IconSclass

Set the icon CSS class to apply a custom icon.

If you set this property, it will override the complete and error icons accordingly.

Step-iconsclass.png

<stepbar>
    <step title="Default Error" error="true"/>
    <step title="Custom Error" error="true" iconSclass="z-icon-bug"/>
</stepbar>

Please read ZK_Component_Reference/Base_Components/LabelImageElement#IconSclass to know more available build-in icons.

Title

Set the title (label) of each step. (Default: empty)

Supported Events

Name
Event Type
none

none

Supported Children

* None

Use Cases

Version Description Example Location
     

Version History

Last Update : 2021/02/04


Version Date Content
9.0.0 November, 2019 ZK-4375: Provide a stepbar component



Last Update : 2021/02/04

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.