vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Divider d.ts updated

pull/3689/head
Bahadır Sofuoğlu 2023-02-28 18:50:01 +03:00
parent ed1ae7595f
commit 115d9b0a78
2 changed files with 121 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
components/divider/Divider.d.ts vendored
View File

@ -1,46 +1,60 @@
/**
*
* Divider is used to separate contents.
*
* [Live Demo](https://www.primefaces.org/primevue/divider)
*
* @module divider
*
*/
import { VNode } from 'vue'; import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
type DividerHorizontalAlignType = 'left' | 'center' | 'right' | undefined; /**
* Defines valid properties in Divider component.
type DividerVerticalAlignType = 'top' | 'center' | 'bottom' | undefined; */
type DividerAlignType = DividerHorizontalAlignType | DividerVerticalAlignType | undefined;
type DividerLayoutType = 'horizontal' | 'vertical' | undefined;
type DividerType = 'solid' | 'dashed' | 'dotted' | undefined;
export interface DividerProps { export interface DividerProps {
/** /**
* Alignment of the content, options are 'left', 'center', 'right' for horizontal layout and 'top', 'center', 'bottom' for vertical. * Alignment of the content, options are 'left', 'center', 'right' for horizontal layout and 'top', 'center', 'bottom' for vertical.
* @see DividerAlignType
*/ */
align?: DividerAlignType; align?: 'left' | 'center' | 'right' | 'top' | 'center' | 'bottom' | undefined;
/** /**
* Specifies the orientation, valid values are 'horizontal' and 'vertical'. * Specifies the orientation, valid values are 'horizontal' and 'vertical'.
* @see DividerLayoutType * @defaultValue horizontal
* Default value is 'horizontal'.
*/ */
layout?: DividerLayoutType; layout?: 'horizontal' | 'vertical' | undefined;
/** /**
* Border style type. * Border style type.
* @see DividerType * @defaultValue solid
* Default value is 'solid'.
*/ */
type?: DividerType; type?: 'solid' | 'dashed' | 'dotted' | undefined;
} }
/**
* Defines valid slots in Divider slots.
*/
export interface DividerSlots { export interface DividerSlots {
/** /**
* Default content slot. * Default content slot.
*/ */
default: () => VNode[]; default(): VNode[];
} }
export declare type DividerEmits = {}; export interface DividerEmits {}
declare class Divider extends ClassComponent<DividerProps, DividerSlots, DividerEmits> {} /**
* **PrimeVue - Divider**
*
* _Divider is used to separate contents._
*
* [Live Demo](https://www.primefaces.org/primevue/divider)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg)
*
* @group Component
*
*/
export declare class Divider extends ClassComponent<DividerProps, DividerSlots, DividerEmits> {}
declare module '@vue/runtime-core' { declare module '@vue/runtime-core' {
interface GlobalComponents { interface GlobalComponents {

140
doc/common/apidoc/index.json
View File

@ -225,7 +225,16 @@
} }
}, },
"accordiontab": { "accordiontab": {
"description": "Accordion groups a collection of contents in tabs.\n\n[Live Demo](https://www.primevue.org/accordion/)", "description": "AccordionTab is a helper component for Accordion.\n\n[Live Demo](https://www.primevue.org/accordion/)",
"components": {
"AccordionTab": {
"description": "AccordionTab is a helper component for Accordion..",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": { "interfaces": {
"description": "Defines the custom interfaces used by the module.", "description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.", "eventDescription": "Defines the custom events used by the component's emit.",
@ -235,7 +244,7 @@
"slotDescription": "Defines the slots used by the component.", "slotDescription": "Defines the slots used by the component.",
"values": { "values": {
"AccordionTabEmits": { "AccordionTabEmits": {
"description": "Defines valid emits in Acordion component.", "description": "Defines valid emits in AcordionTab component.",
"relatedProp": "", "relatedProp": "",
"props": [], "props": [],
"methods": [] "methods": []
@ -273,7 +282,7 @@
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "boolean", "type": "boolean",
"default": "", "default": "false",
"description": "Whether the tab is disabled." "description": "Whether the tab is disabled."
}, },
{ {
@ -320,7 +329,7 @@
"methods": [] "methods": []
}, },
"AccordionTabSlots": { "AccordionTabSlots": {
"description": "Defines valid slots in Acordion slots.", "description": "Defines valid slots in AcordionTab slots.",
"relatedProp": "", "relatedProp": "",
"props": [], "props": [],
"methods": [ "methods": [
@ -3400,9 +3409,9 @@
"name": "appendTo", "name": "appendTo",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "string | HTMLElement", "type": "CalendarAppendToType",
"default": "body", "default": "",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are 'body' for document body and 'self' for the element itself."
}, },
{ {
"name": "aria-label", "name": "aria-label",
@ -3496,9 +3505,9 @@
"name": "hourFormat", "name": "hourFormat",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"12\" | \"24\"", "type": "CalendarHourFormatType",
"default": "", "default": "",
"description": "Specifies hour format." "description": "Specifies 12 or 24 hour format."
}, },
{ {
"name": "icon", "name": "icon",
@ -3600,8 +3609,8 @@
"name": "modelValue", "name": "modelValue",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | string | string[] | Date | Date[]", "type": "CalendarValueType",
"default": "null", "default": "",
"description": "Value of the component." "description": "Value of the component."
}, },
{ {
@ -3696,9 +3705,9 @@
"name": "selectionMode", "name": "selectionMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"multiple\" | \"range\" | \"single\"", "type": "CalendarSelectionModeType",
"default": "single", "default": "",
"description": "Defines the quantity of the selection." "description": "Defines the quantity of the selection, valid values are 'single', 'multiple' and 'range'."
}, },
{ {
"name": "shortYearCutoff", "name": "shortYearCutoff",
@ -3816,9 +3825,9 @@
"name": "view", "name": "view",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"month\" | \"year\" | \"date\"", "type": "CalendarViewType",
"default": "date", "default": "",
"description": "Type of view to display." "description": "Type of view to display, valid values are 'date', 'month' and 'year'."
}, },
{ {
"name": "yearNavigator", "name": "yearNavigator",
@ -8931,7 +8940,17 @@
} }
} }
}, },
"deferredcontent/DeferredContent": { "deferredcontent": {
"description": "DeferredContent postpones the loading the content that is initially not in the viewport until it becomes visible on scroll.\n\n[Live Demo](https://www.primevue.org/deferredcontent/)",
"components": {
"DeferredContent": {
"description": "DeferredContent postpones the loading the content that is initially not in the viewport until it becomes visible on scroll.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": { "interfaces": {
"description": "Defines the custom interfaces used by the module.", "description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.", "eventDescription": "Defines the custom events used by the component's emit.",
@ -8940,31 +8959,36 @@
"emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.",
"slotDescription": "Defines the slots used by the component.", "slotDescription": "Defines the slots used by the component.",
"values": { "values": {
"DeferredContentEmits": {
"description": "Defines valid emits in DeferredContent component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "load",
"parameters": [],
"returnType": "void",
"description": "Callback to invoke when deferred content is loaded."
}
]
},
"DeferredContentProps": { "DeferredContentProps": {
"relatedProp": "", "relatedProp": "",
"props": [], "props": [],
"methods": [] "methods": []
}, },
"DeferredContentSlots": { "DeferredContentSlots": {
"description": "Defines valid slots in DeferredContent component.",
"relatedProp": "", "relatedProp": "",
"props": [ "props": [],
"methods": [
{ {
"name": "default", "name": "default",
"optional": false, "parameters": [],
"readonly": false, "returnType": "VNode<RendererNode, RendererElement, Object>[]",
"type": "Function", "description": "Default content slot."
"default": ""
} }
], ]
"methods": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"DeferredContentEmits": {
"values": "{\n \"load\": \"Function, \"\n}"
} }
} }
} }
@ -9267,7 +9291,17 @@
} }
} }
}, },
"divider/Divider": { "divider": {
"description": "Divider is used to separate contents.\n\n[Live Demo](https://www.primefaces.org/primevue/divider)",
"components": {
"Divider": {
"description": "Divider is used to separate contents.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": { "interfaces": {
"description": "Defines the custom interfaces used by the module.", "description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.", "eventDescription": "Defines the custom events used by the component's emit.",
@ -9276,14 +9310,20 @@
"emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.",
"slotDescription": "Defines the slots used by the component.", "slotDescription": "Defines the slots used by the component.",
"values": { "values": {
"DividerEmits": {
"relatedProp": "",
"props": [],
"methods": []
},
"DividerProps": { "DividerProps": {
"description": "Defines valid properties in Divider component.",
"relatedProp": "", "relatedProp": "",
"props": [ "props": [
{ {
"name": "align", "name": "align",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "DividerAlignType", "type": "\"center\" | \"left\" | \"top\" | \"bottom\" | \"right\"",
"default": "", "default": "",
"description": "Alignment of the content, options are 'left', 'center', 'right' for horizontal layout and 'top', 'center', 'bottom' for vertical." "description": "Alignment of the content, options are 'left', 'center', 'right' for horizontal layout and 'top', 'center', 'bottom' for vertical."
}, },
@ -9291,41 +9331,33 @@
"name": "layout", "name": "layout",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "DividerLayoutType", "type": "\"horizontal\" | \"vertical\"",
"default": "", "default": "horizontal",
"description": "Specifies the orientation, valid values are 'horizontal' and 'vertical'." "description": "Specifies the orientation, valid values are 'horizontal' and 'vertical'."
}, },
{ {
"name": "type", "name": "type",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "DividerType", "type": "\"dashed\" | \"dotted\" | \"solid\"",
"default": "", "default": "solid",
"description": "Border style type." "description": "Border style type."
} }
], ],
"methods": [] "methods": []
}, },
"DividerSlots": { "DividerSlots": {
"description": "Defines valid slots in Divider slots.",
"relatedProp": "", "relatedProp": "",
"props": [ "props": [],
"methods": [
{ {
"name": "default", "name": "default",
"optional": false, "parameters": [],
"readonly": false, "returnType": "VNode<RendererNode, RendererElement, Object>[]",
"type": "Function", "description": "Default content slot."
"default": ""
} }
], ]
"methods": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"DividerEmits": {
"values": "{}"
} }
} }
} }