From 649d40115211eb897325b57cac3036726bc04cfd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tu=C4=9F=C3=A7e=20K=C3=BC=C3=A7=C3=BCko=C4=9Flu?= Date: Wed, 8 Mar 2023 13:51:52 +0300 Subject: [PATCH] .d.ts updates --- components/accordion/Accordion.d.ts | 4 +-- components/autocomplete/AutoComplete.d.ts | 18 +++++------ components/avatar/Avatar.d.ts | 4 +-- components/calendar/Calendar.d.ts | 18 +++++------ components/carousel/Carousel.d.ts | 2 +- components/cascadeselect/CascadeSelect.d.ts | 18 +++++------ components/chips/Chips.d.ts | 2 +- components/colorpicker/ColorPicker.d.ts | 4 +-- .../ConfirmationOptions.d.ts | 2 +- components/contextmenu/ContextMenu.d.ts | 2 +- components/dataview/DataView.d.ts | 6 ++-- components/dialog/Dialog.d.ts | 10 +++--- components/divider/Divider.d.ts | 4 +-- components/dock/Dock.d.ts | 4 +-- components/dropdown/Dropdown.d.ts | 24 +++++++------- components/fileupload/FileUpload.d.ts | 14 ++++---- components/galleria/Galleria.d.ts | 6 ++-- components/inlinemessage/InlineMessage.d.ts | 2 +- components/inplace/Inplace.d.ts | 2 +- components/inputmask/InputMask.d.ts | 2 +- components/inputnumber/InputNumber.d.ts | 12 +++---- components/knob/Knob.d.ts | 8 ++--- components/listbox/Listbox.d.ts | 14 ++++---- components/megamenu/MegaMenu.d.ts | 2 +- components/menu/Menu.d.ts | 2 +- components/message/Message.d.ts | 4 +-- components/multiselect/MultiSelect.d.ts | 32 +++++++++---------- components/orderlist/OrderList.d.ts | 2 +- components/overlaypanel/OverlayPanel.d.ts | 2 +- components/paginator/Paginator.d.ts | 2 +- components/password/Password.d.ts | 10 +++--- components/progressbar/ProgressBar.d.ts | 2 +- .../progressspinner/ProgressSpinner.d.ts | 4 +-- components/rating/Rating.d.ts | 6 ++-- components/scrolltop/ScrollTop.d.ts | 6 ++-- components/sidebar/Sidebar.d.ts | 4 +-- components/skeleton/Skeleton.d.ts | 8 ++--- components/slider/Slider.d.ts | 2 +- components/speeddial/SpeedDial.d.ts | 8 ++--- components/splitbutton/SplitButton.d.ts | 2 +- components/splitter/Splitter.d.ts | 2 +- components/tieredmenu/TieredMenu.d.ts | 2 +- components/timeline/Timeline.d.ts | 4 +-- components/toast/Toast.d.ts | 2 +- components/togglebutton/ToggleButton.d.ts | 2 +- components/tree/Tree.d.ts | 6 ++-- components/treeselect/TreeSelect.d.ts | 8 ++--- components/treetable/TreeTable.d.ts | 16 +++++----- .../virtualscroller/VirtualScroller.d.ts | 2 +- 49 files changed, 162 insertions(+), 162 deletions(-) diff --git a/components/accordion/Accordion.d.ts b/components/accordion/Accordion.d.ts index 1d3a34df3..8e5f117ce 100755 --- a/components/accordion/Accordion.d.ts +++ b/components/accordion/Accordion.d.ts @@ -61,12 +61,12 @@ export interface AccordionProps { lazy?: boolean | undefined; /** * Icon of a collapsed tab. - * @defaultValue 'pi pi-chevron-right' + * @defaultValue pi pi-chevron-right */ expandIcon?: string | undefined; /** * Icon of an expanded tab. - * @defaultValue 'pi pi-chevron-down' + * @defaultValue pi pi-chevron-down */ collapseIcon?: string | undefined; /** diff --git a/components/autocomplete/AutoComplete.d.ts b/components/autocomplete/AutoComplete.d.ts index dc13fc782..d585009ec 100755 --- a/components/autocomplete/AutoComplete.d.ts +++ b/components/autocomplete/AutoComplete.d.ts @@ -113,7 +113,7 @@ export interface AutoCompleteProps { optionGroupChildren?: string | ((data: any) => any[]) | undefined; /** * Maximum height of the suggestions panel. - * @defaultValue '200px' + * @defaultValue 200px */ scrollHeight?: string | undefined; /** @@ -123,7 +123,7 @@ export interface AutoCompleteProps { dropdown?: boolean | undefined; /** * Specifies the behavior dropdown button. Default 'blank' mode sends an empty string and 'current' mode sends the input value. - * @defaultValue 'blank' + * @defaultValue blank */ dropdownMode?: 'blank' | 'current' | undefined; /** @@ -163,7 +163,7 @@ export interface AutoCompleteProps { /** * 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. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; /** @@ -215,12 +215,12 @@ export interface AutoCompleteProps { dropdownClass?: string | undefined; /** * Icon to display in loading state. - * @defaultValue 'pi pi-spinner pi-spin' + * @defaultValue pi pi-spinner pi-spin */ loadingIcon?: string | undefined; /** * Icon to display in chip remove action. - * @defaultValue 'pi pi-times-circle' + * @defaultValue pi pi-times-circle */ removeTokenIcon?: string | undefined; /** @@ -244,22 +244,22 @@ export interface AutoCompleteProps { searchLocale?: string | undefined; /** * Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration. - * @defaultValue '{0} results are available' + * @defaultValue {0} results are available */ searchMessage?: string | undefined; /** * Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration. - * @defaultValue '{0} items selected' + * @defaultValue {0} items selected */ selectionMessage?: string | undefined; /** * Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No selected item' + * @defaultValue No selected item */ emptySelectionMessage?: string | undefined; /** * Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No results found' + * @defaultValue No results found */ emptySearchMessage?: string | undefined; /** diff --git a/components/avatar/Avatar.d.ts b/components/avatar/Avatar.d.ts index 222a89e58..3eaef7fdc 100644 --- a/components/avatar/Avatar.d.ts +++ b/components/avatar/Avatar.d.ts @@ -27,12 +27,12 @@ export interface AvatarProps { image?: string | undefined; /** * Size of the element. - * @defaultValue 'normal' + * @defaultValue normal */ size?: 'normal' | 'large' | 'xlarge' | undefined; /** * Shape of the element. - * @defaultValue 'square' + * @defaultValue square */ shape?: 'square' | 'circle' | undefined; /** diff --git a/components/calendar/Calendar.d.ts b/components/calendar/Calendar.d.ts index 206ecfc7c..2c6729c94 100755 --- a/components/calendar/Calendar.d.ts +++ b/components/calendar/Calendar.d.ts @@ -109,27 +109,27 @@ export interface CalendarProps { showIcon?: boolean | undefined; /** * Icon of the calendar button. - * @defaultValue 'pi pi-calendar' + * @defaultValue pi pi-calendar */ icon?: string | undefined; /** * Icon to show in the previous button. - * @defaultValue 'pi pi-chevron-left' + * @defaultValue pi pi-chevron-left */ previousIcon?: string | undefined; /** * Icon to show in the next button. - * @defaultValue 'pi pi-chevron-right' + * @defaultValue pi pi-chevron-right */ nextIcon?: string | undefined; /** * Icon to show in each of the increment buttons. - * @defaultValue 'pi pi-chevron-up' + * @defaultValue pi pi-chevron-up */ incrementIcon?: string | undefined; /** * Icon to show in each of the decrement buttons. - * @defaultValue 'pi pi-chevron-down' + * @defaultValue pi pi-chevron-down */ decrementIcon?: string | undefined; /** @@ -143,7 +143,7 @@ export interface CalendarProps { responsiveOptions?: CalendarResponsiveOptions[]; /** * Type of view to display. - * @defaultValue 'date' + * @defaultValue date */ view?: 'date' | 'month' | 'year' | undefined; /** @@ -214,7 +214,7 @@ export interface CalendarProps { showButtonBar?: boolean | undefined; /** * The cutoff year for determining the century for a date. - * @defaultValue '+10' + * @defaultValue +10 */ shortYearCutoff?: string | undefined; /** @@ -264,7 +264,7 @@ export interface CalendarProps { hideOnRangeSelection?: boolean | undefined; /** * Separator of time selector. - * @defaultValue ':' + * @defaultValue : */ timeSeparator?: string | undefined; /** @@ -293,7 +293,7 @@ export interface CalendarProps { placeholder?: string | undefined; /** * A valid query selector or an HTMLElement to specify where the overlay gets attached. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; /** diff --git a/components/carousel/Carousel.d.ts b/components/carousel/Carousel.d.ts index 0d255ec5f..b825bac99 100755 --- a/components/carousel/Carousel.d.ts +++ b/components/carousel/Carousel.d.ts @@ -59,7 +59,7 @@ export interface CarouselProps { orientation?: 'horizontal' | 'vertical' | undefined; /** * Height of the viewport in vertical layout. - * @defaultValue '300px' + * @defaultValue 300px */ verticalViewPortHeight?: string | undefined; /** diff --git a/components/cascadeselect/CascadeSelect.d.ts b/components/cascadeselect/CascadeSelect.d.ts index b26e9ac07..f4dc0d6f5 100644 --- a/components/cascadeselect/CascadeSelect.d.ts +++ b/components/cascadeselect/CascadeSelect.d.ts @@ -106,7 +106,7 @@ export interface CascadeSelectProps { panelProps?: HTMLAttributes | undefined; /** * 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. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; /** @@ -116,17 +116,17 @@ export interface CascadeSelectProps { loading?: boolean | undefined; /** * Icon to display in the dropdown. - * @defaultValue 'pi pi-chevron-down' + * @defaultValue pi pi-chevron-down */ dropdownIcon?: string | undefined; /** * Icon to display in loading state. - * @defaultValue 'pi pi-spinner pi-spin' + * @defaultValue pi pi-spinner pi-spin */ loadingIcon?: string | undefined; /** * Icon to display in the option group. - * @defaultValue 'pi pi-angle-right' + * @defaultValue pi pi-angle-right */ optionGroupIcon?: string | undefined; /** @@ -145,27 +145,27 @@ export interface CascadeSelectProps { searchLocale?: string | undefined; /** * Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration. - * @defaultValue '{0} results are available' + * @defaultValue {0} results are available */ searchMessage?: string | undefined; /** * Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration. - * @defaultValue '{0} items selected' + * @defaultValue {0} items selected */ selectionMessage?: string | undefined; /** * Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No selected item' + * @defaultValue No selected item */ emptySelectionMessage?: string | undefined; /** * Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No results found' + * @defaultValue No results found */ emptySearchMessage?: string | undefined; /** * Text to be displayed when there are no options available. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No available options' + * @defaultValue No available options */ emptyMessage?: string | undefined; /** diff --git a/components/chips/Chips.d.ts b/components/chips/Chips.d.ts index 75b15abed..26a88d659 100755 --- a/components/chips/Chips.d.ts +++ b/components/chips/Chips.d.ts @@ -75,7 +75,7 @@ export interface ChipsProps { inputProps?: InputHTMLAttributes | undefined; /** * Icon to display in chip remove action. - * @defaultValue 'pi pi-times-circle' + * @defaultValue pi pi-times-circle */ removeTokenIcon?: string | undefined; /** diff --git a/components/colorpicker/ColorPicker.d.ts b/components/colorpicker/ColorPicker.d.ts index d746b147f..a8cdc757e 100755 --- a/components/colorpicker/ColorPicker.d.ts +++ b/components/colorpicker/ColorPicker.d.ts @@ -44,7 +44,7 @@ export interface ColorPickerProps { inline?: boolean | undefined; /** * Format to use in value binding, supported formats are 'hex', 'rgb' and 'hsb'. - * @defaultValue 'hex' + * @defaultValue hex */ format?: 'hex' | 'rgb' | 'hsb' | undefined; /** @@ -72,7 +72,7 @@ export interface ColorPickerProps { panelClass?: any; /** * 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. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; } diff --git a/components/confirmationoptions/ConfirmationOptions.d.ts b/components/confirmationoptions/ConfirmationOptions.d.ts index 387bb5738..83913f691 100644 --- a/components/confirmationoptions/ConfirmationOptions.d.ts +++ b/components/confirmationoptions/ConfirmationOptions.d.ts @@ -28,7 +28,7 @@ export interface ConfirmationOptions { group?: string | undefined; /** * Position of the dialog. - * @defaultValue 'center' + * @defaultValue center */ position?: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright' | undefined; /** diff --git a/components/contextmenu/ContextMenu.d.ts b/components/contextmenu/ContextMenu.d.ts index bc2bd0c41..e47b02242 100755 --- a/components/contextmenu/ContextMenu.d.ts +++ b/components/contextmenu/ContextMenu.d.ts @@ -22,7 +22,7 @@ export interface ContextMenuProps { model?: MenuItem[] | undefined; /** * A valid query selector or an HTMLElement to specify where the overlay gets attached. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; /** diff --git a/components/dataview/DataView.d.ts b/components/dataview/DataView.d.ts index 04452f76c..4c6925d64 100755 --- a/components/dataview/DataView.d.ts +++ b/components/dataview/DataView.d.ts @@ -43,7 +43,7 @@ export interface DataViewProps { value?: any[] | undefined; /** * Layout of the items, valid values are 'list' and 'grid'. - * @defaultValue 'list' + * @defaultValue list */ layout?: 'list' | 'grid' | undefined; /** @@ -67,7 +67,7 @@ export interface DataViewProps { paginator?: boolean | undefined; /** * Position of the paginator, options are 'top','bottom' or 'both'. - * @defaultValue 'bottom' + * @defaultValue bottom */ paginatorPosition?: 'top' | 'bottom' | 'both' | undefined; /** @@ -110,7 +110,7 @@ export interface DataViewProps { * - {last} * - {totalRecords} * - * @defaultValue '({currentPage} of {totalPages})' + * @defaultValue ({currentPage} of {totalPages}) */ currentPageReportTemplate?: string | undefined; /** diff --git a/components/dialog/Dialog.d.ts b/components/dialog/Dialog.d.ts index a85ade092..bc24c3541 100755 --- a/components/dialog/Dialog.d.ts +++ b/components/dialog/Dialog.d.ts @@ -103,7 +103,7 @@ export interface DialogProps { autoZIndex?: boolean | undefined; /** * Position of the dialog. - * @defaultValue 'center' + * @defaultValue center */ position?: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright' | undefined; /** @@ -137,7 +137,7 @@ export interface DialogProps { minY?: number | undefined; /** * A valid query selector or an HTMLElement to specify where the dialog gets attached. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; /** @@ -146,17 +146,17 @@ export interface DialogProps { style?: any; /** * Icon to display in the dialog close button. - * @defaultValue 'pi pi-times' + * @defaultValue pi pi-times */ closeIcon?: string | undefined; /** * Icon to display in the dialog maximize button when dialog is not maximized. - * @defaultValue 'pi pi-window-maximize' + * @defaultValue pi pi-window-maximize */ maximizeIcon?: string | undefined; /** * Icon to display in the dialog maximize button when dialog is maximized. - * @defaultValue 'pi pi-window-minimize' + * @defaultValue pi pi-window-minimize */ minimizeIcon?: string | undefined; } diff --git a/components/divider/Divider.d.ts b/components/divider/Divider.d.ts index 32e31a47c..191758c12 100644 --- a/components/divider/Divider.d.ts +++ b/components/divider/Divider.d.ts @@ -20,12 +20,12 @@ export interface DividerProps { align?: 'left' | 'center' | 'right' | 'top' | 'center' | 'bottom' | undefined; /** * Specifies the orientation, valid values are 'horizontal' and 'vertical'. - * @defaultValue 'horizontal' + * @defaultValue horizontal */ layout?: 'horizontal' | 'vertical' | undefined; /** * Border style type. - * @defaultValue 'solid' + * @defaultValue solid */ type?: 'solid' | 'dashed' | 'dotted' | undefined; } diff --git a/components/dock/Dock.d.ts b/components/dock/Dock.d.ts index 13f72506d..c0f0814bd 100644 --- a/components/dock/Dock.d.ts +++ b/components/dock/Dock.d.ts @@ -21,7 +21,7 @@ export interface DockTooltipOptions { event: 'hover' | 'focus' | undefined; /** * Position of element. - * @defaultValue 'bottom' + * @defaultValue bottom */ position: 'bottom' | 'top' | 'left' | 'right' | undefined; /** @@ -40,7 +40,7 @@ export interface DockProps { model?: MenuItem[] | undefined; /** * Position of element. - * @defaultValue 'bottom' + * @defaultValue bottom */ position?: 'bottom' | 'top' | 'left' | 'right' | undefined; /** diff --git a/components/dropdown/Dropdown.d.ts b/components/dropdown/Dropdown.d.ts index 750521551..c5cdeecc8 100755 --- a/components/dropdown/Dropdown.d.ts +++ b/components/dropdown/Dropdown.d.ts @@ -75,7 +75,7 @@ export interface DropdownProps { optionGroupChildren?: string | ((data: any) => any[]) | undefined; /** * Height of the viewport, a scrollbar is defined if height of list exceeds this value. - * @defaultValue '200px' + * @defaultValue 200px */ scrollHeight?: string | undefined; /** @@ -92,7 +92,7 @@ export interface DropdownProps { filterLocale?: string | undefined; /** * Defines the filtering algorithm to use when searching the options. - * @defaultValue 'contains' + * @defaultValue contains */ filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | undefined; /** @@ -157,7 +157,7 @@ export interface DropdownProps { clearIconProps?: HTMLAttributes | undefined; /** * A valid query selector or an HTMLElement to specify where the overlay gets attached. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; /** @@ -166,22 +166,22 @@ export interface DropdownProps { loading?: boolean | undefined; /** * Icon to display in clear button. - * @defaultValue 'pi pi-times' + * @defaultValue pi pi-times */ clearIcon?: string | undefined; /** * Icon to display in the dropdown. - * @defaultValue 'pi pi-chevron-down' + * @defaultValue pi pi-chevron-down */ dropdownIcon?: string | undefined; /** * Icon to display in filter input. - * @defaultValue 'pi pi-search' + * @defaultValue pi pi-search */ filterIcon?: string | undefined; /** * Icon to display in loading state. - * @defaultValue 'pi pi-spinner pi-spin' + * @defaultValue pi pi-spinner pi-spin */ loadingIcon?: string | undefined; /** @@ -209,27 +209,27 @@ export interface DropdownProps { selectOnFocus?: boolean | undefined; /** * Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration. - * @defaultValue '{0} results are available' + * @defaultValue {0} results are available */ filterMessage?: string | undefined; /** * Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration. - * @defaultValue '{0} items selected' + * @defaultValue {0} items selected */ selectionMessage?: string | undefined; /** * Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No selected item' + * @defaultValue No selected item */ emptySelectionMessage?: string | undefined; /** * Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No results found' + * @defaultValue No results found */ emptyFilterMessage?: string | undefined; /** * Text to display when there are no options available. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No results found' + * @defaultValue No results foun */ emptyMessage?: string | undefined; /** diff --git a/components/fileupload/FileUpload.d.ts b/components/fileupload/FileUpload.d.ts index f06a505af..7ae1db38e 100755 --- a/components/fileupload/FileUpload.d.ts +++ b/components/fileupload/FileUpload.d.ts @@ -152,7 +152,7 @@ export interface FileUploadProps { url?: string | undefined; /** * Defines the UI of the component, possible values are 'advanced' and 'basic'. - * @defaultValue 'advanced' + * @defaultValue advanced */ mode?: 'advanced' | 'basic' | undefined; /** @@ -180,17 +180,17 @@ export interface FileUploadProps { maxFileSize?: number | undefined; /** * Message of the invalid fize size. - * @defaultValue '{0}: Invalid file size, file size should be smaller than {1.}' + * @defaultValue {0}: Invalid file size, file size should be smaller than {1.} */ invalidFileSizeMessage?: string | undefined; /** * Message to display when number of files to be uploaded exceeeds the limit. - * @defaultValue 'Maximum number of files to be uploaded is {0.}' + * @defaultValue Maximum number of files to be uploaded is {0.} */ invalidFileLimitMessage?: string | undefined; /** * Message of the invalid fize type. - * @defaultValue '{0}: Invalid file type.' + * @defaultValue {0}: Invalid file type. */ invalidFileTypeMessage?: string | undefined; /** @@ -236,17 +236,17 @@ export interface FileUploadProps { showCancelButton?: boolean | undefined; /** * Icon of the choose button. - * @defaultValue 'pi pi-fw pi-plus' + * @defaultValue pi pi-fw pi-plus */ chooseIcon?: string | undefined; /** * Icon of the upload button. - * @defaultValue 'pi pi-fw pi-upload' + * @defaultValue pi pi-fw pi-upload */ uploadIcon?: string | undefined; /** * Icon of the cancel button. - * @defaultValue 'pi pi-fw pi-times' + * @defaultValue pi pi-fw pi-times */ cancelIcon?: string | undefined; /** diff --git a/components/galleria/Galleria.d.ts b/components/galleria/Galleria.d.ts index a7b4b9a37..deefc784c 100755 --- a/components/galleria/Galleria.d.ts +++ b/components/galleria/Galleria.d.ts @@ -100,12 +100,12 @@ export interface GalleriaProps { showThumbnails?: boolean | undefined; /** * Position of thumbnails. - * @defaultValue 'bottom' + * @defaultValue bottom */ thumbnailsPosition?: 'bottom' | 'top' | 'left' | 'right' | undefined; /** * Height of the viewport in vertical thumbnail. - * @defaultValue '300px' + * @defaultValue 300px */ verticalThumbnailViewPortHeight?: string | undefined; /** @@ -120,7 +120,7 @@ export interface GalleriaProps { showIndicatorsOnItem?: boolean | undefined; /** * Position of indicators. - * @defaultValue 'bottom' + * @defaultValue bottom */ indicatorsPosition?: 'bottom' | 'top' | 'left' | 'right' | undefined; /** diff --git a/components/inlinemessage/InlineMessage.d.ts b/components/inlinemessage/InlineMessage.d.ts index 86c0328b1..b4637494f 100755 --- a/components/inlinemessage/InlineMessage.d.ts +++ b/components/inlinemessage/InlineMessage.d.ts @@ -16,7 +16,7 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; export interface InlineMessageProps { /** * Severity level of the message. - * @defaultValue 'info' + * @defaultValue info */ severity?: 'success' | 'info' | 'warn' | 'error' | undefined; } diff --git a/components/inplace/Inplace.d.ts b/components/inplace/Inplace.d.ts index e60bcc1f4..ed5a00e0c 100755 --- a/components/inplace/Inplace.d.ts +++ b/components/inplace/Inplace.d.ts @@ -31,7 +31,7 @@ export interface InplaceProps { disabled?: boolean | undefined; /** * Icon to display in the close button. - * @defaultValue 'pi pi-times' + * @defaultValue pi pi-times */ closeIcon?: string | undefined; /** diff --git a/components/inputmask/InputMask.d.ts b/components/inputmask/InputMask.d.ts index 42b1ffc4e..b6ceadf06 100755 --- a/components/inputmask/InputMask.d.ts +++ b/components/inputmask/InputMask.d.ts @@ -19,7 +19,7 @@ export interface InputMaskProps { modelValue?: string | undefined; /** * Placeholder character in mask, default is underscore. - * @defaultValue '_' + * @defaultValue _ */ slotChar?: string | undefined; /** diff --git a/components/inputnumber/InputNumber.d.ts b/components/inputnumber/InputNumber.d.ts index b3777e6c5..3c128e6cd 100755 --- a/components/inputnumber/InputNumber.d.ts +++ b/components/inputnumber/InputNumber.d.ts @@ -60,7 +60,7 @@ export interface InputNumberProps { showButtons?: boolean | undefined; /** * Layout of the buttons. - * @defaultValue 'stacked'. + * @defaultValue stacked */ buttonLayout?: 'stacked' | 'horizontal' | 'vertical' | undefined; /** @@ -73,12 +73,12 @@ export interface InputNumberProps { decrementButtonClass?: string | undefined; /** * Style class of the increment button. - * @defaultValue 'pi pi-angle-up' + * @defaultValue pi pi-angle-up */ incrementButtonIcon?: string | undefined; /** * Style class of the decrement button. - * @defaultValue 'pi pi-angle-down' + * @defaultValue pi pi-angle-down */ decrementButtonIcon?: string | undefined; /** @@ -88,12 +88,12 @@ export interface InputNumberProps { /** * The locale matching algorithm to use. Possible values are 'lookup' and 'best fit'; the default is 'best fit'. * See [Locale Negotation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_negotiation) for details. - * @defaultValue 'best fit' + * @defaultValue best fit */ localeMatcher?: 'lookup' | 'best fit' | undefined; /** * Defines the behavior of the component. - * @defaultValue 'decimal'. + * @defaultValue decimal */ mode?: 'decimal' | 'currency' | undefined; /** @@ -111,7 +111,7 @@ export interface InputNumberProps { currency?: string | undefined; /** * How to display the currency in currency formatting. Possible values are 'symbol' to use a localized currency symbol such as €, 'code' to use the ISO currency code, 'name' to use a localized currency name such as 'dollar'. - * @defaultValue 'symbol' + * @defaultValue symbol */ currencyDisplay?: string | undefined; /** diff --git a/components/knob/Knob.d.ts b/components/knob/Knob.d.ts index dc116ce52..c4577edf1 100644 --- a/components/knob/Knob.d.ts +++ b/components/knob/Knob.d.ts @@ -49,17 +49,17 @@ export interface KnobProps { max?: number | undefined; /** * Background of the value. - * @defaultValue 'var(--primary-color, Black)' + * @defaultValue var(--primary-color, Black) */ valueColor?: string | undefined; /** * Background color of the range. - * @defaultValue 'var(--surface-border, LightGray)' + * @defaultValue var(--surface-border, LightGray) */ rangeColor?: string | undefined; /** * Color of the value text. - * @defaultValue 'var(--text-color-secondary, Black)' + * @defaultValue var(--text-color-secondary, Black) */ textColor?: string | undefined; /** @@ -74,7 +74,7 @@ export interface KnobProps { showValue?: boolean | undefined; /** * Template string of the value. - * @defaultValue '{value}' + * @defaultValue {value} */ valueTemplate?: string | undefined; /** diff --git a/components/listbox/Listbox.d.ts b/components/listbox/Listbox.d.ts index 59eb2abd2..03f32f34a 100755 --- a/components/listbox/Listbox.d.ts +++ b/components/listbox/Listbox.d.ts @@ -112,7 +112,7 @@ export interface ListboxProps { filterLocale?: string | undefined; /** * Defines the filtering algorithm to use when searching the options. - * @defaultValue 'contains' + * @defaultValue contains */ filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | undefined; /** @@ -140,27 +140,27 @@ export interface ListboxProps { selectOnFocus?: boolean | undefined; /** * Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration. - * @defaultValue '{0} results are available' + * @defaultValue {0} results are available */ filterMessage?: string | undefined; /** * Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration. - * @defaultValue '{0} items selected' + * @defaultValue {0} items selected */ selectionMessage?: string | undefined; /** * Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No selected item' + * @defaultValue No selected item */ emptySelectionMessage?: string | undefined; /** * Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No results found' + * @defaultValue No results found */ emptyFilterMessage?: string | undefined; /** * Text to display when there are no options available. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No results found' + * @defaultValue No results found */ emptyMessage?: string | undefined; /** @@ -169,7 +169,7 @@ export interface ListboxProps { tabindex?: number | string | undefined; /** * Icon to display in filter input. - * @defaultValue 'ß' + * @defaultValue ß */ filterIcon?: string | undefined; /** diff --git a/components/megamenu/MegaMenu.d.ts b/components/megamenu/MegaMenu.d.ts index 818c16f93..6c7502505 100755 --- a/components/megamenu/MegaMenu.d.ts +++ b/components/megamenu/MegaMenu.d.ts @@ -21,7 +21,7 @@ export interface MegaMenuProps { model?: MenuItem[] | undefined; /** * Defines the orientation. - * @defaultValue 'horizontal' + * @defaultValue horizontal */ orientation?: 'horizontal' | 'vertical' | undefined; /** diff --git a/components/menu/Menu.d.ts b/components/menu/Menu.d.ts index 6f2574459..cc02860cb 100755 --- a/components/menu/Menu.d.ts +++ b/components/menu/Menu.d.ts @@ -26,7 +26,7 @@ export interface MenuProps { popup?: boolean | undefined; /** * A valid query selector or an HTMLElement to specify where the overlay gets attached. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; /** diff --git a/components/message/Message.d.ts b/components/message/Message.d.ts index daa4b750f..0c278e02e 100755 --- a/components/message/Message.d.ts +++ b/components/message/Message.d.ts @@ -16,7 +16,7 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; export interface MessageProps { /** * Severity level of the message. - * @defaultValue 'info' + * @defaultValue info */ severity?: 'success' | 'info' | 'warn' | 'error' | undefined; /** @@ -40,7 +40,7 @@ export interface MessageProps { icon?: string | undefined; /** * Icon to display in the message close button. - * @defaultValue 'pi pi-times' + * @defaultValue pi pi-times */ closeIcon?: string | undefined; /** diff --git a/components/multiselect/MultiSelect.d.ts b/components/multiselect/MultiSelect.d.ts index 9763c4d99..9a478e0fe 100755 --- a/components/multiselect/MultiSelect.d.ts +++ b/components/multiselect/MultiSelect.d.ts @@ -90,7 +90,7 @@ export interface MultiSelectProps { optionGroupChildren?: string | ((data: any) => any[]) | undefined; /** * Height of the viewport, a scrollbar is defined if height of list exceeds this value. - * @defaultValue '200px' + * @defaultValue 200px */ scrollHeight?: string | undefined; /** @@ -149,7 +149,7 @@ export interface MultiSelectProps { filterLocale?: string | undefined; /** * Defines the filtering algorithm to use when searching the options. - * @defaultValue 'contains' + * @defaultValue contains */ filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | undefined; /** @@ -158,17 +158,17 @@ export interface MultiSelectProps { filterFields?: string[] | undefined; /** * 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. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; /** * Defines how the selected items are displayed. - * @defaultValue 'comma' + * @defaultValue comma */ display?: 'comma' | 'chip' | undefined; /** * Label to display after exceeding max selected labels. - * @defaultValue '{0} items selected' + * @defaultValue {0} items selected */ selectedItemsLabel?: string | undefined; /** @@ -191,32 +191,32 @@ export interface MultiSelectProps { loading?: boolean | undefined; /** * Icon to display in the checkboxes. - * @defaultValue 'pi pi-check' + * @defaultValue pi pi-check */ checkboxIcon?: string | undefined; /** * Icon to display in the dropdown close button. - * @defaultValue 'pi pi-times' + * @defaultValue pi pi-times */ closeIcon?: string | undefined; /** * Icon to display in the dropdown. - * @defaultValue 'pi pi-chevron-down' + * @defaultValue pi pi-chevron-down */ dropdownIcon?: string | undefined; /** * Icon to display in filter input. - * @defaultValue 'pi pi-search' + * @defaultValue pi pi-search */ filterIcon?: string | undefined; /** * Icon to display in loading state. - * @defaultValue 'pi pi-spinner pi-spin' + * @defaultValue pi pi-spinner pi-spin */ loadingIcon?: string | undefined; /** * Icon to display in chip remove action. - * @defaultValue 'pi pi-times-circle' + * @defaultValue pi pi-times-circle */ removeTokenIcon?: string | undefined; /** @@ -246,27 +246,27 @@ export interface MultiSelectProps { autoFilterFocus?: boolean | undefined; /** * Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration. - * @defaultValue '{0} results are available' + * @defaultValue {0} results are available */ filterMessage?: string | undefined; /** * Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration. - * @defaultValue '{0} items selected' + * @defaultValue {0} items selected */ selectionMessage?: string | undefined; /** * Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No selected item' + * @defaultValue No selected item */ emptySelectionMessage?: string | undefined; /** * Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No results found' + * @defaultValue No results found */ emptyFilterMessage?: string | undefined; /** * Text to display when there are no options available. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No results found' + * @defaultValue No results found' */ emptyMessage?: string | undefined; /** diff --git a/components/orderlist/OrderList.d.ts b/components/orderlist/OrderList.d.ts index 9495034fb..a7d6f267b 100755 --- a/components/orderlist/OrderList.d.ts +++ b/components/orderlist/OrderList.d.ts @@ -78,7 +78,7 @@ export interface OrderListProps { responsive?: boolean | undefined; /** * The breakpoint to define the maximum width boundary when responsiveness is enabled. - * @defaultValue '960px' + * @defaultValue 960px */ breakpoint?: string | undefined; /** diff --git a/components/overlaypanel/OverlayPanel.d.ts b/components/overlaypanel/OverlayPanel.d.ts index 8ac0209e9..c7c7ab39b 100755 --- a/components/overlaypanel/OverlayPanel.d.ts +++ b/components/overlaypanel/OverlayPanel.d.ts @@ -48,7 +48,7 @@ export interface OverlayPanelProps { showCloseIcon?: boolean; /** * A valid query selector or an HTMLElement to specify where the overlay gets attached. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; /** diff --git a/components/paginator/Paginator.d.ts b/components/paginator/Paginator.d.ts index 90cb676c1..29468da52 100755 --- a/components/paginator/Paginator.d.ts +++ b/components/paginator/Paginator.d.ts @@ -84,7 +84,7 @@ export interface PaginatorProps { * - {last} * - {totalRecords} * - * @defaultValue '({currentPage} of {totalPages})' + * @defaultValue ({currentPage} of {totalPages}) */ currentPageReportTemplate?: string | undefined; /** diff --git a/components/password/Password.d.ts b/components/password/Password.d.ts index 802988cb0..1f2762407 100755 --- a/components/password/Password.d.ts +++ b/components/password/Password.d.ts @@ -24,12 +24,12 @@ export interface PasswordProps extends InputHTMLAttributes { promptLabel?: string | undefined; /** * Regex for a medium level password. - * @defaultValue '^(((?=.*[a-z])(?=.*[A-Z]))|((?=.*[a-z])(?=.*[0-9]))|((?=.*[A-Z])(?=.*[0-9])))(?=.{6,})' + * @defaultValue ^(((?=.*[a-z])(?=.*[A-Z]))|((?=.*[a-z])(?=.*[0-9]))|((?=.*[A-Z])(?=.*[0-9])))(?=.{6,}) */ mediumRegex?: string | undefined; /** * Regex for a strong level password. - * @defaultValue '^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})' + * @defaultValue ^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,}) */ strongRegex?: string | undefined; /** @@ -51,7 +51,7 @@ export interface PasswordProps extends InputHTMLAttributes { feedback?: boolean | undefined; /** * A valid query selector or an HTMLElement to specify where the overlay gets attached. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; /** @@ -61,12 +61,12 @@ export interface PasswordProps extends InputHTMLAttributes { toggleMask?: boolean | undefined; /** * Icon to hide displaying the password as plain text. - * @defaultValue 'pi pi-eye-slash' + * @defaultValue pi pi-eye-slash */ hideIcon?: string | undefined; /** * Icon to show displaying the password as plain text. - * @defaultValue 'pi pi-eye' + * @defaultValue pi pi-eye */ showIcon?: string | undefined; /** diff --git a/components/progressbar/ProgressBar.d.ts b/components/progressbar/ProgressBar.d.ts index f0297306d..954483230 100755 --- a/components/progressbar/ProgressBar.d.ts +++ b/components/progressbar/ProgressBar.d.ts @@ -20,7 +20,7 @@ export interface ProgressBarProps { value?: number | undefined; /** * Defines the mode of the progress - * @defaultValue 'determinate' + * @defaultValue determinate */ mode?: 'determinate' | 'indeterminate' | undefined; /** diff --git a/components/progressspinner/ProgressSpinner.d.ts b/components/progressspinner/ProgressSpinner.d.ts index 10ba0b33b..533875822 100755 --- a/components/progressspinner/ProgressSpinner.d.ts +++ b/components/progressspinner/ProgressSpinner.d.ts @@ -15,7 +15,7 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; export interface ProgressSpinnerProps { /** * Width of the circle stroke. - * @defaultValue '2' + * @defaultValue 2 */ strokeWidth?: string | undefined; /** @@ -24,7 +24,7 @@ export interface ProgressSpinnerProps { fill?: string | undefined; /** * Duration of the rotate animation. - * @defaultValue '2s' + * @defaultValue 2s */ animationDuration?: string | undefined; } diff --git a/components/rating/Rating.d.ts b/components/rating/Rating.d.ts index e59d68112..2c07f073b 100755 --- a/components/rating/Rating.d.ts +++ b/components/rating/Rating.d.ts @@ -59,17 +59,17 @@ export interface RatingProps { cancel?: boolean | undefined; /** * Icon for the on state. - * @defaultValue 'pi pi-star' + * @defaultValue pi pi-star */ onIcon?: string | undefined; /** * Icon for the off state. - * @defaultValue 'pi pi-star-fill' + * @defaultValue pi pi-star-fill */ offIcon?: string | undefined; /** * Icon for the cancelable state. - * @defaultValue 'pi pi-ban' + * @defaultValue pi pi-ban */ cancelIcon?: string | undefined; } diff --git a/components/scrolltop/ScrollTop.d.ts b/components/scrolltop/ScrollTop.d.ts index 344dc7f27..0cebe8d90 100644 --- a/components/scrolltop/ScrollTop.d.ts +++ b/components/scrolltop/ScrollTop.d.ts @@ -15,7 +15,7 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; export interface ScrollTopProps { /** * Target of the ScrollTop. - * @defaultValue 'window' + * @defaultValue window */ target?: 'window' | 'parent' | undefined; /** @@ -25,12 +25,12 @@ export interface ScrollTopProps { threshold?: number | undefined; /** * Icon to display. - * @defaultValue 'pi pi-chevron-up' + * @defaultValue pi pi-chevron-up */ icon?: string | undefined; /** * Defines the scrolling behaviour, 'smooth' adds an animation and 'auto' scrolls with a jump. - * @defaultValue 'smooth' + * @defaultValue smooth */ behavior?: string | undefined; } diff --git a/components/sidebar/Sidebar.d.ts b/components/sidebar/Sidebar.d.ts index 0f8811d62..4209543a8 100755 --- a/components/sidebar/Sidebar.d.ts +++ b/components/sidebar/Sidebar.d.ts @@ -21,7 +21,7 @@ export interface SidebarProps { visible?: boolean | undefined; /** * Specifies the position of the sidebar. - * @defaultValue 'left' + * @defaultValue left */ position?: 'left' | 'right' | 'top' | 'bottom' | 'full' | undefined; /** @@ -46,7 +46,7 @@ export interface SidebarProps { showCloseIcon?: boolean | undefined; /** * Icon to display in the sidebar close button. - * @defaultValue 'pi pi-times' + * @defaultValue pi pi-times */ closeIcon?: string | undefined; /** diff --git a/components/skeleton/Skeleton.d.ts b/components/skeleton/Skeleton.d.ts index 99efb76d5..26b507822 100644 --- a/components/skeleton/Skeleton.d.ts +++ b/components/skeleton/Skeleton.d.ts @@ -15,7 +15,7 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; export interface SkeletonProps { /** * Shape of the element. - * @defaultValue 'rectangle' + * @defaultValue rectangle */ shape?: 'rectangle' | 'circle' | undefined; /** @@ -24,12 +24,12 @@ export interface SkeletonProps { size?: string | undefined; /** * Width of the element. - * @defaultValue '100%' + * @defaultValue 100% */ width?: string | undefined; /** * Height of the element. - * @defaultValue '1rem' + * @defaultValue 1rem */ height?: string | undefined; /** @@ -38,7 +38,7 @@ export interface SkeletonProps { borderRadius?: string | undefined; /** * Type of the animation. - * @defaultValue 'wave' + * @defaultValue wave */ animation?: 'wave' | 'none' | undefined; } diff --git a/components/slider/Slider.d.ts b/components/slider/Slider.d.ts index 51e48b0ff..c31c7b4d9 100755 --- a/components/slider/Slider.d.ts +++ b/components/slider/Slider.d.ts @@ -44,7 +44,7 @@ export interface SliderProps { max?: number | undefined; /** * Orientation of the slider. - * @defaultValue 'horizontal' + * @defaultValue horizontal */ orientation?: 'horizontal' | 'vertical' | undefined; /** diff --git a/components/speeddial/SpeedDial.d.ts b/components/speeddial/SpeedDial.d.ts index 9b9736d86..b0cf692fd 100644 --- a/components/speeddial/SpeedDial.d.ts +++ b/components/speeddial/SpeedDial.d.ts @@ -22,7 +22,7 @@ export interface SpeedDialTooltipOptions { event: 'hover' | 'focus' | undefined; /** * Position of element. - * @defaultValue 'bottom'. + * @defaultValue bottom */ position: 'bottom' | 'top' | 'left' | 'right' | undefined; /** @@ -46,7 +46,7 @@ export interface SpeedDialProps { visible?: boolean | undefined; /** * Specifies the opening direction of actions. - * @defaultValue 'up' + * @defaultValue up */ direction?: 'up' | 'down' | 'left' | 'right' | 'up-left' | 'up-right' | 'down-left' | 'down-right' | undefined; /** @@ -56,7 +56,7 @@ export interface SpeedDialProps { transitionDelay?: number | undefined; /** * Specifies the opening type of actions. - * @defaultValue 'linear' + * @defaultValue linear */ type?: 'linear' | 'circle' | 'semi-circle' | 'quarter-circle' | undefined; /** @@ -93,7 +93,7 @@ export interface SpeedDialProps { maskClass?: string | undefined; /** * Show icon of the button element. - * @defaultValue 'pi pi-plus' + * @defaultValue pi pi-plus */ showIcon?: string | undefined; /** diff --git a/components/splitbutton/SplitButton.d.ts b/components/splitbutton/SplitButton.d.ts index 543805207..ccb4a97f3 100755 --- a/components/splitbutton/SplitButton.d.ts +++ b/components/splitbutton/SplitButton.d.ts @@ -40,7 +40,7 @@ export interface SplitButtonProps { /** * 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. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; /** diff --git a/components/splitter/Splitter.d.ts b/components/splitter/Splitter.d.ts index cbe973156..ae979761b 100644 --- a/components/splitter/Splitter.d.ts +++ b/components/splitter/Splitter.d.ts @@ -60,7 +60,7 @@ export interface SplitterProps { stateKey?: string | undefined; /** * Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage. - * @defaultValue 'session' + * @defaultValue session */ stateStorage?: 'local' | 'session' | undefined; /** diff --git a/components/tieredmenu/TieredMenu.d.ts b/components/tieredmenu/TieredMenu.d.ts index 8e7b207ec..b95ca55e1 100755 --- a/components/tieredmenu/TieredMenu.d.ts +++ b/components/tieredmenu/TieredMenu.d.ts @@ -25,7 +25,7 @@ export interface TieredMenuProps { popup?: boolean | undefined; /** * A valid query selector or an HTMLElement to specify where the overlay gets attached. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; /** diff --git a/components/timeline/Timeline.d.ts b/components/timeline/Timeline.d.ts index fb957ff08..2639531b2 100644 --- a/components/timeline/Timeline.d.ts +++ b/components/timeline/Timeline.d.ts @@ -19,12 +19,12 @@ export interface TimelineProps { value?: any[] | undefined; /** * Position of the timeline bar relative to the content. - * @defaultValue 'left' + * @defaultValue left */ align?: 'left' | 'right' | 'alternate' | 'top' | 'bottom' | undefined; /** * Orientation of the timeline. - * @defaultValue 'horizontal' + * @defaultValue horizontal */ layout?: 'vertical' | 'horizontal' | undefined; /** diff --git a/components/toast/Toast.d.ts b/components/toast/Toast.d.ts index 72fead832..b1a1cd3a2 100755 --- a/components/toast/Toast.d.ts +++ b/components/toast/Toast.d.ts @@ -16,7 +16,7 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; export interface ToastMessageOptions { /** * Severity level of the message. - * @defaultValue 'info' + * @defaultValue info */ severity?: 'success' | 'info' | 'warn' | 'error' | undefined; /** diff --git a/components/togglebutton/ToggleButton.d.ts b/components/togglebutton/ToggleButton.d.ts index 956819a19..f9198041f 100755 --- a/components/togglebutton/ToggleButton.d.ts +++ b/components/togglebutton/ToggleButton.d.ts @@ -39,7 +39,7 @@ export interface ToggleButtonProps { offLabel?: string | undefined; /** * Position of the icon. - * @defaultValue 'left' + * @defaultValue left */ iconPos?: 'left' | 'right' | undefined; /** diff --git a/components/tree/Tree.d.ts b/components/tree/Tree.d.ts index 50ad484ec..d7b06ea5e 100755 --- a/components/tree/Tree.d.ts +++ b/components/tree/Tree.d.ts @@ -121,7 +121,7 @@ export interface TreeProps { loading?: boolean | undefined; /** * Icon to display when tree is loading. - * @defaultValue 'pi pi-spin' + * @defaultValue pi pi-spin */ loadingIcon?: string | undefined; /** @@ -130,12 +130,12 @@ export interface TreeProps { filter?: boolean | undefined; /** * When filtering is enabled, filterBy decides which field or fields (comma separated) to search against. - * @defaultValue 'label' + * @defaultValue label */ filterBy?: string | undefined; /** * Mode for filtering. - * @defaultValue 'lenient' + * @defaultValue lenient */ filterMode?: 'lenient' | 'strict' | undefined; /** diff --git a/components/treeselect/TreeSelect.d.ts b/components/treeselect/TreeSelect.d.ts index b06d53a5f..f6da2f693 100644 --- a/components/treeselect/TreeSelect.d.ts +++ b/components/treeselect/TreeSelect.d.ts @@ -25,7 +25,7 @@ export interface TreeSelectProps { options?: TreeNode[] | undefined; /** * Height of the viewport, a scrollbar is defined if height of list exceeds this value. - * @defaultValue '200px' + * @defaultValue 200px */ scrollHeight?: string | undefined; /** @@ -51,17 +51,17 @@ export interface TreeSelectProps { panelClass?: any; /** * A valid query selector or an HTMLElement to specify where the overlay gets attached. - * @defaultValue 'body' + * @defaultValue body */ appendTo?: 'body' | 'self' | string | undefined | HTMLElement; /** * Text to display when there are no options available. Defaults to value from PrimeVue locale configuration. - * @defaultValue 'No results found' + * @defaultValue No results found */ emptyMessage?: string | undefined; /** * Defines how the selected items are displayed. - * @defaultValue 'comma' + * @defaultValue comma */ display?: 'comma' | 'chip' | undefined; /** diff --git a/components/treetable/TreeTable.d.ts b/components/treetable/TreeTable.d.ts index 5c58a5f45..088b1527c 100755 --- a/components/treetable/TreeTable.d.ts +++ b/components/treetable/TreeTable.d.ts @@ -221,7 +221,7 @@ export interface TreeTableProps { * - JumpToPageInput * - CurrentPageReport * - * @defaultValue 'FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown' + * @defaultValue FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown */ paginatorTemplate?: string | undefined; /** @@ -243,7 +243,7 @@ export interface TreeTableProps { * - {last} * - {totalRecords} * - * @defaultValue '({currentPage} of {totalPages})' + * @defaultValue ({currentPage} of {totalPages}) */ currentPageReportTemplate?: string | undefined; /** @@ -258,7 +258,7 @@ export interface TreeTableProps { loading?: boolean | undefined; /** * The icon to show while indicating data load is in progress. - * @defaultValue 'pi pi-spinner' + * @defaultValue pi pi-spinner */ loadingIcon?: string | undefined; /** @@ -290,7 +290,7 @@ export interface TreeTableProps { multiSortMeta?: TreeTableSortMeta[] | undefined | null; /** * Defines whether sorting works on single column or on multiple columns. - * @defaultValue 'single' + * @defaultValue single */ sortMode?: 'single' | 'multiple' | undefined; /** @@ -305,7 +305,7 @@ export interface TreeTableProps { filters?: TreeTableFilterMeta; /** * Mode for filtering. - * @defaultValue 'lenient' + * @defaultValue lenient */ filterMode?: 'lenient' | 'strict' | undefined; /** @@ -318,7 +318,7 @@ export interface TreeTableProps { resizableColumns?: boolean | undefined; /** * Defines whether the overall table width should change on column resize. - * @defaultValue 'fit' + * @defaultValue fit */ columnResizeMode?: 'fit' | 'expand' | undefined; /** @@ -342,12 +342,12 @@ export interface TreeTableProps { scrollHeight?: 'flex' | string | undefined; /** * Orientation of the scrolling. - * @defaultValue 'vertical' + * @defaultValue vertical */ scrollDirection?: 'vertical' | 'horizontal' | 'both' | undefined; /** * Defines the responsive mode, currently only option is scroll. - * @defaultValue 'stack' + * @defaultValue stack */ responsiveLayout?: 'stack' | 'scroll' | undefined; /** diff --git a/components/virtualscroller/VirtualScroller.d.ts b/components/virtualscroller/VirtualScroller.d.ts index 68fb2029c..16cfe89d9 100644 --- a/components/virtualscroller/VirtualScroller.d.ts +++ b/components/virtualscroller/VirtualScroller.d.ts @@ -188,7 +188,7 @@ export interface VirtualScrollerProps { onLazyLoad?(event: VirtualScrollerLazyEvent): void; /** * Index of the element in tabbing order. - * @defaultValue 0. + * @defaultValue 0 */ tabindex?: number | string | undefined; /**