Apidoc updates

primefaces · Nov 7, 2023 · 01af58f · 01af58f
1 parent 5192b34
commit 01af58f
Show file tree

Hide file tree

Showing 97 changed files with 204 additions and 204 deletions.
diff --git a/components/lib/accordion/Accordion.d.ts b/components/lib/accordion/Accordion.d.ts
@@ -85,7 +85,7 @@ export interface AccordionPassThroughOptions {
      */
     accordiontab?: AccordionTabPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/animateonscroll/AnimateOnScroll.d.ts b/components/lib/animateonscroll/AnimateOnScroll.d.ts
@@ -40,7 +40,7 @@ export interface AnimateOnScrollOptions {
  */
 export interface AnimateOnScrollDirectivePassThroughOptions {
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseDirective.DirectiveHooks}
      */
     hooks?: DirectiveHooks;

diff --git a/components/lib/autocomplete/AutoComplete.d.ts b/components/lib/autocomplete/AutoComplete.d.ts
@@ -186,7 +186,7 @@ export interface AutoCompletePassThroughOptions {
      */
     selectedMessage?: AutoCompletePassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/avatar/Avatar.d.ts b/components/lib/avatar/Avatar.d.ts
@@ -65,7 +65,7 @@ export interface AvatarPassThroughOptions {
      */
     image?: AvatarPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/avatargroup/AvatarGroup.d.ts b/components/lib/avatargroup/AvatarGroup.d.ts
@@ -30,7 +30,7 @@ export interface AvatarGroupPassThroughOptions {
      */
     root?: AvatarGroupPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/badge/Badge.d.ts b/components/lib/badge/Badge.d.ts
@@ -49,7 +49,7 @@ export interface BadgePassThroughOptions {
      */
     root?: BadgePassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/badgedirective/BadgeDirective.d.ts b/components/lib/badgedirective/BadgeDirective.d.ts
@@ -55,7 +55,7 @@ export interface BadgeDirectivePassThroughOptions {
      */
     root?: BadgeDirectivePassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseDirective.DirectiveHooks}
      */
     hooks?: DirectiveHooks;

diff --git a/components/lib/blockui/BlockUI.d.ts b/components/lib/blockui/BlockUI.d.ts
@@ -50,7 +50,7 @@ export interface BlockUIPassThroughOptions {
      */
     mask?: BlockUIPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/breadcrumb/Breadcrumb.d.ts b/components/lib/breadcrumb/Breadcrumb.d.ts
@@ -75,7 +75,7 @@ export interface BreadcrumbPassThroughOptions {
      */
     separatorIcon?: BreadcrumbPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/button/Button.d.ts b/components/lib/button/Button.d.ts
@@ -66,7 +66,7 @@ export interface ButtonPassThroughOptions {
      */
     badge?: ButtonPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/calendar/Calendar.d.ts b/components/lib/calendar/Calendar.d.ts
@@ -305,7 +305,7 @@ export interface CalendarPassThroughOptions {
      */
     hiddenYear?: CalendarPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/card/Card.d.ts b/components/lib/card/Card.d.ts
@@ -48,7 +48,7 @@ export interface CardPassThroughOptions {
      */
     footer?: CardPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/carousel/Carousel.d.ts b/components/lib/carousel/Carousel.d.ts
@@ -110,7 +110,7 @@ export interface CarouselPassThroughOptions {
      */
     footer?: CarouselPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/cascadeselect/CascadeSelect.d.ts b/components/lib/cascadeselect/CascadeSelect.d.ts
@@ -121,7 +121,7 @@ export interface CascadeSelectPassThroughOptions {
      */
     hiddenSearchResult?: CascadeSelectPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/chart/Chart.d.ts b/components/lib/chart/Chart.d.ts
@@ -46,7 +46,7 @@ export interface ChartPassThroughOptions {
      */
     canvas?: ChartPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/checkbox/Checkbox.d.ts b/components/lib/checkbox/Checkbox.d.ts
@@ -66,7 +66,7 @@ export interface CheckboxPassThroughOptions {
      */
     hiddenInput?: CheckboxPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/chip/Chip.d.ts b/components/lib/chip/Chip.d.ts
@@ -62,7 +62,7 @@ export interface ChipPassThroughOptions {
      */
     removeIcon?: ChipPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/chips/Chips.d.ts b/components/lib/chips/Chips.d.ts
@@ -92,7 +92,7 @@ export interface ChipsPassThroughOptions {
      */
     input?: ChipsPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/colorpicker/ColorPicker.d.ts b/components/lib/colorpicker/ColorPicker.d.ts
@@ -95,7 +95,7 @@ export interface ColorPickerPassThroughOptions {
      */
     hueHandle: ColorPickerPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/column/Column.d.ts b/components/lib/column/Column.d.ts
@@ -337,7 +337,7 @@ export interface ColumnPassThroughOptions {
      */
     hiddenInput?: ColumnPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/columngroup/ColumnGroup.d.ts b/components/lib/columngroup/ColumnGroup.d.ts
@@ -48,7 +48,7 @@ export interface ColumnGroupPassThroughOptions {
      */
     root?: ColumnGroupPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/confirmdialog/ConfirmDialog.d.ts b/components/lib/confirmdialog/ConfirmDialog.d.ts
@@ -94,7 +94,7 @@ export interface ConfirmDialogPassThroughOptions {
      */
     acceptButton?: ButtonPassThroughOptions;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/confirmpopup/ConfirmPopup.d.ts b/components/lib/confirmpopup/ConfirmPopup.d.ts
@@ -76,7 +76,7 @@ export interface ConfirmPopupPassThroughOptions {
      */
     acceptButton?: ButtonPassThroughOptions;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/contextmenu/ContextMenu.d.ts b/components/lib/contextmenu/ContextMenu.d.ts
@@ -90,7 +90,7 @@ export interface ContextMenuPassThroughOptions {
      */
     submenu?: ContextMenuPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/datatable/DataTable.d.ts b/components/lib/datatable/DataTable.d.ts
@@ -685,7 +685,7 @@ export interface DataTablePassThroughOptions {
      */
     column?: ColumnPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/dataview/DataView.d.ts b/components/lib/dataview/DataView.d.ts
@@ -98,7 +98,7 @@ export interface DataViewPassThroughOptions {
      */
     footer?: DataViewPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/dataviewlayoutoptions/DataViewLayoutOptions.d.ts b/components/lib/dataviewlayoutoptions/DataViewLayoutOptions.d.ts
@@ -67,7 +67,7 @@ export interface DataViewLayoutOptionsPassThroughOptions {
      */
     gridIcon?: DataViewLayoutOptionsPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/deferredcontent/DeferredContent.d.ts b/components/lib/deferredcontent/DeferredContent.d.ts
@@ -46,7 +46,7 @@ export interface DeferredContentPassThroughOptions {
      */
     root?: DeferredContentPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/dialog/Dialog.d.ts b/components/lib/dialog/Dialog.d.ts
@@ -88,7 +88,7 @@ export interface DialogPassThroughOptions {
      */
     mask?: DialogPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/divider/Divider.d.ts b/components/lib/divider/Divider.d.ts
@@ -46,7 +46,7 @@ export interface DividerPassThroughOptions {
      */
     content?: DividerPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/dock/Dock.d.ts b/components/lib/dock/Dock.d.ts
@@ -75,7 +75,7 @@ export interface DockPassThroughOptions {
      */
     icon?: DockPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/dropdown/Dropdown.d.ts b/components/lib/dropdown/Dropdown.d.ts
@@ -164,7 +164,7 @@ export interface DropdownPassThroughOptions {
      */
     hiddenLastFocusableEl?: DropdownPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/editor/Editor.d.ts b/components/lib/editor/Editor.d.ts
@@ -177,7 +177,7 @@ export interface EditorPassThroughOptions {
      */
     content?: EditorPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/fieldset/Fieldset.d.ts b/components/lib/fieldset/Fieldset.d.ts
@@ -87,7 +87,7 @@ export interface FieldsetPassThroughOptions {
      */
     content?: FieldsetPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/fileupload/FileUpload.d.ts b/components/lib/fileupload/FileUpload.d.ts
@@ -264,7 +264,7 @@ export interface FileUploadPassThroughOptions {
      */
     uploadIcon?: FileUploadPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/focustrap/FocusTrap.d.ts b/components/lib/focustrap/FocusTrap.d.ts
@@ -57,7 +57,7 @@ export interface FocusTrapDirectivePassThroughOptions {
      */
     lastFocusableElement?: FocusTrapDirectivePassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseDirective.DirectiveHooks}
      */
     hooks?: DirectiveHooks;

diff --git a/components/lib/galleria/Galleria.d.ts b/components/lib/galleria/Galleria.d.ts
@@ -171,7 +171,7 @@ export interface GalleriaPassThroughOptions {
      */
     mask?: GalleriaPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/image/Image.d.ts b/components/lib/image/Image.d.ts
@@ -116,7 +116,7 @@ export interface ImagePassThroughOptions {
      */
     preview?: ImagePassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/inlinemessage/InlineMessage.d.ts b/components/lib/inlinemessage/InlineMessage.d.ts
@@ -54,7 +54,7 @@ export interface InlineMessagePassThroughOptions {
      */
     text?: InlineMessagePassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/inplace/Inplace.d.ts b/components/lib/inplace/Inplace.d.ts
@@ -61,7 +61,7 @@ export interface InplacePassThroughOptions {
      */
     closeButton?: ButtonPassThroughOptions;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/inputgroup/InputGroup.d.ts b/components/lib/inputgroup/InputGroup.d.ts
@@ -38,7 +38,7 @@ export interface InputGroupPassThroughOptions {
      */
     root?: InputGroupPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/inputgroupaddon/InputGroupAddon.d.ts b/components/lib/inputgroupaddon/InputGroupAddon.d.ts
@@ -38,7 +38,7 @@ export interface InputGroupAddonPassThroughOptions {
      */
     root?: InputGroupAddonPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/inputmask/InputMask.d.ts b/components/lib/inputmask/InputMask.d.ts
@@ -45,7 +45,7 @@ export interface InputMaskPassThroughOptions {
      */
     root?: InputMaskPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;

diff --git a/components/lib/inputnumber/InputNumber.d.ts b/components/lib/inputnumber/InputNumber.d.ts
@@ -97,7 +97,7 @@ export interface InputNumberPassThroughOptions {
      */
     decrementButton?: ButtonPassThroughOptionType;
     /**
-     * Used to manage all lifecycle hooks
+     * Used to manage all lifecycle hooks.
      * @see {@link BaseComponent.ComponentHooks}
      */
     hooks?: ComponentHooks;