@progress/kendo-vue-layout 2.6.3 → 2.6.4

package/dist/es/stepper/Stepper.js

@@ -0,0 +1,351 @@
+// @ts-ignore
+import * as Vue from 'vue';
+var allVue = Vue;
+var gh = allVue.h;
+import { focusFirstFocusableChild, Keys } from '@progress/kendo-vue-common';
+import { Step } from './Step';
+import { ProgressBar } from '@progress/kendo-vue-progressbars';
+import { DEFAULT_ANIMATION_DURATION, NO_ANIMATION } from './contants';
+import { validatePackage, isRtl, templateRendering, getListeners, getTemplate } from '@progress/kendo-vue-common';
+import { packageMetadata } from '../package-metadata'; // tslint:enable:max-line-length
+
+var Stepper = {
+  name: 'KendoStepper',
+  props: {
+    animationDuration: {
+      type: [Boolean, Number],
+      default: 400
+    },
+    dir: String,
+    disabled: Boolean,
+    item: {
+      type: [String, Object, Function, Boolean],
+      default: undefined
+    },
+    items: Array,
+    linear: Boolean,
+    mode: {
+      type: String,
+      default: 'steps',
+      validator: function validator(value) {
+        return ['steps', 'labels'].includes(value);
+      }
+    },
+    orientation: {
+      type: String,
+      default: 'horizontal',
+      validator: function validator(value) {
+        return ['horizontal', 'vertical'].includes(value);
+      }
+    },
+    value: {
+      type: Number,
+      required: true,
+      default: 0
+    },
+    successIcon: String,
+    errorIcon: String
+  },
+  created: function created() {
+    validatePackage(packageMetadata);
+    this.focusedIdx = this.$props.value;
+  },
+  mounted: function mounted() {
+    this.currentDir = this.$props.dir !== undefined ? this.$props.dir : isRtl(this.$el) ? 'rtl' : 'ltr';
+  },
+  data: function data() {
+    return {
+      currentDir: 'ltr',
+      focusedIdx: 0,
+      stepper: {}
+    };
+  },
+  computed: {
+    isVertical: function isVertical() {
+      return this.$props.orientation === 'vertical';
+    },
+    numOfSteps: function numOfSteps() {
+      var items = this.$props.items;
+      return items ? items.length : 0;
+    },
+    stepperClasses: function stepperClasses() {
+      return {
+        'k-stepper': true,
+        'k-stepper-linear': this.$props.linear
+      };
+    },
+    stepperStyles: function stepperStyles() {
+      return {
+        display: 'grid',
+        gridTemplateColumns: !this.isVertical ? 'repeat(' + this.numOfSteps * 2 + ', 1fr)' : undefined,
+        gridTemplateRows: this.isVertical ? 'repeat(' + this.numOfSteps * 4 + ', 1fr)' : undefined
+      };
+    },
+    listClasses: function listClasses() {
+      return {
+        'k-step-list': true,
+        'k-step-list-horizontal': !this.isVertical,
+        'k-step-list-vertical': this.isVertical
+      };
+    },
+    listStyles: function listStyles() {
+      return {
+        gridColumnStart: !this.isVertical ? 1 : undefined,
+        gridColumnEnd: !this.isVertical ? -1 : undefined,
+        gridRowStart: this.isVertical ? 1 : undefined,
+        gridRowEnd: this.isVertical ? -1 : undefined
+      };
+    },
+    progressbarStyles: function progressbarStyles() {
+      return {
+        gridColumnStart: !this.isVertical ? 2 : undefined,
+        gridColumnEnd: !this.isVertical ? this.numOfSteps * 2 : undefined,
+        gridRowStart: this.isVertical ? 2 : undefined,
+        gridRowEnd: this.isVertical ? this.numOfSteps * 4 - 2 : undefined
+      };
+    }
+  },
+  // @ts-ignore
+  setup: !gh ? undefined : function () {
+    var v3 = !!gh;
+    return {
+      v3: v3
+    };
+  },
+  // @ts-ignore
+  render: function render(createElement) {
+    var h = gh || createElement;
+    var _a = this.$props,
+        animationDuration = _a.animationDuration,
+        children = _a.children,
+        disabled = _a.disabled,
+        items = _a.items,
+        orientation = _a.orientation;
+    var value = this.$props.value;
+    var animation = typeof animationDuration === 'number' ? animationDuration : animationDuration !== false ? DEFAULT_ANIMATION_DURATION : NO_ANIMATION;
+    var steps = items && items.map(function (element, index) {
+      var step = this.$props.item ? templateRendering.call(this, this.$props.item, getListeners.call(this)) : undefined;
+      var stepDefaultRendering = // @ts-ignore
+      h(Step, {
+        key: index,
+        index: index,
+        attrs: this.v3 ? undefined : {
+          index: index,
+          disabled: disabled || element.disabled,
+          focused: index === this.focusedIdx,
+          current: index === value,
+          icon: element.icon,
+          label: element.label,
+          optional: element.optional,
+          text: element.text,
+          isValid: element.isValid,
+          tabIndex: element.tabIndex,
+          animationDuration: this.animationDuration,
+          isVertical: this.isVertical,
+          item: this.item,
+          linear: this.linear,
+          mode: this.mode,
+          numOfSteps: this.numOfSteps,
+          value: this.value,
+          successIcon: this.successIcon,
+          errorIcon: this.errorIcon
+        },
+        disabled: disabled || element.disabled,
+        focused: index === this.focusedIdx,
+        current: index === value,
+        onChange: this.handleChange,
+        on: this.v3 ? undefined : {
+          "change": this.handleChange,
+          "focus": this.handleFocus
+        },
+        onFocus: this.handleFocus,
+        "class": element.class,
+        style: element.style,
+        icon: element.icon,
+        label: element.label,
+        optional: element.optional,
+        text: element.text,
+        isValid: element.isValid,
+        tabIndex: element.tabIndex,
+        animationDuration: this.animationDuration,
+        isVertical: this.isVertical,
+        item: this.item,
+        linear: this.linear,
+        mode: this.mode,
+        numOfSteps: this.numOfSteps,
+        value: this.value,
+        successIcon: this.successIcon,
+        errorIcon: this.errorIcon
+      });
+      var stepRendering = getTemplate.call(this, {
+        h: h,
+        template: step,
+        defaultRendering: stepDefaultRendering,
+        additionalProps: element,
+        additionalListeners: {
+          change: this.handleChange,
+          focus: this.handleFocus
+        }
+      });
+      return stepRendering;
+    }, this);
+    return h("nav", {
+      "class": this.stepperClasses,
+      style: this.stepperStyles,
+      dir: this.currentDir,
+      attrs: this.v3 ? undefined : {
+        dir: this.currentDir
+      },
+      onKeydown: this.handleKeyDown,
+      on: this.v3 ? undefined : {
+        "keydown": this.handleKeyDown
+      }
+    }, [h("ol", {
+      "class": this.listClasses,
+      style: this.listStyles
+    }, [steps ? steps : children]), // @ts-ignore
+    h(ProgressBar, {
+      style: this.progressbarStyles,
+      animation: {
+        duration: animation
+      },
+      attrs: this.v3 ? undefined : {
+        animation: {
+          duration: animation
+        },
+        "aria-hidden": true,
+        max: this.numOfSteps - 1,
+        labelVisible: false,
+        orientation: orientation,
+        reverse: orientation === 'vertical',
+        value: value,
+        disabled: disabled,
+        tabIndex: -1
+      },
+      "aria-hidden": true,
+      max: this.numOfSteps - 1,
+      labelVisible: false,
+      orientation: orientation,
+      reverse: orientation === 'vertical',
+      value: value,
+      disabled: disabled,
+      tabIndex: -1
+    })]);
+  },
+  methods: {
+    focus: function focus() {
+      if (this.$el) {
+        focusFirstFocusableChild(this.$el);
+      }
+    },
+    dispatchChangeEvent: function dispatchChangeEvent(event, val) {
+      var prevIdx = val === this.value - 1;
+      var currIdx = val === this.value;
+      var nextIdx = val === this.value + 1;
+      var allowClick = !this.linear || prevIdx || currIdx || nextIdx;
+
+      if (this.value !== val && !this.disabled && allowClick) {
+        this.focusedIdx = val;
+        this.$emit('change', {
+          event: event,
+          value: val
+        });
+      }
+    },
+    handleChange: function handleChange(event) {
+      var currentValue = event.value;
+      this.dispatchChangeEvent(event, currentValue);
+    },
+    handleFocus: function handleFocus(event) {
+      if (!this.disabled) {
+        this.$emit('focus', event, undefined);
+      }
+    },
+    handleEnter: function handleEnter(event) {
+      this.dispatchChangeEvent(event, this.focusedIdx);
+    },
+    handleKeyDown: function handleKeyDown(event) {
+      var isCurrentRtl = this.currentDir === 'rtl';
+      var currIndex = this.focusedIdx;
+      var maxNavIndex = this.items.length - 1;
+
+      switch (event.keyCode) {
+        case Keys.left:
+          event.preventDefault();
+
+          if (!isCurrentRtl && currIndex > 0) {
+            this.focusedIdx = currIndex - 1;
+          }
+
+          if (isCurrentRtl && currIndex < maxNavIndex) {
+            this.focusedIdx = currIndex + 1;
+          }
+
+          break;
+
+        case Keys.right:
+          event.preventDefault();
+
+          if (!isCurrentRtl && currIndex < maxNavIndex) {
+            this.focusedIdx = currIndex + 1;
+          }
+
+          if (isCurrentRtl && currIndex > 0) {
+            this.focusedIdx = currIndex - 1;
+          }
+
+          break;
+
+        case Keys.up:
+          event.preventDefault();
+
+          if (!isCurrentRtl && currIndex > 0) {
+            this.focusedIdx = currIndex - 1;
+          }
+
+          if (isCurrentRtl && currIndex > 0) {
+            this.focusedIdx = currIndex - 1;
+          }
+
+          break;
+
+        case Keys.down:
+          event.preventDefault();
+
+          if (!isCurrentRtl && currIndex < maxNavIndex) {
+            this.focusedIdx = currIndex + 1;
+          }
+
+          if (isCurrentRtl && currIndex < maxNavIndex) {
+            this.focusedIdx = currIndex + 1;
+          }
+
+          break;
+
+        case Keys.home:
+          event.preventDefault();
+          this.focusedIdx = 0;
+          break;
+
+        case Keys.end:
+          event.preventDefault();
+          this.focusedIdx = maxNavIndex;
+          break;
+
+        case Keys.space:
+        case Keys.enter:
+          event.preventDefault();
+
+          if (!this.items[currIndex].disabled) {
+            this.handleEnter(event);
+          }
+
+          break;
+
+        default:
+      }
+    }
+  }
+};
+var StepperVue3 = Stepper;
+export { Stepper, StepperVue3 };

package/dist/es/stepper/contants.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @hidden
+ */
+export declare const DEFAULT_ANIMATION_DURATION = 400;
+/**
+ * @hidden
+ */
+export declare const NO_ANIMATION = 0;

package/dist/es/stepper/contants.js

@@ -0,0 +1,8 @@
+/**
+ * @hidden
+ */
+export var DEFAULT_ANIMATION_DURATION = 400;
+/**
+ * @hidden
+ */
+export var NO_ANIMATION = 0;

package/dist/es/stepper/context/StepperContext.d.ts

@@ -0,0 +1,16 @@
+import { StepChangeEvent } from '../interfaces/StepChangeEvent';
+import { StepFocusEvent } from '../interfaces/StepFocusEvent';
+/** @hidden */
+export declare type StepperContextType = {
+    animationDuration?: number | boolean;
+    isVertical?: boolean;
+    item?: any;
+    linear?: boolean;
+    mode?: 'steps' | 'labels';
+    numOfSteps?: number;
+    value: number;
+    successIcon?: string;
+    errorIcon?: string;
+    onChange?: (event: StepChangeEvent) => void;
+    onFocus?: (event: StepFocusEvent) => void;
+};

package/dist/es/stepper/context/StepperContext.js

@@ -0,0 +1,8 @@
+/**
+ * @hidden
+ */
+var defaultContext = {
+    linear: false,
+    mode: 'steps',
+    value: 0
+};

package/dist/es/stepper/interfaces/StepChangeEvent.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The arguments for the `onChange` Step event.
+ */
+export interface StepChangeEvent {
+    /**
+     * The index of the selected Step.
+     */
+    value: number;
+}

package/dist/es/stepper/interfaces/StepFocusEvent.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The arguments for the `onFocus` Step event.
+ */
+export interface StepFocusEvent {
+}

package/dist/es/stepper/interfaces/StepHandle.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The Step ref.
+ */
+export interface StepHandle {
+    /**
+     * The Step element.
+     */
+    element: HTMLLIElement | null;
+    /**
+     * Focus the Step.
+     */
+    focus: () => void;
+}

package/dist/es/stepper/interfaces/StepHandle.js

@@ -0,0 +1,3 @@
+/**
+ * The Step ref.
+ */

package/dist/es/stepper/interfaces/StepProps.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Represents the props of the [Kendo UI for Vue Step component]({% slug overview_stepper %}).
+ */
+export interface StepProps {
+    /**
+     * Represents the children that are passed to the Step.
+     */
+    children?: any;
+    /**
+     * Specifies a list of CSS classes that will be added to the Step element.
+     */
+    className?: string;
+    /**
+     * Represents the content that will be rendered inside each Step.
+     *
+     * @hidden
+     */
+    content?: any;
+    /**
+     * Specifies the current Step.
+     */
+    current?: boolean;
+    /**
+     * Sets a custom property.
+     */
+    [customProp: string]: any;
+    /**
+     * Specifies if the Step is disabled
+     * ([see example]({% slug display_modes_stepper %})).
+     */
+    disabled?: boolean;
+    /**
+     * Defines the name for an existing icon in a Kendo UI for Vue theme.
+     * The icon is rendered inside the Step indicator by a `span.k-icon` element
+     * ([see example]({% slug display_modes_stepper %})).
+     */
+    icon?: string;
+    /**
+     * Sets the index of the Step that is used to identify it.
+     */
+    index?: number;
+    /**
+     * Specifies the validity of the step
+     * ([see example]({% slug display_modes_stepper %})).
+     */
+    isValid?: boolean;
+    /**
+     * Specifies the label of the Step
+     * ([see example]({% slug display_modes_stepper %})).
+     */
+    label?: string;
+    /**
+     * Specifies if the step is optional. The validation is not applied to these steps
+     * ([see example]({% slug display_modes_stepper %})).
+     */
+    optional?: boolean;
+    /**
+     * Sets the `tabIndex` property of the Step.
+     * Defaults to `0`.
+     */
+    tabIndex?: number;
+    /**
+     * Specifies the text content of the Step indicator
+     * ([see example]({% slug display_modes_stepper %})).
+     */
+    text?: string;
+}

package/dist/es/stepper/interfaces/StepperChangeEvent.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The arguments for the `onChange` Stepper event.
+ */
+export interface StepperChangeEvent {
+    /**
+     * The index of the selected Step.
+     */
+    value: number;
+}

package/dist/es/stepper/interfaces/StepperFocusEvent.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The arguments for the `onFocus` Stepper event.
+ */
+export interface StepperFocusEvent {
+}

package/dist/es/stepper/interfaces/StepperHandle.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The Stepper ref.
+ */
+export interface StepperHandle {
+    /**
+     * The Stepper element.
+     */
+    element: HTMLMenuElement | null;
+    /**
+     * Focus the Stepper's first focusable child.
+     */
+    focus: () => void;
+}

package/dist/es/stepper/interfaces/StepperHandle.js

@@ -0,0 +1,3 @@
+/**
+ * The Stepper ref.
+ */

package/dist/es/stepper/interfaces/StepperOnNavigateEvent.d.ts

@@ -0,0 +1,23 @@
+import { StepperHandle } from './../interfaces/StepperHandle';
+/**
+ * The `StepperOnNavigateEvent` event.
+ */
+export declare class StepperOnNavigateEvent {
+    /**
+     * The Stepper component.
+     */
+    target: StepperHandle;
+    event: any;
+    /**
+     * The previous index of the Step.
+     */
+    prevIndex: number;
+    /**
+     * The new index of the Step.
+     */
+    nextIndex: number;
+    /**
+     * @hidden
+     */
+    constructor(target: StepperHandle, prevIndex: number, nextIndex: number);
+}

package/dist/es/stepper/interfaces/StepperOnNavigateEvent.js

@@ -0,0 +1,15 @@
+/**
+ * The `StepperOnNavigateEvent` event.
+ */
+var StepperOnNavigateEvent = /** @class */ (function () {
+    /**
+     * @hidden
+     */
+    function StepperOnNavigateEvent(target, prevIndex, nextIndex) {
+        this.target = target;
+        this.prevIndex = prevIndex;
+        this.nextIndex = nextIndex;
+    }
+    return StepperOnNavigateEvent;
+}());
+export { StepperOnNavigateEvent };

package/dist/es/stepper/interfaces/StepperProps.d.ts

@@ -0,0 +1,80 @@
+import { StepProps } from './StepProps';
+import { StepperChangeEvent } from './StepperChangeEvent';
+import { StepperFocusEvent } from './StepperFocusEvent';
+/**
+ * Represents the props of the [Kendo UI for Vue Stepper component]({% slug overview_stepper %}).
+ */
+export interface StepperProps {
+    /**
+     * Sets the duration of the Stepper animation. Defaults to `400ms`.
+     */
+    animationDuration?: boolean | number;
+    /**
+     * Represents the children that are passed to the Stepper.
+     */
+    children?: any;
+    /**
+     * Specifies a list of CSS classes that will be added to the Stepper.
+     */
+    className?: string;
+    /**
+     * Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
+     */
+    dir?: string;
+    /**
+     * Disables the whole Stepper.
+     */
+    disabled?: boolean;
+    /**
+     * Specifies a custom icon that will be rendered inside the step for invalid steps.
+     */
+    errorIcon?: string;
+    /**
+     * Overrides the default component responsible for visualizing a single item ([see example]({% slug custom_rendering_stepper %})).
+     *
+     * The default Component is: [Step]({% slug api_layout_step %}).
+     */
+    item?: any;
+    /**
+     * The collection of steps that will be rendered in the Stepper ([see example]({% slug overview_stepper %})).
+     */
+    items: Array<StepProps>;
+    /**
+     * Specifies the linear flow of the Stepper.
+     * ([see example]({% slug linear_mode_stepper %})).
+     */
+    linear?: boolean;
+    /**
+     * Specifies the display mode of the Stepper
+     * ([see example]({% slug display_modes_stepper %})).
+     * * The possible values are:
+     * * (Default) `steps`. Render step indicator and optional label.
+     * * `labels`. Render labels only.
+     */
+    mode?: 'steps' | 'labels' | string;
+    /**
+     * Specifies the orientation of the Stepper
+     * ([see example]({% slug orientation_stepper %})).
+     *
+     * The possible values are:
+     * * (Default) `horizontal`
+     * * `vertical`
+     */
+    orientation?: 'horizontal' | 'vertical' | string;
+    /**
+     * Specifies a custom icon that will be rendered inside the step for valid steps.
+     */
+    successIcon?: string;
+    /**
+     * Specifies the index of the selected Step.
+     */
+    value: number;
+    /**
+     * The event handler that will be fired when the value is changed.
+     */
+    onChange?: (event: StepperChangeEvent) => void;
+    /**
+     * The event handler that will be fired when a Step is focused.
+     */
+    onFocus?: (event: StepperFocusEvent) => void;
+}

package/dist/es/stepper/messages/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @hidden
+ */
+export declare const optionalText = "stepper.optionalText";
+/**
+ * @hidden
+ */
+export declare const messages: {
+    "stepper.optionalText": string;
+};