primevue-mirror/components/lib/skeleton/Skeleton.d.ts

136 lines
3.3 KiB
TypeScript
Raw Normal View History

2023-03-01 14:13:01 +00:00
/**
*
* Skeleton is a placeholder to display instead of the actual content.
*
* [Live Demo](https://www.primevue.org/skeleton/)
*
* @module skeleton
*
*/
2023-07-06 11:17:08 +00:00
import { ComponentHooks } from '../basecomponent';
2023-09-05 08:50:46 +00:00
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PTOptions } from '../ts-helpers';
2022-09-06 12:03:37 +00:00
export declare type SkeletonPassThroughOptionType = SkeletonPassThroughAttributes | ((options: SkeletonPassThroughMethodOptions) => SkeletonPassThroughAttributes | string) | string | null | undefined;
2023-04-24 09:43:33 +00:00
/**
* Custom passthrough(pt) option method.
*/
export interface SkeletonPassThroughMethodOptions {
/**
* Defines instance.
*/
2023-07-06 12:01:33 +00:00
instance: any;
/**
* Defines valid properties.
*/
2023-04-24 09:43:33 +00:00
props: SkeletonProps;
2023-09-05 08:50:46 +00:00
/**
* Defines passthrough(pt) options in global config.
*/
global: object | undefined;
2023-04-24 09:43:33 +00:00
}
/**
* Custom passthrough(pt) options.
* @see {@link SkeletonProps.pt}
*/
export interface SkeletonPassThroughOptions {
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to the root's DOM element.
2023-04-24 09:43:33 +00:00
*/
root?: SkeletonPassThroughOptionType;
2023-07-06 11:09:01 +00:00
/**
2023-08-01 14:01:12 +00:00
* Used to manage all lifecycle hooks
2023-07-06 11:09:01 +00:00
* @see {@link BaseComponent.ComponentHooks}
*/
hooks?: ComponentHooks;
2023-04-24 09:43:33 +00:00
}
/**
* Custom passthrough attributes for each DOM elements
*/
export interface SkeletonPassThroughAttributes {
[key: string]: any;
}
2023-03-01 14:13:01 +00:00
/**
* Defines valid properties in Skeleton component.
*/
2022-09-06 12:03:37 +00:00
export interface SkeletonProps {
/**
* Shape of the element.
2023-03-08 10:51:52 +00:00
* @defaultValue rectangle
2022-09-06 12:03:37 +00:00
*/
2023-03-01 14:13:01 +00:00
shape?: 'rectangle' | 'circle' | undefined;
2022-09-06 12:03:37 +00:00
/**
* Size of the Circle or Square.
*/
size?: string | undefined;
/**
* Width of the element.
2023-03-08 10:51:52 +00:00
* @defaultValue 100%
2022-09-06 12:03:37 +00:00
*/
width?: string | undefined;
/**
* Height of the element.
2023-03-08 10:51:52 +00:00
* @defaultValue 1rem
2022-09-06 12:03:37 +00:00
*/
height?: string | undefined;
/**
* Border radius of the element, defaults to value from theme.
*/
borderRadius?: string | undefined;
/**
* Type of the animation.
2023-03-08 10:51:52 +00:00
* @defaultValue wave
2022-09-06 12:03:37 +00:00
*/
2023-03-01 14:13:01 +00:00
animation?: 'wave' | 'none' | undefined;
2023-04-24 09:43:33 +00:00
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to DOM elements inside the component.
2023-04-24 09:43:33 +00:00
* @type {SkeletonPassThroughOptions}
*/
pt?: PTOptions<SkeletonPassThroughOptions>;
2023-09-05 08:50:46 +00:00
/**
* Used to configure passthrough(pt) options of the component.
* @type {PassThroughOptions}
*/
ptOptions?: PassThroughOptions;
2023-05-24 10:36:51 +00:00
/**
* When enabled, it removes component related styles in the core.
* @defaultValue false
*/
unstyled?: boolean;
2022-09-06 12:03:37 +00:00
}
2023-03-01 14:13:01 +00:00
/**
* Defines valid slots in Skeleton component.
*/
2022-09-14 11:26:01 +00:00
export interface SkeletonSlots {}
2022-09-06 12:03:37 +00:00
2023-03-01 14:13:01 +00:00
/**
* Defines valid emits in Skeleton component.
*/
export interface SkeletonEmits {}
2022-09-06 12:03:37 +00:00
2023-03-01 14:13:01 +00:00
/**
* **PrimeVue - Skeleton**
*
* _Skeleton is a placeholder to display instead of the actual content._
*
* [Live Demo](https://www.primevue.org/skeleton/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*/
2022-09-14 11:26:01 +00:00
declare class Skeleton extends ClassComponent<SkeletonProps, SkeletonSlots, SkeletonEmits> {}
2022-09-06 12:03:37 +00:00
declare module '@vue/runtime-core' {
interface GlobalComponents {
2022-09-14 11:26:01 +00:00
Skeleton: GlobalComponentConstructor<Skeleton>;
2022-09-06 12:03:37 +00:00
}
}
export default Skeleton;