Step

From Documentation
Revision as of 13:14, 7 January 2022 by Hawk (talk | contribs) ((via JWB))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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 width="800px">
        <step title="Custom Step icon" iconSclass="z-icon-star-o"/>
        <step title="Custom Error" error="true" iconSclass="z-icon-bug"/>
        <step title="Custom Complete" iconSclass="z-icon-home"/>
    </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 : 2022/01/07


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



Last Update : 2022/01/07

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