Step"

From Documentation
Line 29: Line 29:
  
 
== Complete ==
 
== Complete ==
Whether this step is complete.
+
Whether this step is completed.
 
(Default: false)
 
(Default: false)
  

Revision as of 03:27, 19 November 2019

Step

  • Demonstration:
  • Java API: Step
  • JavaScript API: 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 in visual.

IconSclass

Set the icon sclass to change the icon of step.

By applying this property, the icon of complete and error visual style will be changed accordingly.

Step-iconsclass.png

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

Title

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

Supported Events

Name
Event Type
none

none

Supported Children

* None

Use Cases

Version Description Example Location
     

Version History

Last Update : 2019/11/19


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



Last Update : 2019/11/19

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