primevue-mirror/components/divider/Divider.d.ts

66 lines
1.5 KiB
TypeScript
Raw Normal View History

2023-02-28 15:50:01 +00:00
/**
*
* Divider is used to separate contents.
*
2023-03-02 09:22:22 +00:00
* [Live Demo](https://primevue.org/divider)
2023-02-28 15:50:01 +00:00
*
* @module divider
*
*/
2022-09-06 12:03:37 +00:00
import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
2023-02-28 15:50:01 +00:00
/**
* Defines valid properties in Divider component.
*/
2022-09-06 12:03:37 +00:00
export interface DividerProps {
/**
* Alignment of the content, options are 'left', 'center', 'right' for horizontal layout and 'top', 'center', 'bottom' for vertical.
*/
2023-02-28 15:50:01 +00:00
align?: 'left' | 'center' | 'right' | 'top' | 'center' | 'bottom' | undefined;
2022-09-06 12:03:37 +00:00
/**
* Specifies the orientation, valid values are 'horizontal' and 'vertical'.
2023-02-28 15:50:01 +00:00
* @defaultValue horizontal
2022-09-06 12:03:37 +00:00
*/
2023-02-28 15:50:01 +00:00
layout?: 'horizontal' | 'vertical' | undefined;
2022-09-06 12:03:37 +00:00
/**
* Border style type.
2023-02-28 15:50:01 +00:00
* @defaultValue solid
2022-09-06 12:03:37 +00:00
*/
2023-02-28 15:50:01 +00:00
type?: 'solid' | 'dashed' | 'dotted' | undefined;
2022-09-06 12:03:37 +00:00
}
2023-02-28 15:50:01 +00:00
/**
* Defines valid slots in Divider slots.
*/
2022-09-06 12:03:37 +00:00
export interface DividerSlots {
/**
* Default content slot.
*/
2023-02-28 15:50:01 +00:00
default(): VNode[];
2022-09-06 12:03:37 +00:00
}
2023-02-28 15:50:01 +00:00
export interface DividerEmits {}
2022-09-06 12:03:37 +00:00
2023-02-28 15:50:01 +00:00
/**
* **PrimeVue - Divider**
*
* _Divider is used to separate contents._
*
2023-03-02 09:22:22 +00:00
* [Live Demo](https://primevue.org/divider)
2023-02-28 15:50:01 +00:00
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg)
*
* @group Component
*
*/
2023-03-01 12:30:54 +00:00
declare class Divider extends ClassComponent<DividerProps, DividerSlots, DividerEmits> {}
2022-09-06 12:03:37 +00:00
declare module '@vue/runtime-core' {
interface GlobalComponents {
2022-09-14 11:26:01 +00:00
Divider: GlobalComponentConstructor<Divider>;
2022-09-06 12:03:37 +00:00
}
}
export default Divider;