From 95d3740f638341f6eaf6c7b29006fd35ceb9cebb 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: Fri, 3 Mar 2023 11:18:55 +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/button/Button.d.ts | 2 +- components/calendar/Calendar.d.ts | 18 +- components/carousel/Carousel.d.ts | 2 +- components/cascadeselect/CascadeSelect.d.ts | 18 +- components/chips/Chips.d.ts | 4 +- components/contextmenu/ContextMenu.d.ts | 2 +- components/datatable/DataTable.d.ts | 22 +- components/dataview/DataView.d.ts | 6 +- components/dialog/Dialog.d.ts | 10 +- components/divider/Divider.d.ts | 6 +- components/dock/Dock.d.ts | 4 +- components/dropdown/Dropdown.d.ts | 24 +- components/fileupload/FileUpload.d.ts | 15 +- components/galleria/Galleria.d.ts | 6 +- 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/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/timeline/Timeline.d.ts | 4 +- components/toast/Toast.d.ts | 6 +- components/togglebutton/ToggleButton.d.ts | 2 +- components/tree/Tree.d.ts | 6 +- components/treeselect/TreeSelect.d.ts | 8 +- components/treetable/TreeTable.d.ts | 16 +- doc/common/apidoc/index.json | 435 +++++++++--------- 46 files changed, 396 insertions(+), 380 deletions(-) diff --git a/components/accordion/Accordion.d.ts b/components/accordion/Accordion.d.ts index ef3c75533..22b4578e3 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 f54c6e4f4..5c1d6808b 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 3eaef7fdc..222a89e58 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/button/Button.d.ts b/components/button/Button.d.ts index 9178749f5..e2c1361de 100755 --- a/components/button/Button.d.ts +++ b/components/button/Button.d.ts @@ -32,7 +32,7 @@ export interface ButtonProps extends ButtonHTMLAttributes { icon?: string | undefined; /** * Position of the icon. - * @defaultValue left + * @defaultValue 'left' */ iconPos?: 'left' | 'right' | 'top' | 'bottom' | undefined; /** diff --git a/components/calendar/Calendar.d.ts b/components/calendar/Calendar.d.ts index ce0d528b6..a9ccd2f10 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 dc24c2da2..873457230 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 8231715f6..60dc2613f 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 ed57b4ecc..9a524c2bb 100755 --- a/components/chips/Chips.d.ts +++ b/components/chips/Chips.d.ts @@ -50,7 +50,7 @@ export interface ChipsProps { addOnBlur?: boolean | undefined; /** * Whether to allow duplicate values or not. - * Default value is true. + * @defaultValue true. */ allowDuplicate?: boolean | undefined; /** @@ -75,7 +75,7 @@ export interface ChipsProps { inputProps?: InputHTMLAttributes | undefined; /** * Icon to display in chip remove action. - * Default value is 'pi pi-times-circle'. + * @defaultValue 'pi pi-times-circle' */ removeTokenIcon?: string | undefined; /** diff --git a/components/contextmenu/ContextMenu.d.ts b/components/contextmenu/ContextMenu.d.ts index ab3dd55af..719df7294 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/datatable/DataTable.d.ts b/components/datatable/DataTable.d.ts index 9fe88af01..712fd709f 100755 --- a/components/datatable/DataTable.d.ts +++ b/components/datatable/DataTable.d.ts @@ -612,7 +612,7 @@ export interface DataTableProps { 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; /** @@ -634,7 +634,7 @@ export interface DataTableProps { multiSortMeta?: DataTableSortMeta[] | undefined; /** * Defines whether sorting works on single column or on multiple columns. - * @defaultValue single + * @defaultValue 'single' */ sortMode?: 'single' | 'multiple' | undefined; /** @@ -669,7 +669,7 @@ export interface DataTableProps { selectionMode?: 'single' | 'multiple' | undefined; /** * Algorithm to define if a row is selected. - * @defaultValue deepEquals + * @defaultValue 'deepEquals' */ compareSelectionBy?: 'equals' | 'deepEquals' | undefined; /** @@ -698,12 +698,12 @@ export interface DataTableProps { rowHover?: boolean | undefined; /** * Character to use as the csv separator. - * @defaultValue , + * @defaultValue ',' */ csvSeparator?: string | undefined; /** * Name of the exported file. - * @defaultValue download + * @defaultValue 'download' */ exportFilename?: string | undefined; /** @@ -717,7 +717,7 @@ export interface DataTableProps { resizableColumns?: boolean | undefined; /** * Defines whether the overall table width. - * @defaultValue fit + * @defaultValue 'fit' */ columnResizeMode?: 'fit' | 'expand' | undefined; /** @@ -731,12 +731,12 @@ export interface DataTableProps { expandedRows?: any[] | DataTableExpandedRows | null; /** * Icon of the row toggler to display the row as expanded. - * @defaultValue pi-chevron-down + * @defaultValue 'pi-chevron-down' */ expandedRowIcon?: string | undefined; /** * Icon of the row toggler to display the row as collapsed. - * @defaultValue pi-chevron-right + * @defaultValue 'pi-chevron-right' */ collapsedRowIcon?: string | undefined; /** @@ -758,7 +758,7 @@ export interface DataTableProps { expandedRowGroups?: any[] | DataTableExpandedRows; /** * Defines where a stateful table keeps its state. - * @defaultValue session + * @defaultValue 'session' */ stateStorage?: 'session' | 'local' | undefined; /** @@ -766,7 +766,7 @@ export interface DataTableProps { */ stateKey?: string | undefined; /** - * Defines the incell editing mode, valid options are 'cell' and 'row'. + * Defines the incell editing mode. */ editMode?: 'cell' | 'row' | undefined; /** @@ -801,7 +801,7 @@ export interface DataTableProps { frozenValue?: any[] | undefined | null; /** * The breakpoint to define the maximum width boundary when using stack responsive layout. - * @defaultValue 960px + * @defaultValue '960px' */ breakpoint?: string | undefined; /** diff --git a/components/dataview/DataView.d.ts b/components/dataview/DataView.d.ts index 53e81d452..3b2b77bd1 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 bc24c3541..a85ade092 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 36d95b0ef..245a66f0b 100644 --- a/components/divider/Divider.d.ts +++ b/components/divider/Divider.d.ts @@ -15,17 +15,17 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; */ 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. */ 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 a2258e03d..2628c72c5 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 718880f6b..c629b6f13 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 found' */ emptyMessage?: string | undefined; /** diff --git a/components/fileupload/FileUpload.d.ts b/components/fileupload/FileUpload.d.ts index 5e5e827e5..31671f5ad 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; /** @@ -222,7 +222,6 @@ export interface FileUploadProps { cancelLabel?: string | undefined; /** * Whether to use the default upload or a manual implementation defined in uploadHandler callback. Defaults to PrimeVue Locale configuration. - * @defaultValue false */ customUpload?: boolean | undefined; /** @@ -237,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 8bc635e60..1c921aa40 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/inplace/Inplace.d.ts b/components/inplace/Inplace.d.ts index ed5a00e0c..e60bcc1f4 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 cec986ff4..ea1944c43 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 ebfdd4b33..44f236e49 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. - * Default value is 'stacked'. + * @defaultValue 'stacked'. */ buttonLayout?: 'stacked' | 'horizontal' | 'vertical' | undefined; /** @@ -73,12 +73,12 @@ export interface InputNumberProps { decrementButtonClass?: string | undefined; /** * Style class of the increment button. - * Default value is 'pi pi-angle-up'. + * @defaultValue 'pi pi-angle-up' */ incrementButtonIcon?: string | undefined; /** * Style class of the decrement button. - * Default value is '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. - * Default value is 'best fit' + * @defaultValue 'best fit' */ localeMatcher?: 'lookup' | 'best fit' | undefined; /** * Defines the behavior of the component. - * Default value is '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'. - * Default value is 'symbol'. + * @defaultValue 'symbol' */ currencyDisplay?: string | undefined; /** diff --git a/components/knob/Knob.d.ts b/components/knob/Knob.d.ts index d6f08c4fd..50acaff31 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 eb874d138..d0a8e45a0 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 pi pi-search + * @defaultValue 'ß' */ filterIcon?: string | undefined; /** diff --git a/components/megamenu/MegaMenu.d.ts b/components/megamenu/MegaMenu.d.ts index feeb19f37..83559f214 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 f157a6c8b..65dfbdeca 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/multiselect/MultiSelect.d.ts b/components/multiselect/MultiSelect.d.ts index 0c054bc7d..f80ea9426 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 67decbc30..f29e7024a 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 18a7ad51e..2c3662d5e 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 29468da52..90cb676c1 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 1f2762407..802988cb0 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 954483230..f0297306d 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 533875822..10ba0b33b 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 d89ee1f14..a052fa45c 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 0cebe8d90..344dc7f27 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 05af1773e..ae695dc58 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 26b507822..99efb76d5 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 81e00685b..b4835560e 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 68c262d7d..0d255cd09 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. - * Default value is '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 6253d63be..54b555aa5 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 e85f08a27..d38bce405 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/timeline/Timeline.d.ts b/components/timeline/Timeline.d.ts index 7bd5e28a3..01fcdf658 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 76cd4f6b1..52d05085d 100755 --- a/components/toast/Toast.d.ts +++ b/components/toast/Toast.d.ts @@ -13,7 +13,7 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; export interface ToastMessageOptions { /** * Severity level of the message. - * Default value is 'info'. + * @defaultValue 'info' */ severity?: 'success' | 'info' | 'warn' | 'error' | undefined; /** @@ -26,12 +26,12 @@ export interface ToastMessageOptions { detail?: any | undefined; /** * Whether the message can be closed manually using the close icon. - * Default value is true. + * @defaultValue true */ closable?: boolean | undefined; /** * Delay in milliseconds to close the message automatically. - * Default value is 3000. + * @defaultValue 3000 */ life?: number | undefined; /** diff --git a/components/togglebutton/ToggleButton.d.ts b/components/togglebutton/ToggleButton.d.ts index 2c3c0e47c..835cfc746 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 b10a23491..c7c6f77df 100755 --- a/components/tree/Tree.d.ts +++ b/components/tree/Tree.d.ts @@ -120,7 +120,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; /** @@ -129,12 +129,12 @@ export interface TreeProps { filter?: boolean | undefined; /** * When filtering is enabled, filterBy decides which field or fields (comma separated) to search against. - * Default valye is '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 f6da2f693..b06d53a5f 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 9d1d1ca7e..bd4a92592 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/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index c9d744db4..a1229bbe0 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -118,7 +118,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-chevron-down", + "default": "'pi pi-chevron-down'", "description": "Icon of an expanded tab." }, { @@ -126,7 +126,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-chevron-right", + "default": "'pi pi-chevron-right'", "description": "Icon of a collapsed tab." }, { @@ -2636,7 +2636,7 @@ "optional": true, "readonly": false, "type": "string | HTMLElement", - "default": "body", + "default": "'body'", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached.\nSpecial keywords are 'body' for document body and 'self' for the element itself." }, { @@ -2732,7 +2732,7 @@ "optional": true, "readonly": false, "type": "\"blank\" | \"current\"", - "default": "blank", + "default": "'blank'", "description": "Specifies the behavior dropdown button. Default 'blank' mode sends an empty string and 'current' mode sends the input value." }, { @@ -2740,7 +2740,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No results found", + "default": "'No results found'", "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." }, { @@ -2748,7 +2748,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No selected item", + "default": "'No selected item'", "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." }, { @@ -2804,7 +2804,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-spinner pi-spin", + "default": "'pi pi-spinner pi-spin'", "description": "Icon to display in loading state." }, { @@ -2900,7 +2900,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-times-circle", + "default": "'pi pi-times-circle'", "description": "Icon to display in chip remove action." }, { @@ -2908,7 +2908,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "200px", + "default": "'200px'", "description": "Maximum height of the suggestions panel." }, { @@ -2924,7 +2924,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "results are available", + "default": "'{0} results are available'", "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration." }, { @@ -2940,7 +2940,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "items selected", + "default": "'{0} items selected'", "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." }, { @@ -3171,7 +3171,7 @@ "optional": true, "readonly": false, "type": "\"square\" | \"circle\"", - "default": "square", + "default": "'square'", "description": "Shape of the element." }, { @@ -3179,7 +3179,7 @@ "optional": true, "readonly": false, "type": "\"normal\" | \"large\" | \"xlarge\"", - "default": "normal", + "default": "'normal'", "description": "Size of the element." } ], @@ -3651,7 +3651,7 @@ "optional": true, "readonly": false, "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", - "default": "left", + "default": "'left'", "description": "Position of the icon." }, { @@ -3984,7 +3984,7 @@ "optional": true, "readonly": false, "type": "string | HTMLElement", - "default": "body", + "default": "'body'", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { @@ -4032,7 +4032,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-chevron-down", + "default": "'pi pi-chevron-down'", "description": "Icon to show in each of the decrement buttons." }, { @@ -4088,7 +4088,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-calendar", + "default": "'pi pi-calendar'", "description": "Icon of the calendar button." }, { @@ -4104,7 +4104,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-chevron-up", + "default": "'pi pi-chevron-up'", "description": "Icon to show in each of the increment buttons." }, { @@ -4200,7 +4200,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-chevron-right", + "default": "'pi pi-chevron-right'", "description": "Icon to show in the next button." }, { @@ -4248,7 +4248,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-chevron-left", + "default": "'pi pi-chevron-left'", "description": "Icon to show in the previous button." }, { @@ -4288,7 +4288,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "+10", + "default": "'+10'", "description": "The cutoff year for determining the century for a date." }, { @@ -4384,7 +4384,7 @@ "optional": true, "readonly": false, "type": "string", - "default": ":", + "default": "':'", "description": "Separator of time selector." }, { @@ -4400,7 +4400,7 @@ "optional": true, "readonly": false, "type": "\"month\" | \"year\" | \"date\"", - "default": "date", + "default": "'date'", "description": "Type of view to display." }, { @@ -4751,7 +4751,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "300px", + "default": "'300px'", "description": "Height of the viewport in vertical layout." } ], @@ -5007,7 +5007,7 @@ "optional": true, "readonly": false, "type": "string | HTMLElement", - "default": "body", + "default": "'body'", "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." }, { @@ -5055,7 +5055,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-chevron-down", + "default": "'pi pi-chevron-down'", "description": "Icon to display in the dropdown." }, { @@ -5063,7 +5063,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No available options", + "default": "'No available options'", "description": "Text to be displayed when there are no options available. Defaults to value from PrimeVue locale configuration." }, { @@ -5071,7 +5071,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No results found", + "default": "'No results found'", "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." }, { @@ -5079,7 +5079,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No selected item", + "default": "'No selected item'", "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." }, { @@ -5127,7 +5127,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-spinner pi-spin", + "default": "'pi pi-spinner pi-spin'", "description": "Icon to display in loading state." }, { @@ -5159,7 +5159,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-angle-right", + "default": "'pi pi-angle-right'", "description": "Icon to display in the option group." }, { @@ -5239,7 +5239,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "results are available", + "default": "'{0} results are available'", "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration." }, { @@ -5255,7 +5255,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "items selected", + "default": "'{0} items selected'", "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." }, { @@ -5919,8 +5919,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to allow duplicate values or not.\nDefault value is true." + "default": "true.", + "description": "Whether to allow duplicate values or not." }, { "name": "aria-label", @@ -6007,8 +6007,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in chip remove action.\nDefault value is 'pi pi-times-circle'." + "default": "'pi pi-times-circle'", + "description": "Icon to display in chip remove action." }, { "name": "separator", @@ -7441,7 +7441,7 @@ "optional": true, "readonly": false, "type": "string | HTMLElement", - "default": "body", + "default": "'body'", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { @@ -8878,7 +8878,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "960px", + "default": "'960px'", "description": "The breakpoint to define the maximum width boundary when using stack responsive layout." }, { @@ -8886,7 +8886,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi-chevron-right", + "default": "'pi-chevron-right'", "description": "Icon of the row toggler to display the row as collapsed." }, { @@ -8894,7 +8894,7 @@ "optional": true, "readonly": false, "type": "\"fit\" | \"expand\"", - "default": "fit", + "default": "'fit'", "description": "Defines whether the overall table width." }, { @@ -8902,7 +8902,7 @@ "optional": true, "readonly": false, "type": "\"equals\" | \"deepEquals\"", - "default": "deepEquals", + "default": "'deepEquals'", "description": "Algorithm to define if a row is selected." }, { @@ -8926,7 +8926,7 @@ "optional": true, "readonly": false, "type": "string", - "default": ",", + "default": "','", "description": "Character to use as the csv separator." }, { @@ -8959,7 +8959,7 @@ "readonly": false, "type": "\"cell\" | \"row\"", "default": "", - "description": "Defines the incell editing mode, valid options are 'cell' and 'row'." + "description": "Defines the incell editing mode." }, { "name": "editingRows", @@ -8990,7 +8990,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi-chevron-down", + "default": "'pi-chevron-down'", "description": "Icon of the row toggler to display the row as expanded." }, { @@ -9006,7 +9006,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "download", + "default": "'download'", "description": "Name of the exported file." }, { @@ -9094,7 +9094,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-spinner", + "default": "'pi pi-spinner'", "description": "The icon to show while indicating data load is in progress." }, { @@ -9277,7 +9277,7 @@ "optional": true, "readonly": false, "type": "\"multiple\" | \"single\"", - "default": "single", + "default": "'single'", "description": "Defines whether sorting works on single column or on multiple columns." }, { @@ -9301,7 +9301,7 @@ "optional": true, "readonly": false, "type": "\"local\" | \"session\"", - "default": "session", + "default": "'session'", "description": "Defines where a stateful table keeps its state." }, { @@ -9900,7 +9900,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "({currentPage} of {totalPages})", + "default": "'({currentPage} of {totalPages})'", "description": "Template of the current page report element. It displays information about the pagination state.\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" }, { @@ -9924,7 +9924,7 @@ "optional": true, "readonly": false, "type": "\"grid\" | \"list\"", - "default": "list", + "default": "'list'", "description": "Layout of the items, valid values are 'list' and 'grid'." }, { @@ -9956,7 +9956,7 @@ "optional": true, "readonly": false, "type": "\"both\" | \"top\" | \"bottom\"", - "default": "bottom", + "default": "'bottom'", "description": "Position of the paginator, options are 'top','bottom' or 'both'." }, { @@ -10294,7 +10294,7 @@ "optional": true, "readonly": false, "type": "string | HTMLElement", - "default": "body", + "default": "'body'", "description": "A valid query selector or an HTMLElement to specify where the dialog gets attached." }, { @@ -10334,7 +10334,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-times", + "default": "'pi pi-times'", "description": "Icon to display in the dialog close button." }, { @@ -10422,7 +10422,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-window-maximize", + "default": "'pi pi-window-maximize'", "description": "Icon to display in the dialog maximize button when dialog is not maximized." }, { @@ -10446,7 +10446,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-window-minimize", + "default": "'pi pi-window-minimize'", "description": "Icon to display in the dialog maximize button when dialog is maximized." }, { @@ -10462,7 +10462,7 @@ "optional": true, "readonly": false, "type": "\"center\" | \"left\" | \"top\" | \"bottom\" | \"right\" | \"topleft\" | \"topright\" | \"bottomleft\" | \"bottomright\"", - "default": "center", + "default": "'center'", "description": "Position of the dialog." }, { @@ -10587,14 +10587,14 @@ "readonly": false, "type": "\"center\" | \"left\" | \"top\" | \"bottom\" | \"right\"", "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." }, { "name": "layout", "optional": true, "readonly": false, "type": "\"horizontal\" | \"vertical\"", - "default": "horizontal", + "default": "'horizontal'", "description": "Specifies the orientation, valid values are 'horizontal' and 'vertical'." }, { @@ -10602,7 +10602,7 @@ "optional": true, "readonly": false, "type": "\"dashed\" | \"dotted\" | \"solid\"", - "default": "solid", + "default": "'solid'", "description": "Border style type." } ], @@ -10733,7 +10733,7 @@ "optional": true, "readonly": false, "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", - "default": "bottom", + "default": "'bottom'", "description": "Position of element." }, { @@ -10813,7 +10813,7 @@ "optional": false, "readonly": false, "type": "undefined | \"left\" | \"top\" | \"bottom\" | \"right\"", - "default": "bottom", + "default": "'bottom'", "description": "Position of element." }, { @@ -10998,7 +10998,7 @@ "optional": true, "readonly": false, "type": "string | HTMLElement", - "default": "body", + "default": "'body'", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { @@ -11038,7 +11038,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-times", + "default": "'pi pi-times'", "description": "Icon to display in clear button." }, { @@ -11070,7 +11070,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-chevron-down", + "default": "'pi pi-chevron-down'", "description": "Icon to display in the dropdown." }, { @@ -11086,7 +11086,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No results found", + "default": "'No results found'", "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." }, { @@ -11094,7 +11094,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No results found", + "default": "'No results found'", "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration." }, { @@ -11102,7 +11102,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No selected item", + "default": "'No selected item'", "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." }, { @@ -11126,7 +11126,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-search", + "default": "'pi pi-search'", "description": "Icon to display in filter input." }, { @@ -11150,7 +11150,7 @@ "optional": true, "readonly": false, "type": "\"endsWith\" | \"startsWith\" | \"contains\"", - "default": "contains", + "default": "'contains'", "description": "Defines the filtering algorithm to use when searching the options." }, { @@ -11158,7 +11158,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "{0} results are available", + "default": "'{0} results are available'", "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration." }, { @@ -11214,7 +11214,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-spinner pi-spin", + "default": "'pi pi-spinner pi-spin'", "description": "Icon to display in loading state." }, { @@ -11318,7 +11318,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "200px", + "default": "'200px'", "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value." }, { @@ -11334,7 +11334,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "{0} items selected", + "default": "'{0} items selected'", "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." }, { @@ -12343,7 +12343,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-fw pi-times", + "default": "'pi pi-fw pi-times'", "description": "Icon of the cancel button." }, { @@ -12359,7 +12359,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-fw pi-plus", + "default": "'pi pi-fw pi-plus'", "description": "Icon of the choose button." }, { @@ -12383,7 +12383,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "false", + "default": "", "description": "Whether to use the default upload or a manual implementation defined in uploadHandler callback. Defaults to PrimeVue Locale configuration." }, { @@ -12407,7 +12407,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "Maximum number of files to be uploaded is {0}.", + "default": "'Maximum number of files to be uploaded is {0.}'", "description": "Message to display when number of files to be uploaded exceeeds the limit." }, { @@ -12415,7 +12415,7 @@ "optional": true, "readonly": false, "type": "string", - "default": ": Invalid file size, file size should be smaller than {1}.", + "default": "'{0}: Invalid file size, file size should be smaller than {1.}'", "description": "Message of the invalid fize size." }, { @@ -12423,7 +12423,7 @@ "optional": true, "readonly": false, "type": "string", - "default": ": Invalid file type.", + "default": "'{0}: Invalid file type.'", "description": "Message of the invalid fize type." }, { @@ -12439,7 +12439,7 @@ "optional": true, "readonly": false, "type": "\"basic\" | \"advanced\"", - "default": "advanced", + "default": "'advanced'", "description": "Defines the UI of the component, possible values are 'advanced' and 'basic'." }, { @@ -12495,7 +12495,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-fw pi-upload", + "default": "'pi pi-fw pi-upload'", "description": "Icon of the upload button." }, { @@ -12902,7 +12902,7 @@ "optional": true, "readonly": false, "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", - "default": "bottom", + "default": "'bottom'", "description": "Position of indicators." }, { @@ -12998,7 +12998,7 @@ "optional": true, "readonly": false, "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", - "default": "bottom", + "default": "'bottom'", "description": "Position of thumbnails." }, { @@ -13022,7 +13022,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "300px", + "default": "'300px'", "description": "Height of the viewport in vertical thumbnail." }, { @@ -13375,7 +13375,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-times", + "default": "'pi pi-times'", "description": "Icon to display in the close button." }, { @@ -13557,7 +13557,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "_", + "default": "'_'", "description": "Placeholder character in mask, default is underscore." }, { @@ -13736,8 +13736,8 @@ "optional": true, "readonly": false, "type": "\"horizontal\" | \"vertical\" | \"stacked\"", - "default": "", - "description": "Layout of the buttons.\nDefault value is 'stacked'." + "default": "'stacked'.", + "description": "Layout of the buttons." }, { "name": "currency", @@ -13752,8 +13752,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "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'.\nDefault value is 'symbol'." + "default": "'symbol'", + "description": "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'." }, { "name": "decrementButtonClass", @@ -13768,8 +13768,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Style class of the decrement button.\nDefault value is 'pi pi-angle-down'." + "default": "'pi pi-angle-down'", + "description": "Style class of the decrement button." }, { "name": "decrementButtonProps", @@ -13816,8 +13816,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Style class of the increment button.\nDefault value is 'pi pi-angle-up'." + "default": "'pi pi-angle-up'", + "description": "Style class of the increment button." }, { "name": "incrementButtonProps", @@ -13872,8 +13872,8 @@ "optional": true, "readonly": false, "type": "\"best fit\" | \"lookup\"", - "default": "", - "description": "The locale matching algorithm to use. Possible values are 'lookup' and 'best fit'; the default is 'best fit'.\nSee [Locale Negotation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_negotiation) for details.\nDefault value is 'best fit'" + "default": "'best fit'", + "description": "The locale matching algorithm to use. Possible values are 'lookup' and 'best fit'; the default is 'best fit'.\nSee [Locale Negotation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_negotiation) for details." }, { "name": "max", @@ -13912,8 +13912,8 @@ "optional": true, "readonly": false, "type": "\"decimal\" | \"currency\"", - "default": "", - "description": "Defines the behavior of the component.\nDefault value is 'decimal'." + "default": "'decimal'.", + "description": "Defines the behavior of the component." }, { "name": "modelValue", @@ -14318,7 +14318,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "var(--surface-border, LightGray)", + "default": "'var(--surface-border, LightGray)'", "description": "Background color of the range." }, { @@ -14374,7 +14374,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "var(--text-color-secondary, Black)", + "default": "'var(--text-color-secondary, Black)'", "description": "Color of the value text." }, { @@ -14382,7 +14382,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "var(--primary-color, Black)", + "default": "'var(--primary-color, Black)'", "description": "Background of the value." }, { @@ -14390,7 +14390,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "{value}", + "default": "'{value}'", "description": "Template string of the value." } ], @@ -14591,7 +14591,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No results found", + "default": "'No results found'", "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." }, { @@ -14599,7 +14599,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No results found", + "default": "'No results found'", "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration." }, { @@ -14607,7 +14607,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No selected item", + "default": "'No selected item'", "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." }, { @@ -14631,7 +14631,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-search", + "default": "'ß'", "description": "Icon to display in filter input." }, { @@ -14655,7 +14655,7 @@ "optional": true, "readonly": false, "type": "\"endsWith\" | \"startsWith\" | \"contains\"", - "default": "contains", + "default": "'contains'", "description": "Defines the filtering algorithm to use when searching the options." }, { @@ -14663,7 +14663,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "results are available", + "default": "'{0} results are available'", "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration." }, { @@ -14767,7 +14767,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "items selected", + "default": "'{0} items selected'", "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." }, { @@ -14990,7 +14990,7 @@ "optional": true, "readonly": false, "type": "\"horizontal\" | \"vertical\"", - "default": "horizontal", + "default": "'horizontal'", "description": "Defines the orientation." }, { @@ -15136,7 +15136,7 @@ "optional": true, "readonly": false, "type": "string | HTMLElement", - "default": "body", + "default": "'body'", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { @@ -15350,12 +15350,18 @@ }, "menuitem": { "description": "PrimeVue menu components share a common api to specify the menuitems and submenus.", - "model": { - "MenuItem": { - "description": "Defines model of MenuItem API.", - "props": { - "description": "", - "values": [ + "interfaces": { + "description": "Defines the custom interfaces used by the module.", + "eventDescription": "Defines the custom events used by the component's emit.", + "methodDescription": "Defines methods that can be accessed by the component's reference.", + "typeDescription": "Defines the custom types used by the module.", + "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.", + "values": { + "MenuItem": { + "description": "Defines model of MenuItem API.", + "relatedProp": "", + "props": [ { "name": "class", "optional": true, @@ -15451,19 +15457,30 @@ "type": "boolean | Function", "default": "true", "description": "A boolean or a function to return a boolean to specify if the item is visible." + }, + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [ + { + "name": "command", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "MenuItemCommandEvent", + "description": "Custom command event." + } + ], + "returnType": "void", + "description": "Callback to execute when item is clicked." } ] - } - } - }, - "interfaces": { - "description": "Defines the custom interfaces used by the module.", - "eventDescription": "Defines the custom events used by the component's emit.", - "methodDescription": "Defines methods that can be accessed by the component's reference.", - "typeDescription": "Defines the custom types used by the module.", - "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.", - "values": { + }, "MenuItemCommandEvent": { "description": "Custom command event.", "relatedProp": "command", @@ -15845,7 +15862,7 @@ "optional": true, "readonly": false, "type": "string | HTMLElement", - "default": "body", + "default": "'body'", "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." }, { @@ -15885,7 +15902,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-check", + "default": "'pi pi-check'", "description": "Icon to display in the checkboxes." }, { @@ -15901,7 +15918,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-times", + "default": "'pi pi-times'", "description": "Icon to display in the dropdown close button." }, { @@ -15925,7 +15942,7 @@ "optional": true, "readonly": false, "type": "\"comma\" | \"chip\"", - "default": "comma", + "default": "'comma'", "description": "Defines how the selected items are displayed." }, { @@ -15933,7 +15950,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-chevron-down", + "default": "'pi pi-chevron-down'", "description": "Icon to display in the dropdown." }, { @@ -15941,7 +15958,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No results found", + "default": "'No results found'", "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." }, { @@ -15949,7 +15966,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No results found", + "default": "'No results found'", "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration." }, { @@ -15957,7 +15974,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No selected item", + "default": "'No selected item'", "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." }, { @@ -15981,7 +15998,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-search", + "default": "'pi pi-search'", "description": "Icon to display in filter input." }, { @@ -16005,7 +16022,7 @@ "optional": true, "readonly": false, "type": "\"endsWith\" | \"startsWith\" | \"contains\"", - "default": "contains", + "default": "'contains'", "description": "Defines the filtering algorithm to use when searching the options." }, { @@ -16013,7 +16030,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "results are available", + "default": "'{0} results are available'", "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration." }, { @@ -16053,7 +16070,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-spinner pi-spin", + "default": "'pi pi-spinner pi-spin'", "description": "Icon to display in loading state." }, { @@ -16157,7 +16174,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-times-circle", + "default": "'pi pi-times-circle'", "description": "Icon to display in chip remove action." }, { @@ -16173,7 +16190,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "200px", + "default": "'200px'", "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value." }, { @@ -16189,7 +16206,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "items selected", + "default": "'{0} items selected'", "description": "Label to display after exceeding max selected labels." }, { @@ -16205,7 +16222,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "items selected", + "default": "'{0} items selected'", "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." }, { @@ -16470,7 +16487,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "960px", + "default": "'960px'", "description": "The breakpoint to define the maximum width boundary when responsiveness is enabled." }, { @@ -17042,7 +17059,7 @@ "optional": true, "readonly": false, "type": "string | HTMLElement", - "default": "body", + "default": "'body'", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { @@ -17225,7 +17242,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "({currentPage} of {totalPages})", + "default": "'({currentPage} of {totalPages})'", "description": "Template of the current page report element. It displays information about the pagination state. Available placeholders are the following;\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" }, { @@ -17681,7 +17698,7 @@ "optional": true, "readonly": false, "type": "string | HTMLElement", - "default": "body", + "default": "'body'", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { @@ -17721,7 +17738,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-eye-slash", + "default": "'pi pi-eye-slash'", "description": "Icon to hide displaying the password as plain text." }, { @@ -17769,7 +17786,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "^(((?=.*[a-z])(?=.*[A-Z]))|((?=.*[a-z])(?=.*[0-9]))|((?=.*[A-Z])(?=.*[0-9])))(?=.{6,})", + "default": "'^(((?=.*[a-z])(?=.*[A-Z]))|((?=.*[a-z])(?=.*[0-9]))|((?=.*[A-Z])(?=.*[0-9])))(?=.{6,})'", "description": "Regex for a medium level password." }, { @@ -17841,7 +17858,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-eye", + "default": "'pi pi-eye'", "description": "Icon to show displaying the password as plain text." }, { @@ -17857,7 +17874,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})", + "default": "'^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})'", "description": "Regex for a strong level password." }, { @@ -18537,7 +18554,7 @@ "optional": true, "readonly": false, "type": "\"indeterminate\" | \"determinate\"", - "default": "determinate", + "default": "'determinate'", "description": "Defines the mode of the progress" }, { @@ -18609,7 +18626,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "2s", + "default": "'2s'", "description": "Duration of the rotate animation." }, { @@ -18625,7 +18642,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "2", + "default": "'2'", "description": "Width of the circle stroke." } ], @@ -18918,7 +18935,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-ban", + "default": "'pi pi-ban'", "description": "Icon for the cancelable state." }, { @@ -18950,7 +18967,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-star-fill", + "default": "'pi pi-star-fill'", "description": "Icon for the off state." }, { @@ -18958,7 +18975,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-star", + "default": "'pi pi-star'", "description": "Icon for the on state." }, { @@ -19172,7 +19189,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "smooth", + "default": "'smooth'", "description": "Defines the scrolling behaviour, 'smooth' adds an animation and 'auto' scrolls with a jump." }, { @@ -19180,7 +19197,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-chevron-up", + "default": "'pi pi-chevron-up'", "description": "Icon to display." }, { @@ -19188,7 +19205,7 @@ "optional": true, "readonly": false, "type": "\"window\" | \"parent\"", - "default": "window", + "default": "'window'", "description": "Target of the ScrollTop." }, { @@ -19505,7 +19522,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-times", + "default": "'pi pi-times'", "description": "Icon to display in the sidebar close button." }, { @@ -19529,7 +19546,7 @@ "optional": true, "readonly": false, "type": "\"left\" | \"top\" | \"bottom\" | \"right\" | \"full\"", - "default": "left", + "default": "'left'", "description": "Specifies the position of the sidebar." }, { @@ -19607,7 +19624,7 @@ "optional": true, "readonly": false, "type": "\"none\" | \"wave\"", - "default": "wave", + "default": "'wave'", "description": "Type of the animation." }, { @@ -19623,7 +19640,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "1rem", + "default": "'1rem'", "description": "Height of the element." }, { @@ -19631,7 +19648,7 @@ "optional": true, "readonly": false, "type": "\"circle\" | \"rectangle\"", - "default": "rectangle", + "default": "'rectangle'", "description": "Shape of the element." }, { @@ -19647,7 +19664,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "100%", + "default": "'100%'", "description": "Width of the element." } ], @@ -19784,7 +19801,7 @@ "optional": true, "readonly": false, "type": "\"horizontal\" | \"vertical\"", - "default": "horizontal", + "default": "'horizontal'", "description": "Orientation of the slider." }, { @@ -19964,7 +19981,7 @@ "optional": true, "readonly": false, "type": "\"left\" | \"right\" | \"up\" | \"down\" | \"up-left\" | \"up-right\" | \"down-left\" | \"down-right\"", - "default": "up", + "default": "'up'", "description": "Specifies the opening direction of actions." }, { @@ -20044,7 +20061,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-plus", + "default": "'pi pi-plus'", "description": "Show icon of the button element." }, { @@ -20076,7 +20093,7 @@ "optional": true, "readonly": false, "type": "\"linear\" | \"circle\" | \"semi-circle\" | \"quarter-circle\"", - "default": "linear", + "default": "'linear'", "description": "Specifies the opening type of actions." }, { @@ -20140,8 +20157,8 @@ "optional": false, "readonly": false, "type": "undefined | \"left\" | \"top\" | \"bottom\" | \"right\"", - "default": "", - "description": "Position of element.\nDefault value is 'bottom'." + "default": "'bottom'.", + "description": "Position of element." }, { "name": "[key: string]", @@ -20203,7 +20220,7 @@ "optional": true, "readonly": false, "type": "string | HTMLElement", - "default": "body", + "default": "'body'", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached.\nSpecial keywords are 'body' for document body and 'self' for the element itself." }, { @@ -20398,7 +20415,7 @@ "optional": true, "readonly": false, "type": "\"local\" | \"session\"", - "default": "session", + "default": "'session'", "description": "Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage." }, { @@ -21469,8 +21486,8 @@ "name": "appendTo", "optional": true, "readonly": false, - "type": "TieredMenuAppandToType", - "default": "", + "type": "string | HTMLElement", + "default": "'body'", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { @@ -21494,16 +21511,16 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to automatically manage layering.\nDefault value is true." + "default": "true", + "description": "Whether to automatically manage layering." }, { "name": "baseZIndex", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Base zIndex value to use in layering.\nDefault value is 0." + "default": "0", + "description": "Base zIndex value to use in layering." }, { "name": "disabled", @@ -21518,8 +21535,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path.\nDefault value is true." + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." }, { "name": "model", @@ -21606,7 +21623,7 @@ "optional": true, "readonly": false, "type": "\"alternate\" | \"left\" | \"top\" | \"bottom\" | \"right\"", - "default": "left", + "default": "'left'", "description": "Position of the timeline bar relative to the content." }, { @@ -21622,7 +21639,7 @@ "optional": true, "readonly": false, "type": "\"horizontal\" | \"vertical\"", - "default": "horizontal", + "default": "'horizontal'", "description": "Orientation of the timeline." }, { @@ -21741,8 +21758,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether the message can be closed manually using the close icon.\nDefault value is true." + "default": "true", + "description": "Whether the message can be closed manually using the close icon." }, { "name": "contentStyleClass", @@ -21773,16 +21790,16 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Delay in milliseconds to close the message automatically.\nDefault value is 3000." + "default": "3000", + "description": "Delay in milliseconds to close the message automatically." }, { "name": "severity", "optional": true, "readonly": false, "type": "\"error\" | \"success\" | \"info\" | \"warn\"", - "default": "", - "description": "Severity level of the message.\nDefault value is 'info'." + "default": "'info'", + "description": "Severity level of the message." }, { "name": "styleClass", @@ -22070,7 +22087,7 @@ "optional": true, "readonly": false, "type": "\"left\" | \"right\"", - "default": "left", + "default": "'left'", "description": "Position of the icon." }, { @@ -22638,8 +22655,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "When filtering is enabled, filterBy decides which field or fields (comma separated) to search against.\nDefault valye is 'label'." + "default": "'label'", + "description": "When filtering is enabled, filterBy decides which field or fields (comma separated) to search against." }, { "name": "filterLocale", @@ -22654,7 +22671,7 @@ "optional": true, "readonly": false, "type": "\"strict\" | \"lenient\"", - "default": "lenient", + "default": "'lenient'", "description": "Mode for filtering." }, { @@ -22678,7 +22695,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-spin", + "default": "'pi pi-spin'", "description": "Icon to display when tree is loading." }, { @@ -22883,7 +22900,7 @@ "optional": true, "readonly": false, "type": "string | HTMLElement", - "default": "body", + "default": "'body'", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { @@ -22915,7 +22932,7 @@ "optional": true, "readonly": false, "type": "\"comma\" | \"chip\"", - "default": "comma", + "default": "'comma'", "description": "Defines how the selected items are displayed." }, { @@ -22923,7 +22940,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "No results found", + "default": "'No results found'", "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration." }, { @@ -23003,7 +23020,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "200px", + "default": "'200px'", "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value." }, { @@ -23571,7 +23588,7 @@ "optional": true, "readonly": false, "type": "\"fit\" | \"expand\"", - "default": "fit", + "default": "'fit'", "description": "Defines whether the overall table width should change on column resize." }, { @@ -23579,7 +23596,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "({currentPage} of {totalPages})", + "default": "'({currentPage} of {totalPages})'", "description": "Template of the current page report element. It displays information about the pagination state.\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" }, { @@ -23611,7 +23628,7 @@ "optional": true, "readonly": false, "type": "\"strict\" | \"lenient\"", - "default": "lenient", + "default": "'lenient'", "description": "Mode for filtering." }, { @@ -23659,7 +23676,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "pi pi-spinner", + "default": "'pi pi-spinner'", "description": "The icon to show while indicating data load is in progress." }, { @@ -23707,7 +23724,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown", + "default": "'FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown'", "description": "Template of the paginator. It can be customized using the template property using the predefined keys. Here are the available elements that can be placed inside a paginator in any order.\n\n- FirstPageLink\n- PrevPageLink\n- PageLinks\n- NextPageLink\n- LastPageLink\n- RowsPerPageDropdown\n- JumpToPageDropdown\n- JumpToPageInput\n- CurrentPageReport" }, { @@ -23731,7 +23748,7 @@ "optional": true, "readonly": false, "type": "\"scroll\" | \"stack\"", - "default": "stack", + "default": "'stack'", "description": "Defines the responsive mode, currently only option is scroll." }, { @@ -23763,7 +23780,7 @@ "optional": true, "readonly": false, "type": "\"both\" | \"horizontal\" | \"vertical\"", - "default": "vertical", + "default": "'vertical'", "description": "Orientation of the scrolling." }, { @@ -23819,7 +23836,7 @@ "optional": true, "readonly": false, "type": "\"multiple\" | \"single\"", - "default": "single", + "default": "'single'", "description": "Defines whether sorting works on single column or on multiple columns." }, {