Stepbar"

From Documentation
Line 7: Line 7:
 
*JavaScript API: <javadoc directory="jsdoc">zkmax.wgt.Stepbar</javadoc>
 
*JavaScript API: <javadoc directory="jsdoc">zkmax.wgt.Stepbar</javadoc>
 
{{ZK EE}}
 
{{ZK EE}}
[ since 9.0.0 ]
+
{{versionSince| 9.0.0}}
  
 
= Employment/Purpose =
 
= Employment/Purpose =

Revision as of 03:46, 4 February 2021

Stepbar

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

Since 9.0.0

Employment/Purpose

Stepbar is a navigation component suitable for displaying the progress of a multi-step task.

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>

Supported Browsers

It is compatible with browsers that fully supports CSS flexbox model, like IE 11, Edge, Firefox, Opera, Chrome and Safari.

IE10 is not supported as it only partially supports flexbox.

Properties

ActiveIndex

The index of the active step. (Default: 0)

ActiveStep

The active step object. (Default: first step)

Linear

Set whether the steps in this stepbar are displayed in order.

Non-linear means users can toggle the active steps easily by clicking on any step even if the step is not the next one in the sequence. In linear mode, they can only activate in order.

Stepbar-linear.gif

Model

The step model associated with this stepbar.

An existing ListModelList can be wrapped into a DefaultStepModel for Stepbar to use.

StepRenderer

The renderer used to render each step.

Implement yourown StepRenderer to handle how data renders to a Step object.

WrappedLabels

Set whether the labels in children steps are wrapped. (Default: false)

true: Stepber-WrappedLabels.png

false: Stepbar-example.png

Supported Events

Name
Event Type
onChange
Event: Event

Represents an event caused by a user's selection changed at the client.

Supported Children

* Step

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.