\Kendo\UI\Stepper

A PHP wrapper for Kendo UI Stepper.

Inherits from \Kendo\UI\Widget.

Usage

To use Stepper in a PHP page instantiate a new instance, configure it via the available configuration methods and output it by echo-ing the result of the render method.

Using Kendo Stepper

<?php
// Create a new instance of Stepper and specify its id
$stepper = new \Kendo\UI\Stepper('Stepper');

// Configure it
$stepper->indicator(true)

// Output it

echo $stepper->render();
?>

Methods

activate

Fires when a new Step has been selected upon user interaction. For additional information check the activate event documentation.

Returns

\Kendo\UI\Stepper

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$stepper = new \Kendo\UI\Stepper('Stepper');
$stepper->activate('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onActivate(e) {
        // handle the activate event.
    }
</script>
<?php
$stepper = new \Kendo\UI\Stepper('Stepper');
$stepper->activate('onActivate');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$stepper = new \Kendo\UI\Stepper('Stepper');
$stepper->activate(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

indicator

Indicates whether the Steps in the Stepper will render their indicator element (the icon or number placed in a circle above the Step label).

Returns

\Kendo\UI\Stepper

Parameters

$value boolean

Example

<?php
$stepper = new \Kendo\UI\Stepper('Stepper');
$stepper->indicator(true);
?>

label

Indicates whether the Steps in the Stepper will render their label element (the text placed below the Step indicator circle).

Returns

\Kendo\UI\Stepper

Parameters

$value boolean

Example

<?php
$stepper = new \Kendo\UI\Stepper('Stepper');
$stepper->label(true);
?>

linear

Indicates whether the Stepper will force the user to follow the Steps sequence or not. If set to "false" it will allow the user to select any step. If in its default state ("true") the user will be able to select the step immediately after the currently selected step or the previous step.

Returns

\Kendo\UI\Stepper

Parameters

$value boolean

Example

<?php
$stepper = new \Kendo\UI\Stepper('Stepper');
$stepper->linear(true);
?>

orientation

The type of the Stepper orientation (horizontal or vertical).

Returns

\Kendo\UI\Stepper

Parameters

$value string

Example

<?php
$stepper = new \Kendo\UI\Stepper('Stepper');
$stepper->orientation('value');
?>

select

Fires when the user clicks on a Step to select it. For additional information check the select event documentation.

Returns

\Kendo\UI\Stepper

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$stepper = new \Kendo\UI\Stepper('Stepper');
$stepper->select('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onSelect(e) {
        // handle the select event.
    }
</script>
<?php
$stepper = new \Kendo\UI\Stepper('Stepper');
$stepper->select('onSelect');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$stepper = new \Kendo\UI\Stepper('Stepper');
$stepper->select(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

selectOnFocus

Applicable for scenarios when keyboard is used for navigation. Indicates whether the selection will change upon focus change or it will require additional action (Enter or Spacebar key press) in order to select the focused step.

Returns

\Kendo\UI\Stepper

Parameters

$value boolean

Example

<?php
$stepper = new \Kendo\UI\Stepper('Stepper');
$stepper->selectOnFocus(true);
?>

addStep

Adds one or more StepperStep to the Stepper.

Returns

\Kendo\UI\Stepper

Parameters

$value[, $value2, ...] \Kendo\UI\StepperStep|array

Example - using \Kendo\UI\StepperStep

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

Example - using array

<?php
$stepper = new \Kendo\UI\Stepper('Stepper');
$enabled = true;
$stepper->addStep(array('enabled' => $enabled));
?>

Example - adding more than one StepperStep

<?php
$stepper = new \Kendo\UI\Stepper('Stepper');
$first  = new \Kendo\UI\StepperStep();
$second = new \Kendo\UI\StepperStep();
$stepper->addStep($first, $second);
?>