\Kendo\UI\StepperStep

A PHP class representing the step setting of StepperSteps.

Methods

enabled

Defines whether the Step is enabled or not. By default all steps are enabled.

Returns

\Kendo\UI\StepperStep

Parameters

$value boolean

Example

<?php
$step = new \Kendo\UI\StepperStep();
$step->enabled(true);
?>

error

Defines whether the Step is in error state (is invalid). By default all steps are valid.

Returns

\Kendo\UI\StepperStep

Parameters

$value boolean

Example

<?php
$step = new \Kendo\UI\StepperStep();
$step->error(true);
?>

icon

Defines a name of an existing icon in the Kendo UI theme sprite. The icon will be displayed in the indicator element of that Step. For a list of available icon names, please refer to the Web Font Icons article.

Returns

\Kendo\UI\StepperStep

Parameters

$value string

Example

<?php
$step = new \Kendo\UI\StepperStep();
$step->icon('value');
?>

iconTemplate

The template used to render the icon in the indicator of the step.The fields which can be used in the template are: label String - the label set on the step; icon String - the icon specified for this step (if any); successIcon String - the successIcon specified for this step (if any); enabled Boolean - indicates whether the step is enabled (true) or disabled (false); error Boolean - indicates whether the step has error (true) or not (false); selected Boolean - indicates whether the step is selected; previous Boolean - indicates whether the step is before the currently selected or not; index Number - a zero-based index of the current step; isFirstStep Boolean - indicates whether the step is the initial one in the Stepper; isLastStep Boolean - indicates whether the step is the last one in the Stepper; indicatorVisible Boolean - indicates whether the indicator, which holds the icon should be displayed or not or labelVisible Boolean - indicates whether the label section of the step should be displayed or not.

Returns

\Kendo\UI\StepperStep

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$step = new \Kendo\UI\StepperStep();
$step->iconTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$step = new \Kendo\UI\StepperStep();
$step->iconTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

label

Defines the label (text) of the Step.

Returns

\Kendo\UI\StepperStep

Parameters

$value string

Example

<?php
$step = new \Kendo\UI\StepperStep();
$step->label('value');
?>

selected

Defines whether the Step is selected.

Returns

\Kendo\UI\StepperStep

Parameters

$value boolean

Example

<?php
$step = new \Kendo\UI\StepperStep();
$step->selected(true);
?>

successIcon

Defines a name of an existing icon in the Kendo UI theme sprite. The icon will be displayed in the indicator element of that Step, when the step is a previous one and it does not have an error. For a list of available icon names, please refer to the Web Font Icons article.

Returns

\Kendo\UI\StepperStep

Parameters

$value string

Example

<?php
$step = new \Kendo\UI\StepperStep();
$step->successIcon('value');
?>