@progress/kendo-vue-indicators
Version:
78 lines (77 loc) • 2.83 kB
TypeScript
/**
* @license
*-------------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the package root for more information
*-------------------------------------------------------------------------------------------
*/
/**
* Represents the props of the [Kendo Ui for Vue Skeleton component]({% slug overview_skeleton %}).
*/
export interface SkeletonProps {
/**
* Specifies the animation settings of the Skeleton.
*
* The possible keys are:
* * `type`—Defines the type of the Skeleton animation.
* * `wave`—Shows wave animation effect.
* * `pulse`(Default)—Shows pulse animation effect.
*
* To disable the animation, set the property to `false`.
*
*/
animation?: boolean | SkeletonAnimation;
/**
* Specifies the shape of the Skeleton.
*
* The possible values are:
* * `circle`—Renders a circular Skeleton.
* * `text`(Default)—Renders a line Skeleton.
* * `rectangle`—Renders a rectangular Skeleton.
*
*/
shape?: SkeletonShape | string;
/**
* Specifies the ariaBusy attribute of the Skeleton.
*
* The Skeleton component does not have accessibility on its own as it is only a visual indicator.
* It should be integrated within an element that refers to the loading state.
* When integrating the Skeleton on a page, you might want to define an `ariaBusy` attribute and
* this property gives you this option.
*
* By default the `ariaBusy` attribute is not rendered.
*/
ariaBusy?: boolean | undefined;
/**
* Specifies the role attribute of the Skeleton.
*
* The Skeleton component does not have accessibility on its own as it is only a visual indicator.
* It should be integrated within an element that refers to the loading state.
* When integrating the Skeleton on a page, you might want to define a `role` attribute and
* this property gives you this option.
*
* By default the `role` attribute is not rendered.
*
* The recommended value of the attribute is `alert`
*/
role?: string | undefined;
}
/**
* Specifies the shape of the Skeleton.
*
* The possible values are:
* * `circle`—Renders a circular Skeleton.
* * `text`(Default)—Renders a line Skeleton.
* * `rectangle`—Renders a rectangular Skeleton.
*
*/
export type SkeletonShape = 'circle' | 'text' | 'rectangle';
/**
* Specifies the animation settings of the Skeleton.
*/
export interface SkeletonAnimation {
/**
* Specifies the type of the Skeleton animation. Defaults to `pulse`.
*/
type?: 'wave' | 'pulse';
}