.d.ts updates

pull/3699/head
Tuğçe Küçükoğlu 2023-03-03 11:18:55 +03:00
parent f2024af40d
commit 95d3740f63
46 changed files with 396 additions and 380 deletions

View File

@ -61,12 +61,12 @@ export interface AccordionProps {
lazy?: boolean | undefined; lazy?: boolean | undefined;
/** /**
* Icon of a collapsed tab. * Icon of a collapsed tab.
* @defaultValue pi pi-chevron-right * @defaultValue 'pi pi-chevron-right'
*/ */
expandIcon?: string | undefined; expandIcon?: string | undefined;
/** /**
* Icon of an expanded tab. * Icon of an expanded tab.
* @defaultValue pi pi-chevron-down * @defaultValue 'pi pi-chevron-down'
*/ */
collapseIcon?: string | undefined; collapseIcon?: string | undefined;
/** /**

View File

@ -113,7 +113,7 @@ export interface AutoCompleteProps {
optionGroupChildren?: string | ((data: any) => any[]) | undefined; optionGroupChildren?: string | ((data: any) => any[]) | undefined;
/** /**
* Maximum height of the suggestions panel. * Maximum height of the suggestions panel.
* @defaultValue 200px * @defaultValue '200px'
*/ */
scrollHeight?: string | undefined; scrollHeight?: string | undefined;
/** /**
@ -123,7 +123,7 @@ export interface AutoCompleteProps {
dropdown?: boolean | undefined; dropdown?: boolean | undefined;
/** /**
* Specifies the behavior dropdown button. Default 'blank' mode sends an empty string and 'current' mode sends the input value. * 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; 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. * 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. * Special keywords are 'body' for document body and 'self' for the element itself.
* @defaultValue body * @defaultValue 'body'
*/ */
appendTo?: 'body' | 'self' | string | undefined | HTMLElement; appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
/** /**
@ -215,12 +215,12 @@ export interface AutoCompleteProps {
dropdownClass?: string | undefined; dropdownClass?: string | undefined;
/** /**
* Icon to display in loading state. * Icon to display in loading state.
* @defaultValue pi pi-spinner pi-spin * @defaultValue 'pi pi-spinner pi-spin'
*/ */
loadingIcon?: string | undefined; loadingIcon?: string | undefined;
/** /**
* Icon to display in chip remove action. * Icon to display in chip remove action.
* @defaultValue pi pi-times-circle * @defaultValue 'pi pi-times-circle'
*/ */
removeTokenIcon?: string | undefined; removeTokenIcon?: string | undefined;
/** /**
@ -244,22 +244,22 @@ export interface AutoCompleteProps {
searchLocale?: string | undefined; searchLocale?: string | undefined;
/** /**
* Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration. * 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; searchMessage?: string | undefined;
/** /**
* Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration. * 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; selectionMessage?: string | undefined;
/** /**
* Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration. * 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; emptySelectionMessage?: string | undefined;
/** /**
* Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration. * 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; emptySearchMessage?: string | undefined;
/** /**

View File

@ -27,12 +27,12 @@ export interface AvatarProps {
image?: string | undefined; image?: string | undefined;
/** /**
* Size of the element. * Size of the element.
* @defaultValue normal * @defaultValue 'normal'
*/ */
size?: 'normal' | 'large' | 'xlarge' | undefined; size?: 'normal' | 'large' | 'xlarge' | undefined;
/** /**
* Shape of the element. * Shape of the element.
* @defaultValue square * @defaultValue 'square'
*/ */
shape?: 'square' | 'circle' | undefined; shape?: 'square' | 'circle' | undefined;
/** /**

View File

@ -32,7 +32,7 @@ export interface ButtonProps extends ButtonHTMLAttributes {
icon?: string | undefined; icon?: string | undefined;
/** /**
* Position of the icon. * Position of the icon.
* @defaultValue left * @defaultValue 'left'
*/ */
iconPos?: 'left' | 'right' | 'top' | 'bottom' | undefined; iconPos?: 'left' | 'right' | 'top' | 'bottom' | undefined;
/** /**

View File

@ -109,27 +109,27 @@ export interface CalendarProps {
showIcon?: boolean | undefined; showIcon?: boolean | undefined;
/** /**
* Icon of the calendar button. * Icon of the calendar button.
* @defaultValue pi pi-calendar * @defaultValue 'pi pi-calendar'
*/ */
icon?: string | undefined; icon?: string | undefined;
/** /**
* Icon to show in the previous button. * Icon to show in the previous button.
* @defaultValue pi pi-chevron-left * @defaultValue 'pi pi-chevron-left'
*/ */
previousIcon?: string | undefined; previousIcon?: string | undefined;
/** /**
* Icon to show in the next button. * Icon to show in the next button.
* @defaultValue pi pi-chevron-right * @defaultValue 'pi pi-chevron-right'
*/ */
nextIcon?: string | undefined; nextIcon?: string | undefined;
/** /**
* Icon to show in each of the increment buttons. * Icon to show in each of the increment buttons.
* @defaultValue pi pi-chevron-up * @defaultValue 'pi pi-chevron-up'
*/ */
incrementIcon?: string | undefined; incrementIcon?: string | undefined;
/** /**
* Icon to show in each of the decrement buttons. * Icon to show in each of the decrement buttons.
* @defaultValue pi pi-chevron-down * @defaultValue 'pi pi-chevron-down'
*/ */
decrementIcon?: string | undefined; decrementIcon?: string | undefined;
/** /**
@ -143,7 +143,7 @@ export interface CalendarProps {
responsiveOptions?: CalendarResponsiveOptions[]; responsiveOptions?: CalendarResponsiveOptions[];
/** /**
* Type of view to display. * Type of view to display.
* @defaultValue date * @defaultValue 'date'
*/ */
view?: 'date' | 'month' | 'year' | undefined; view?: 'date' | 'month' | 'year' | undefined;
/** /**
@ -214,7 +214,7 @@ export interface CalendarProps {
showButtonBar?: boolean | undefined; showButtonBar?: boolean | undefined;
/** /**
* The cutoff year for determining the century for a date. * The cutoff year for determining the century for a date.
* @defaultValue +10 * @defaultValue '+10'
*/ */
shortYearCutoff?: string | undefined; shortYearCutoff?: string | undefined;
/** /**
@ -264,7 +264,7 @@ export interface CalendarProps {
hideOnRangeSelection?: boolean | undefined; hideOnRangeSelection?: boolean | undefined;
/** /**
* Separator of time selector. * Separator of time selector.
* @defaultValue : * @defaultValue ':'
*/ */
timeSeparator?: string | undefined; timeSeparator?: string | undefined;
/** /**
@ -293,7 +293,7 @@ export interface CalendarProps {
placeholder?: string | undefined; placeholder?: string | undefined;
/** /**
* A valid query selector or an HTMLElement to specify where the overlay gets attached. * A valid query selector or an HTMLElement to specify where the overlay gets attached.
* @defaultValue body * @defaultValue 'body'
*/ */
appendTo?: 'body' | 'self' | string | undefined | HTMLElement; appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
/** /**

View File

@ -59,7 +59,7 @@ export interface CarouselProps {
orientation?: 'horizontal' | 'vertical' | undefined; orientation?: 'horizontal' | 'vertical' | undefined;
/** /**
* Height of the viewport in vertical layout. * Height of the viewport in vertical layout.
* @defaultValue 300px * @defaultValue '300px'
*/ */
verticalViewPortHeight?: string | undefined; verticalViewPortHeight?: string | undefined;
/** /**

View File

@ -106,7 +106,7 @@ export interface CascadeSelectProps {
panelProps?: HTMLAttributes | undefined; 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. * 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; appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
/** /**
@ -116,17 +116,17 @@ export interface CascadeSelectProps {
loading?: boolean | undefined; loading?: boolean | undefined;
/** /**
* Icon to display in the dropdown. * Icon to display in the dropdown.
* @defaultValue pi pi-chevron-down * @defaultValue 'pi pi-chevron-down'
*/ */
dropdownIcon?: string | undefined; dropdownIcon?: string | undefined;
/** /**
* Icon to display in loading state. * Icon to display in loading state.
* @defaultValue pi pi-spinner pi-spin * @defaultValue 'pi pi-spinner pi-spin'
*/ */
loadingIcon?: string | undefined; loadingIcon?: string | undefined;
/** /**
* Icon to display in the option group. * Icon to display in the option group.
* @defaultValue pi pi-angle-right * @defaultValue 'pi pi-angle-right'
*/ */
optionGroupIcon?: string | undefined; optionGroupIcon?: string | undefined;
/** /**
@ -145,27 +145,27 @@ export interface CascadeSelectProps {
searchLocale?: string | undefined; searchLocale?: string | undefined;
/** /**
* Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration. * 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; searchMessage?: string | undefined;
/** /**
* Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration. * 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; selectionMessage?: string | undefined;
/** /**
* Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration. * 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; emptySelectionMessage?: string | undefined;
/** /**
* Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration. * 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; emptySearchMessage?: string | undefined;
/** /**
* Text to be displayed when there are no options available. Defaults to value from PrimeVue locale configuration. * 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; emptyMessage?: string | undefined;
/** /**

View File

@ -50,7 +50,7 @@ export interface ChipsProps {
addOnBlur?: boolean | undefined; addOnBlur?: boolean | undefined;
/** /**
* Whether to allow duplicate values or not. * Whether to allow duplicate values or not.
* Default value is true. * @defaultValue true.
*/ */
allowDuplicate?: boolean | undefined; allowDuplicate?: boolean | undefined;
/** /**
@ -75,7 +75,7 @@ export interface ChipsProps {
inputProps?: InputHTMLAttributes | undefined; inputProps?: InputHTMLAttributes | undefined;
/** /**
* Icon to display in chip remove action. * Icon to display in chip remove action.
* Default value is 'pi pi-times-circle'. * @defaultValue 'pi pi-times-circle'
*/ */
removeTokenIcon?: string | undefined; removeTokenIcon?: string | undefined;
/** /**

View File

@ -22,7 +22,7 @@ export interface ContextMenuProps {
model?: MenuItem[] | undefined; model?: MenuItem[] | undefined;
/** /**
* A valid query selector or an HTMLElement to specify where the overlay gets attached. * A valid query selector or an HTMLElement to specify where the overlay gets attached.
* @defaultValue body * @defaultValue 'body'
*/ */
appendTo?: 'body' | 'self' | string | undefined | HTMLElement; appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
/** /**

View File

@ -612,7 +612,7 @@ export interface DataTableProps {
loading?: boolean | undefined; loading?: boolean | undefined;
/** /**
* The icon to show while indicating data load is in progress. * The icon to show while indicating data load is in progress.
* @defaultValue pi pi-spinner * @defaultValue 'pi pi-spinner'
*/ */
loadingIcon?: string | undefined; loadingIcon?: string | undefined;
/** /**
@ -634,7 +634,7 @@ export interface DataTableProps {
multiSortMeta?: DataTableSortMeta[] | undefined; multiSortMeta?: DataTableSortMeta[] | undefined;
/** /**
* Defines whether sorting works on single column or on multiple columns. * Defines whether sorting works on single column or on multiple columns.
* @defaultValue single * @defaultValue 'single'
*/ */
sortMode?: 'single' | 'multiple' | undefined; sortMode?: 'single' | 'multiple' | undefined;
/** /**
@ -669,7 +669,7 @@ export interface DataTableProps {
selectionMode?: 'single' | 'multiple' | undefined; selectionMode?: 'single' | 'multiple' | undefined;
/** /**
* Algorithm to define if a row is selected. * Algorithm to define if a row is selected.
* @defaultValue deepEquals * @defaultValue 'deepEquals'
*/ */
compareSelectionBy?: 'equals' | 'deepEquals' | undefined; compareSelectionBy?: 'equals' | 'deepEquals' | undefined;
/** /**
@ -698,12 +698,12 @@ export interface DataTableProps {
rowHover?: boolean | undefined; rowHover?: boolean | undefined;
/** /**
* Character to use as the csv separator. * Character to use as the csv separator.
* @defaultValue , * @defaultValue ','
*/ */
csvSeparator?: string | undefined; csvSeparator?: string | undefined;
/** /**
* Name of the exported file. * Name of the exported file.
* @defaultValue download * @defaultValue 'download'
*/ */
exportFilename?: string | undefined; exportFilename?: string | undefined;
/** /**
@ -717,7 +717,7 @@ export interface DataTableProps {
resizableColumns?: boolean | undefined; resizableColumns?: boolean | undefined;
/** /**
* Defines whether the overall table width. * Defines whether the overall table width.
* @defaultValue fit * @defaultValue 'fit'
*/ */
columnResizeMode?: 'fit' | 'expand' | undefined; columnResizeMode?: 'fit' | 'expand' | undefined;
/** /**
@ -731,12 +731,12 @@ export interface DataTableProps {
expandedRows?: any[] | DataTableExpandedRows | null; expandedRows?: any[] | DataTableExpandedRows | null;
/** /**
* Icon of the row toggler to display the row as expanded. * Icon of the row toggler to display the row as expanded.
* @defaultValue pi-chevron-down * @defaultValue 'pi-chevron-down'
*/ */
expandedRowIcon?: string | undefined; expandedRowIcon?: string | undefined;
/** /**
* Icon of the row toggler to display the row as collapsed. * Icon of the row toggler to display the row as collapsed.
* @defaultValue pi-chevron-right * @defaultValue 'pi-chevron-right'
*/ */
collapsedRowIcon?: string | undefined; collapsedRowIcon?: string | undefined;
/** /**
@ -758,7 +758,7 @@ export interface DataTableProps {
expandedRowGroups?: any[] | DataTableExpandedRows; expandedRowGroups?: any[] | DataTableExpandedRows;
/** /**
* Defines where a stateful table keeps its state. * Defines where a stateful table keeps its state.
* @defaultValue session * @defaultValue 'session'
*/ */
stateStorage?: 'session' | 'local' | undefined; stateStorage?: 'session' | 'local' | undefined;
/** /**
@ -766,7 +766,7 @@ export interface DataTableProps {
*/ */
stateKey?: string | undefined; stateKey?: string | undefined;
/** /**
* Defines the incell editing mode, valid options are 'cell' and 'row'. * Defines the incell editing mode.
*/ */
editMode?: 'cell' | 'row' | undefined; editMode?: 'cell' | 'row' | undefined;
/** /**
@ -801,7 +801,7 @@ export interface DataTableProps {
frozenValue?: any[] | undefined | null; frozenValue?: any[] | undefined | null;
/** /**
* The breakpoint to define the maximum width boundary when using stack responsive layout. * The breakpoint to define the maximum width boundary when using stack responsive layout.
* @defaultValue 960px * @defaultValue '960px'
*/ */
breakpoint?: string | undefined; breakpoint?: string | undefined;
/** /**

View File

@ -43,7 +43,7 @@ export interface DataViewProps {
value?: any[] | undefined; value?: any[] | undefined;
/** /**
* Layout of the items, valid values are 'list' and 'grid'. * Layout of the items, valid values are 'list' and 'grid'.
* @defaultValue list * @defaultValue 'list'
*/ */
layout?: 'list' | 'grid' | undefined; layout?: 'list' | 'grid' | undefined;
/** /**
@ -67,7 +67,7 @@ export interface DataViewProps {
paginator?: boolean | undefined; paginator?: boolean | undefined;
/** /**
* Position of the paginator, options are 'top','bottom' or 'both'. * Position of the paginator, options are 'top','bottom' or 'both'.
* @defaultValue bottom * @defaultValue 'bottom'
*/ */
paginatorPosition?: 'top' | 'bottom' | 'both' | undefined; paginatorPosition?: 'top' | 'bottom' | 'both' | undefined;
/** /**
@ -110,7 +110,7 @@ export interface DataViewProps {
* - {last} * - {last}
* - {totalRecords} * - {totalRecords}
* *
* @defaultValue ({currentPage} of {totalPages}) * @defaultValue '({currentPage} of {totalPages})'
*/ */
currentPageReportTemplate?: string | undefined; currentPageReportTemplate?: string | undefined;
/** /**

View File

@ -103,7 +103,7 @@ export interface DialogProps {
autoZIndex?: boolean | undefined; autoZIndex?: boolean | undefined;
/** /**
* Position of the dialog. * Position of the dialog.
* @defaultValue center * @defaultValue 'center'
*/ */
position?: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright' | undefined; position?: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright' | undefined;
/** /**
@ -137,7 +137,7 @@ export interface DialogProps {
minY?: number | undefined; minY?: number | undefined;
/** /**
* A valid query selector or an HTMLElement to specify where the dialog gets attached. * A valid query selector or an HTMLElement to specify where the dialog gets attached.
* @defaultValue body * @defaultValue 'body'
*/ */
appendTo?: 'body' | 'self' | string | undefined | HTMLElement; appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
/** /**
@ -146,17 +146,17 @@ export interface DialogProps {
style?: any; style?: any;
/** /**
* Icon to display in the dialog close button. * Icon to display in the dialog close button.
* @defaultValue pi pi-times * @defaultValue 'pi pi-times'
*/ */
closeIcon?: string | undefined; closeIcon?: string | undefined;
/** /**
* Icon to display in the dialog maximize button when dialog is not maximized. * 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; maximizeIcon?: string | undefined;
/** /**
* Icon to display in the dialog maximize button when dialog is maximized. * 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; minimizeIcon?: string | undefined;
} }

View File

@ -15,17 +15,17 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
*/ */
export interface DividerProps { export interface DividerProps {
/** /**
* Alignment of the content, options are 'left', 'center', 'right' for horizontal layout and 'top', 'center', 'bottom' for vertical. * Alignment of the content.
*/ */
align?: 'left' | 'center' | 'right' | 'top' | 'center' | 'bottom' | undefined; align?: 'left' | 'center' | 'right' | 'top' | 'center' | 'bottom' | undefined;
/** /**
* Specifies the orientation, valid values are 'horizontal' and 'vertical'. * Specifies the orientation, valid values are 'horizontal' and 'vertical'.
* @defaultValue horizontal * @defaultValue 'horizontal'
*/ */
layout?: 'horizontal' | 'vertical' | undefined; layout?: 'horizontal' | 'vertical' | undefined;
/** /**
* Border style type. * Border style type.
* @defaultValue solid * @defaultValue 'solid'
*/ */
type?: 'solid' | 'dashed' | 'dotted' | undefined; type?: 'solid' | 'dashed' | 'dotted' | undefined;
} }

View File

@ -21,7 +21,7 @@ export interface DockTooltipOptions {
event: 'hover' | 'focus' | undefined; event: 'hover' | 'focus' | undefined;
/** /**
* Position of element. * Position of element.
* @defaultValue bottom * @defaultValue 'bottom'
*/ */
position: 'bottom' | 'top' | 'left' | 'right' | undefined; position: 'bottom' | 'top' | 'left' | 'right' | undefined;
/** /**
@ -40,7 +40,7 @@ export interface DockProps {
model?: MenuItem[] | undefined; model?: MenuItem[] | undefined;
/** /**
* Position of element. * Position of element.
* @defaultValue bottom * @defaultValue 'bottom'
*/ */
position?: 'bottom' | 'top' | 'left' | 'right' | undefined; position?: 'bottom' | 'top' | 'left' | 'right' | undefined;
/** /**

View File

@ -75,7 +75,7 @@ export interface DropdownProps {
optionGroupChildren?: string | ((data: any) => any[]) | undefined; optionGroupChildren?: string | ((data: any) => any[]) | undefined;
/** /**
* Height of the viewport, a scrollbar is defined if height of list exceeds this value. * Height of the viewport, a scrollbar is defined if height of list exceeds this value.
* @defaultValue 200px * @defaultValue '200px'
*/ */
scrollHeight?: string | undefined; scrollHeight?: string | undefined;
/** /**
@ -92,7 +92,7 @@ export interface DropdownProps {
filterLocale?: string | undefined; filterLocale?: string | undefined;
/** /**
* Defines the filtering algorithm to use when searching the options. * Defines the filtering algorithm to use when searching the options.
* @defaultValue contains * @defaultValue 'contains'
*/ */
filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | undefined; filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | undefined;
/** /**
@ -157,7 +157,7 @@ export interface DropdownProps {
clearIconProps?: HTMLAttributes | undefined; clearIconProps?: HTMLAttributes | undefined;
/** /**
* A valid query selector or an HTMLElement to specify where the overlay gets attached. * A valid query selector or an HTMLElement to specify where the overlay gets attached.
* @defaultValue body * @defaultValue 'body'
*/ */
appendTo?: 'body' | 'self' | string | undefined | HTMLElement; appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
/** /**
@ -166,22 +166,22 @@ export interface DropdownProps {
loading?: boolean | undefined; loading?: boolean | undefined;
/** /**
* Icon to display in clear button. * Icon to display in clear button.
* @defaultValue pi pi-times * @defaultValue 'pi pi-times'
*/ */
clearIcon?: string | undefined; clearIcon?: string | undefined;
/** /**
* Icon to display in the dropdown. * Icon to display in the dropdown.
* @defaultValue pi pi-chevron-down * @defaultValue 'pi pi-chevron-down'
*/ */
dropdownIcon?: string | undefined; dropdownIcon?: string | undefined;
/** /**
* Icon to display in filter input. * Icon to display in filter input.
* @defaultValue pi pi-search * @defaultValue 'pi pi-search'
*/ */
filterIcon?: string | undefined; filterIcon?: string | undefined;
/** /**
* Icon to display in loading state. * Icon to display in loading state.
* @defaultValue pi pi-spinner pi-spin * @defaultValue 'pi pi-spinner pi-spin'
*/ */
loadingIcon?: string | undefined; loadingIcon?: string | undefined;
/** /**
@ -209,27 +209,27 @@ export interface DropdownProps {
selectOnFocus?: boolean | undefined; selectOnFocus?: boolean | undefined;
/** /**
* Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration. * 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; filterMessage?: string | undefined;
/** /**
* Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration. * 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; selectionMessage?: string | undefined;
/** /**
* Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration. * 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; emptySelectionMessage?: string | undefined;
/** /**
* Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration. * 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; emptyFilterMessage?: string | undefined;
/** /**
* Text to display when there are no options available. Defaults to value from PrimeVue locale configuration. * 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; emptyMessage?: string | undefined;
/** /**

View File

@ -152,7 +152,7 @@ export interface FileUploadProps {
url?: string | undefined; url?: string | undefined;
/** /**
* Defines the UI of the component, possible values are 'advanced' and 'basic'. * Defines the UI of the component, possible values are 'advanced' and 'basic'.
* @defaultValue advanced * @defaultValue 'advanced'
*/ */
mode?: 'advanced' | 'basic' | undefined; mode?: 'advanced' | 'basic' | undefined;
/** /**
@ -180,17 +180,17 @@ export interface FileUploadProps {
maxFileSize?: number | undefined; maxFileSize?: number | undefined;
/** /**
* Message of the invalid fize size. * 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; invalidFileSizeMessage?: string | undefined;
/** /**
* Message to display when number of files to be uploaded exceeeds the limit. * 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; invalidFileLimitMessage?: string | undefined;
/** /**
* Message of the invalid fize type. * Message of the invalid fize type.
* @defaultValue {0}: Invalid file type. * @defaultValue '{0}: Invalid file type.'
*/ */
invalidFileTypeMessage?: string | undefined; invalidFileTypeMessage?: string | undefined;
/** /**
@ -222,7 +222,6 @@ export interface FileUploadProps {
cancelLabel?: string | undefined; cancelLabel?: string | undefined;
/** /**
* Whether to use the default upload or a manual implementation defined in uploadHandler callback. Defaults to PrimeVue Locale configuration. * Whether to use the default upload or a manual implementation defined in uploadHandler callback. Defaults to PrimeVue Locale configuration.
* @defaultValue false
*/ */
customUpload?: boolean | undefined; customUpload?: boolean | undefined;
/** /**
@ -237,17 +236,17 @@ export interface FileUploadProps {
showCancelButton?: boolean | undefined; showCancelButton?: boolean | undefined;
/** /**
* Icon of the choose button. * Icon of the choose button.
* @defaultValue pi pi-fw pi-plus * @defaultValue 'pi pi-fw pi-plus'
*/ */
chooseIcon?: string | undefined; chooseIcon?: string | undefined;
/** /**
* Icon of the upload button. * Icon of the upload button.
* @defaultValue pi pi-fw pi-upload * @defaultValue 'pi pi-fw pi-upload'
*/ */
uploadIcon?: string | undefined; uploadIcon?: string | undefined;
/** /**
* Icon of the cancel button. * Icon of the cancel button.
* @defaultValue pi pi-fw pi-times * @defaultValue 'pi pi-fw pi-times'
*/ */
cancelIcon?: string | undefined; cancelIcon?: string | undefined;
/** /**

View File

@ -100,12 +100,12 @@ export interface GalleriaProps {
showThumbnails?: boolean | undefined; showThumbnails?: boolean | undefined;
/** /**
* Position of thumbnails. * Position of thumbnails.
* @defaultValue bottom * @defaultValue 'bottom'
*/ */
thumbnailsPosition?: 'bottom' | 'top' | 'left' | 'right' | undefined; thumbnailsPosition?: 'bottom' | 'top' | 'left' | 'right' | undefined;
/** /**
* Height of the viewport in vertical thumbnail. * Height of the viewport in vertical thumbnail.
* @defaultValue 300px * @defaultValue '300px'
*/ */
verticalThumbnailViewPortHeight?: string | undefined; verticalThumbnailViewPortHeight?: string | undefined;
/** /**
@ -120,7 +120,7 @@ export interface GalleriaProps {
showIndicatorsOnItem?: boolean | undefined; showIndicatorsOnItem?: boolean | undefined;
/** /**
* Position of indicators. * Position of indicators.
* @defaultValue bottom * @defaultValue 'bottom'
*/ */
indicatorsPosition?: 'bottom' | 'top' | 'left' | 'right' | undefined; indicatorsPosition?: 'bottom' | 'top' | 'left' | 'right' | undefined;
/** /**

View File

@ -31,7 +31,7 @@ export interface InplaceProps {
disabled?: boolean | undefined; disabled?: boolean | undefined;
/** /**
* Icon to display in the close button. * Icon to display in the close button.
* @defaultValue pi pi-times * @defaultValue 'pi pi-times'
*/ */
closeIcon?: string | undefined; closeIcon?: string | undefined;
/** /**

View File

@ -19,7 +19,7 @@ export interface InputMaskProps {
modelValue?: string | undefined; modelValue?: string | undefined;
/** /**
* Placeholder character in mask, default is underscore. * Placeholder character in mask, default is underscore.
* @defaultValue _ * @defaultValue '_'
*/ */
slotChar?: string | undefined; slotChar?: string | undefined;
/** /**

View File

@ -60,7 +60,7 @@ export interface InputNumberProps {
showButtons?: boolean | undefined; showButtons?: boolean | undefined;
/** /**
* Layout of the buttons. * Layout of the buttons.
* Default value is 'stacked'. * @defaultValue 'stacked'.
*/ */
buttonLayout?: 'stacked' | 'horizontal' | 'vertical' | undefined; buttonLayout?: 'stacked' | 'horizontal' | 'vertical' | undefined;
/** /**
@ -73,12 +73,12 @@ export interface InputNumberProps {
decrementButtonClass?: string | undefined; decrementButtonClass?: string | undefined;
/** /**
* Style class of the increment button. * Style class of the increment button.
* Default value is 'pi pi-angle-up'. * @defaultValue 'pi pi-angle-up'
*/ */
incrementButtonIcon?: string | undefined; incrementButtonIcon?: string | undefined;
/** /**
* Style class of the decrement button. * Style class of the decrement button.
* Default value is 'pi pi-angle-down'. * @defaultValue 'pi pi-angle-down'
*/ */
decrementButtonIcon?: string | undefined; 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'. * 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. * 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; localeMatcher?: 'lookup' | 'best fit' | undefined;
/** /**
* Defines the behavior of the component. * Defines the behavior of the component.
* Default value is 'decimal'. * @defaultValue 'decimal'.
*/ */
mode?: 'decimal' | 'currency' | undefined; mode?: 'decimal' | 'currency' | undefined;
/** /**
@ -111,7 +111,7 @@ export interface InputNumberProps {
currency?: string | undefined; 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'. * 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; currencyDisplay?: string | undefined;
/** /**

View File

@ -49,17 +49,17 @@ export interface KnobProps {
max?: number | undefined; max?: number | undefined;
/** /**
* Background of the value. * Background of the value.
* @defaultValue var(--primary-color, Black) * @defaultValue 'var(--primary-color, Black)'
*/ */
valueColor?: string | undefined; valueColor?: string | undefined;
/** /**
* Background color of the range. * Background color of the range.
* @defaultValue var(--surface-border, LightGray) * @defaultValue 'var(--surface-border, LightGray)'
*/ */
rangeColor?: string | undefined; rangeColor?: string | undefined;
/** /**
* Color of the value text. * Color of the value text.
* @defaultValue var(--text-color-secondary, Black) * @defaultValue 'var(--text-color-secondary, Black)'
*/ */
textColor?: string | undefined; textColor?: string | undefined;
/** /**
@ -74,7 +74,7 @@ export interface KnobProps {
showValue?: boolean | undefined; showValue?: boolean | undefined;
/** /**
* Template string of the value. * Template string of the value.
* @defaultValue \{value} * @defaultValue '{value}'
*/ */
valueTemplate?: string | undefined; valueTemplate?: string | undefined;
/** /**

View File

@ -112,7 +112,7 @@ export interface ListboxProps {
filterLocale?: string | undefined; filterLocale?: string | undefined;
/** /**
* Defines the filtering algorithm to use when searching the options. * Defines the filtering algorithm to use when searching the options.
* @defaultValue contains * @defaultValue 'contains'
*/ */
filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | undefined; filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | undefined;
/** /**
@ -140,27 +140,27 @@ export interface ListboxProps {
selectOnFocus?: boolean | undefined; selectOnFocus?: boolean | undefined;
/** /**
* Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration. * 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; filterMessage?: string | undefined;
/** /**
* Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration. * 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; selectionMessage?: string | undefined;
/** /**
* Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration. * 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; emptySelectionMessage?: string | undefined;
/** /**
* Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration. * 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; emptyFilterMessage?: string | undefined;
/** /**
* Text to display when there are no options available. Defaults to value from PrimeVue locale configuration. * 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; emptyMessage?: string | undefined;
/** /**
@ -169,7 +169,7 @@ export interface ListboxProps {
tabindex?: number | string | undefined; tabindex?: number | string | undefined;
/** /**
* Icon to display in filter input. * Icon to display in filter input.
* @defaultValue pi pi-search * @defaultValue 'ß'
*/ */
filterIcon?: string | undefined; filterIcon?: string | undefined;
/** /**

View File

@ -21,7 +21,7 @@ export interface MegaMenuProps {
model?: MenuItem[] | undefined; model?: MenuItem[] | undefined;
/** /**
* Defines the orientation. * Defines the orientation.
* @defaultValue horizontal * @defaultValue 'horizontal'
*/ */
orientation?: 'horizontal' | 'vertical' | undefined; orientation?: 'horizontal' | 'vertical' | undefined;
/** /**

View File

@ -26,7 +26,7 @@ export interface MenuProps {
popup?: boolean | undefined; popup?: boolean | undefined;
/** /**
* A valid query selector or an HTMLElement to specify where the overlay gets attached. * A valid query selector or an HTMLElement to specify where the overlay gets attached.
* @defaultValue body * @defaultValue 'body'
*/ */
appendTo?: 'body' | 'self' | string | undefined | HTMLElement; appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
/** /**

View File

@ -90,7 +90,7 @@ export interface MultiSelectProps {
optionGroupChildren?: string | ((data: any) => any[]) | undefined; optionGroupChildren?: string | ((data: any) => any[]) | undefined;
/** /**
* Height of the viewport, a scrollbar is defined if height of list exceeds this value. * Height of the viewport, a scrollbar is defined if height of list exceeds this value.
* @defaultValue 200px * @defaultValue '200px'
*/ */
scrollHeight?: string | undefined; scrollHeight?: string | undefined;
/** /**
@ -149,7 +149,7 @@ export interface MultiSelectProps {
filterLocale?: string | undefined; filterLocale?: string | undefined;
/** /**
* Defines the filtering algorithm to use when searching the options. * Defines the filtering algorithm to use when searching the options.
* @defaultValue contains * @defaultValue 'contains'
*/ */
filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | undefined; filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | undefined;
/** /**
@ -158,17 +158,17 @@ export interface MultiSelectProps {
filterFields?: string[] | undefined; 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. * 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; appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
/** /**
* Defines how the selected items are displayed. * Defines how the selected items are displayed.
* @defaultValue comma * @defaultValue 'comma'
*/ */
display?: 'comma' | 'chip' | undefined; display?: 'comma' | 'chip' | undefined;
/** /**
* Label to display after exceeding max selected labels. * Label to display after exceeding max selected labels.
* @defaultValue {0} items selected * @defaultValue '{0} items selected'
*/ */
selectedItemsLabel?: string | undefined; selectedItemsLabel?: string | undefined;
/** /**
@ -191,32 +191,32 @@ export interface MultiSelectProps {
loading?: boolean | undefined; loading?: boolean | undefined;
/** /**
* Icon to display in the checkboxes. * Icon to display in the checkboxes.
* @defaultValue pi pi-check * @defaultValue 'pi pi-check'
*/ */
checkboxIcon?: string | undefined; checkboxIcon?: string | undefined;
/** /**
* Icon to display in the dropdown close button. * Icon to display in the dropdown close button.
* @defaultValue pi pi-times * @defaultValue 'pi pi-times'
*/ */
closeIcon?: string | undefined; closeIcon?: string | undefined;
/** /**
* Icon to display in the dropdown. * Icon to display in the dropdown.
* @defaultValue pi pi-chevron-down * @defaultValue 'pi pi-chevron-down'
*/ */
dropdownIcon?: string | undefined; dropdownIcon?: string | undefined;
/** /**
* Icon to display in filter input. * Icon to display in filter input.
* @defaultValue pi pi-search * @defaultValue 'pi pi-search'
*/ */
filterIcon?: string | undefined; filterIcon?: string | undefined;
/** /**
* Icon to display in loading state. * Icon to display in loading state.
* @defaultValue pi pi-spinner pi-spin * @defaultValue 'pi pi-spinner pi-spin'
*/ */
loadingIcon?: string | undefined; loadingIcon?: string | undefined;
/** /**
* Icon to display in chip remove action. * Icon to display in chip remove action.
* @defaultValue pi pi-times-circle * @defaultValue 'pi pi-times-circle'
*/ */
removeTokenIcon?: string | undefined; removeTokenIcon?: string | undefined;
/** /**
@ -246,27 +246,27 @@ export interface MultiSelectProps {
autoFilterFocus?: boolean | undefined; autoFilterFocus?: boolean | undefined;
/** /**
* Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration. * 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; filterMessage?: string | undefined;
/** /**
* Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration. * 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; selectionMessage?: string | undefined;
/** /**
* Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration. * 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; emptySelectionMessage?: string | undefined;
/** /**
* Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration. * 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; emptyFilterMessage?: string | undefined;
/** /**
* Text to display when there are no options available. Defaults to value from PrimeVue locale configuration. * 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; emptyMessage?: string | undefined;
/** /**

View File

@ -78,7 +78,7 @@ export interface OrderListProps {
responsive?: boolean | undefined; responsive?: boolean | undefined;
/** /**
* The breakpoint to define the maximum width boundary when responsiveness is enabled. * The breakpoint to define the maximum width boundary when responsiveness is enabled.
* @defaultValue 960px * @defaultValue '960px'
*/ */
breakpoint?: string | undefined; breakpoint?: string | undefined;
/** /**

View File

@ -48,7 +48,7 @@ export interface OverlayPanelProps {
showCloseIcon?: boolean; showCloseIcon?: boolean;
/** /**
* A valid query selector or an HTMLElement to specify where the overlay gets attached. * A valid query selector or an HTMLElement to specify where the overlay gets attached.
* @defaultValue body * @defaultValue 'body'
*/ */
appendTo?: 'body' | 'self' | string | undefined | HTMLElement; appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
/** /**

View File

@ -84,7 +84,7 @@ export interface PaginatorProps {
* - {last} * - {last}
* - {totalRecords} * - {totalRecords}
* *
* @defaultValue ({currentPage} of {totalPages}) * @defaultValue '({currentPage} of {totalPages})'
*/ */
currentPageReportTemplate?: string | undefined; currentPageReportTemplate?: string | undefined;
/** /**

View File

@ -24,12 +24,12 @@ export interface PasswordProps extends InputHTMLAttributes {
promptLabel?: string | undefined; promptLabel?: string | undefined;
/** /**
* Regex for a medium level password. * 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; mediumRegex?: string | undefined;
/** /**
* Regex for a strong level password. * 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; strongRegex?: string | undefined;
/** /**
@ -51,7 +51,7 @@ export interface PasswordProps extends InputHTMLAttributes {
feedback?: boolean | undefined; feedback?: boolean | undefined;
/** /**
* A valid query selector or an HTMLElement to specify where the overlay gets attached. * A valid query selector or an HTMLElement to specify where the overlay gets attached.
* @defaultValue body * @defaultValue 'body'
*/ */
appendTo?: 'body' | 'self' | string | undefined | HTMLElement; appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
/** /**
@ -61,12 +61,12 @@ export interface PasswordProps extends InputHTMLAttributes {
toggleMask?: boolean | undefined; toggleMask?: boolean | undefined;
/** /**
* Icon to hide displaying the password as plain text. * Icon to hide displaying the password as plain text.
* @defaultValue pi pi-eye-slash * @defaultValue 'pi pi-eye-slash'
*/ */
hideIcon?: string | undefined; hideIcon?: string | undefined;
/** /**
* Icon to show displaying the password as plain text. * Icon to show displaying the password as plain text.
* @defaultValue pi pi-eye * @defaultValue 'pi pi-eye'
*/ */
showIcon?: string | undefined; showIcon?: string | undefined;
/** /**

View File

@ -20,7 +20,7 @@ export interface ProgressBarProps {
value?: number | undefined; value?: number | undefined;
/** /**
* Defines the mode of the progress * Defines the mode of the progress
* @defaultValue determinate * @defaultValue 'determinate'
*/ */
mode?: 'determinate' | 'indeterminate' | undefined; mode?: 'determinate' | 'indeterminate' | undefined;
/** /**

View File

@ -15,7 +15,7 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
export interface ProgressSpinnerProps { export interface ProgressSpinnerProps {
/** /**
* Width of the circle stroke. * Width of the circle stroke.
* @defaultValue 2 * @defaultValue '2'
*/ */
strokeWidth?: string | undefined; strokeWidth?: string | undefined;
/** /**
@ -24,7 +24,7 @@ export interface ProgressSpinnerProps {
fill?: string | undefined; fill?: string | undefined;
/** /**
* Duration of the rotate animation. * Duration of the rotate animation.
* @defaultValue 2s * @defaultValue '2s'
*/ */
animationDuration?: string | undefined; animationDuration?: string | undefined;
} }

View File

@ -59,17 +59,17 @@ export interface RatingProps {
cancel?: boolean | undefined; cancel?: boolean | undefined;
/** /**
* Icon for the on state. * Icon for the on state.
* @defaultValue pi pi-star * @defaultValue 'pi pi-star'
*/ */
onIcon?: string | undefined; onIcon?: string | undefined;
/** /**
* Icon for the off state. * Icon for the off state.
* @defaultValue pi pi-star-fill * @defaultValue 'pi pi-star-fill'
*/ */
offIcon?: string | undefined; offIcon?: string | undefined;
/** /**
* Icon for the cancelable state. * Icon for the cancelable state.
* @defaultValue pi pi-ban * @defaultValue 'pi pi-ban'
*/ */
cancelIcon?: string | undefined; cancelIcon?: string | undefined;
} }

View File

@ -15,7 +15,7 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
export interface ScrollTopProps { export interface ScrollTopProps {
/** /**
* Target of the ScrollTop. * Target of the ScrollTop.
* @defaultValue window * @defaultValue 'window'
*/ */
target?: 'window' | 'parent' | undefined; target?: 'window' | 'parent' | undefined;
/** /**
@ -25,12 +25,12 @@ export interface ScrollTopProps {
threshold?: number | undefined; threshold?: number | undefined;
/** /**
* Icon to display. * Icon to display.
* @defaultValue pi pi-chevron-up * @defaultValue 'pi pi-chevron-up'
*/ */
icon?: string | undefined; icon?: string | undefined;
/** /**
* Defines the scrolling behaviour, 'smooth' adds an animation and 'auto' scrolls with a jump. * Defines the scrolling behaviour, 'smooth' adds an animation and 'auto' scrolls with a jump.
* @defaultValue smooth * @defaultValue 'smooth'
*/ */
behavior?: string | undefined; behavior?: string | undefined;
} }

View File

@ -21,7 +21,7 @@ export interface SidebarProps {
visible?: boolean | undefined; visible?: boolean | undefined;
/** /**
* Specifies the position of the sidebar. * Specifies the position of the sidebar.
* @defaultValue left * @defaultValue 'left'
*/ */
position?: 'left' | 'right' | 'top' | 'bottom' | 'full' | undefined; position?: 'left' | 'right' | 'top' | 'bottom' | 'full' | undefined;
/** /**
@ -46,7 +46,7 @@ export interface SidebarProps {
showCloseIcon?: boolean | undefined; showCloseIcon?: boolean | undefined;
/** /**
* Icon to display in the sidebar close button. * Icon to display in the sidebar close button.
* @defaultValue pi pi-times * @defaultValue 'pi pi-times'
*/ */
closeIcon?: string | undefined; closeIcon?: string | undefined;
/** /**

View File

@ -15,7 +15,7 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
export interface SkeletonProps { export interface SkeletonProps {
/** /**
* Shape of the element. * Shape of the element.
* @defaultValue rectangle * @defaultValue 'rectangle'
*/ */
shape?: 'rectangle' | 'circle' | undefined; shape?: 'rectangle' | 'circle' | undefined;
/** /**
@ -24,12 +24,12 @@ export interface SkeletonProps {
size?: string | undefined; size?: string | undefined;
/** /**
* Width of the element. * Width of the element.
* @defaultValue 100% * @defaultValue '100%'
*/ */
width?: string | undefined; width?: string | undefined;
/** /**
* Height of the element. * Height of the element.
* @defaultValue 1rem * @defaultValue '1rem'
*/ */
height?: string | undefined; height?: string | undefined;
/** /**
@ -38,7 +38,7 @@ export interface SkeletonProps {
borderRadius?: string | undefined; borderRadius?: string | undefined;
/** /**
* Type of the animation. * Type of the animation.
* @defaultValue wave * @defaultValue 'wave'
*/ */
animation?: 'wave' | 'none' | undefined; animation?: 'wave' | 'none' | undefined;
} }

View File

@ -44,7 +44,7 @@ export interface SliderProps {
max?: number | undefined; max?: number | undefined;
/** /**
* Orientation of the slider. * Orientation of the slider.
* @defaultValue horizontal * @defaultValue 'horizontal'
*/ */
orientation?: 'horizontal' | 'vertical' | undefined; orientation?: 'horizontal' | 'vertical' | undefined;
/** /**

View File

@ -22,7 +22,7 @@ export interface SpeedDialTooltipOptions {
event: 'hover' | 'focus' | undefined; event: 'hover' | 'focus' | undefined;
/** /**
* Position of element. * Position of element.
* Default value is 'bottom'. * @defaultValue 'bottom'.
*/ */
position: 'bottom' | 'top' | 'left' | 'right' | undefined; position: 'bottom' | 'top' | 'left' | 'right' | undefined;
/** /**
@ -46,7 +46,7 @@ export interface SpeedDialProps {
visible?: boolean | undefined; visible?: boolean | undefined;
/** /**
* Specifies the opening direction of actions. * Specifies the opening direction of actions.
* @defaultValue up * @defaultValue 'up'
*/ */
direction?: 'up' | 'down' | 'left' | 'right' | 'up-left' | 'up-right' | 'down-left' | 'down-right' | undefined; direction?: 'up' | 'down' | 'left' | 'right' | 'up-left' | 'up-right' | 'down-left' | 'down-right' | undefined;
/** /**
@ -56,7 +56,7 @@ export interface SpeedDialProps {
transitionDelay?: number | undefined; transitionDelay?: number | undefined;
/** /**
* Specifies the opening type of actions. * Specifies the opening type of actions.
* @defaultValue linear * @defaultValue 'linear'
*/ */
type?: 'linear' | 'circle' | 'semi-circle' | 'quarter-circle' | undefined; type?: 'linear' | 'circle' | 'semi-circle' | 'quarter-circle' | undefined;
/** /**
@ -93,7 +93,7 @@ export interface SpeedDialProps {
maskClass?: string | undefined; maskClass?: string | undefined;
/** /**
* Show icon of the button element. * Show icon of the button element.
* @defaultValue pi pi-plus * @defaultValue 'pi pi-plus'
*/ */
showIcon?: string | undefined; showIcon?: string | undefined;
/** /**

View File

@ -40,7 +40,7 @@ export interface SplitButtonProps {
/** /**
* A valid query selector or an HTMLElement to specify where the overlay gets attached. * 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. * Special keywords are 'body' for document body and 'self' for the element itself.
* @defaultValue body * @defaultValue 'body'
*/ */
appendTo?: 'body' | 'self' | string | undefined | HTMLElement; appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
/** /**

View File

@ -60,7 +60,7 @@ export interface SplitterProps {
stateKey?: string | undefined; stateKey?: string | undefined;
/** /**
* Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage. * 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; stateStorage?: 'local' | 'session' | undefined;
/** /**

View File

@ -19,12 +19,12 @@ export interface TimelineProps {
value?: any[] | undefined; value?: any[] | undefined;
/** /**
* Position of the timeline bar relative to the content. * Position of the timeline bar relative to the content.
* @defaultValue left * @defaultValue 'left'
*/ */
align?: 'left' | 'right' | 'alternate' | 'top' | 'bottom' | undefined; align?: 'left' | 'right' | 'alternate' | 'top' | 'bottom' | undefined;
/** /**
* Orientation of the timeline. * Orientation of the timeline.
* @defaultValue horizontal * @defaultValue 'horizontal'
*/ */
layout?: 'vertical' | 'horizontal' | undefined; layout?: 'vertical' | 'horizontal' | undefined;
/** /**

View File

@ -13,7 +13,7 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
export interface ToastMessageOptions { export interface ToastMessageOptions {
/** /**
* Severity level of the message. * Severity level of the message.
* Default value is 'info'. * @defaultValue 'info'
*/ */
severity?: 'success' | 'info' | 'warn' | 'error' | undefined; severity?: 'success' | 'info' | 'warn' | 'error' | undefined;
/** /**
@ -26,12 +26,12 @@ export interface ToastMessageOptions {
detail?: any | undefined; detail?: any | undefined;
/** /**
* Whether the message can be closed manually using the close icon. * Whether the message can be closed manually using the close icon.
* Default value is true. * @defaultValue true
*/ */
closable?: boolean | undefined; closable?: boolean | undefined;
/** /**
* Delay in milliseconds to close the message automatically. * Delay in milliseconds to close the message automatically.
* Default value is 3000. * @defaultValue 3000
*/ */
life?: number | undefined; life?: number | undefined;
/** /**

View File

@ -39,7 +39,7 @@ export interface ToggleButtonProps {
offLabel?: string | undefined; offLabel?: string | undefined;
/** /**
* Position of the icon. * Position of the icon.
* @defaultValue left * @defaultValue 'left'
*/ */
iconPos?: 'left' | 'right' | undefined; iconPos?: 'left' | 'right' | undefined;
/** /**

View File

@ -120,7 +120,7 @@ export interface TreeProps {
loading?: boolean | undefined; loading?: boolean | undefined;
/** /**
* Icon to display when tree is loading. * Icon to display when tree is loading.
* @defaultValue pi pi-spin * @defaultValue 'pi pi-spin'
*/ */
loadingIcon?: string | undefined; loadingIcon?: string | undefined;
/** /**
@ -129,12 +129,12 @@ export interface TreeProps {
filter?: boolean | undefined; filter?: boolean | undefined;
/** /**
* When filtering is enabled, filterBy decides which field or fields (comma separated) to search against. * When filtering is enabled, filterBy decides which field or fields (comma separated) to search against.
* Default valye is 'label'. * @defaultValue 'label'
*/ */
filterBy?: string | undefined; filterBy?: string | undefined;
/** /**
* Mode for filtering. * Mode for filtering.
* @defaultValue lenient * @defaultValue 'lenient'
*/ */
filterMode?: 'lenient' | 'strict' | undefined; filterMode?: 'lenient' | 'strict' | undefined;
/** /**

View File

@ -25,7 +25,7 @@ export interface TreeSelectProps {
options?: TreeNode[] | undefined; options?: TreeNode[] | undefined;
/** /**
* Height of the viewport, a scrollbar is defined if height of list exceeds this value. * Height of the viewport, a scrollbar is defined if height of list exceeds this value.
* @defaultValue 200px * @defaultValue '200px'
*/ */
scrollHeight?: string | undefined; scrollHeight?: string | undefined;
/** /**
@ -51,17 +51,17 @@ export interface TreeSelectProps {
panelClass?: any; panelClass?: any;
/** /**
* A valid query selector or an HTMLElement to specify where the overlay gets attached. * A valid query selector or an HTMLElement to specify where the overlay gets attached.
* @defaultValue body * @defaultValue 'body'
*/ */
appendTo?: 'body' | 'self' | string | undefined | HTMLElement; appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
/** /**
* Text to display when there are no options available. Defaults to value from PrimeVue locale configuration. * 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; emptyMessage?: string | undefined;
/** /**
* Defines how the selected items are displayed. * Defines how the selected items are displayed.
* @defaultValue comma * @defaultValue 'comma'
*/ */
display?: 'comma' | 'chip' | undefined; display?: 'comma' | 'chip' | undefined;
/** /**

View File

@ -221,7 +221,7 @@ export interface TreeTableProps {
* - JumpToPageInput * - JumpToPageInput
* - CurrentPageReport * - CurrentPageReport
* *
* @defaultValue FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown * @defaultValue 'FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown'
*/ */
paginatorTemplate?: string | undefined; paginatorTemplate?: string | undefined;
/** /**
@ -243,7 +243,7 @@ export interface TreeTableProps {
* - {last} * - {last}
* - {totalRecords} * - {totalRecords}
* *
* @defaultValue ({currentPage} of {totalPages}) * @defaultValue '({currentPage} of {totalPages})'
*/ */
currentPageReportTemplate?: string | undefined; currentPageReportTemplate?: string | undefined;
/** /**
@ -258,7 +258,7 @@ export interface TreeTableProps {
loading?: boolean | undefined; loading?: boolean | undefined;
/** /**
* The icon to show while indicating data load is in progress. * The icon to show while indicating data load is in progress.
* @defaultValue pi pi-spinner * @defaultValue 'pi pi-spinner'
*/ */
loadingIcon?: string | undefined; loadingIcon?: string | undefined;
/** /**
@ -290,7 +290,7 @@ export interface TreeTableProps {
multiSortMeta?: TreeTableSortMeta[] | undefined | null; multiSortMeta?: TreeTableSortMeta[] | undefined | null;
/** /**
* Defines whether sorting works on single column or on multiple columns. * Defines whether sorting works on single column or on multiple columns.
* @defaultValue single * @defaultValue 'single'
*/ */
sortMode?: 'single' | 'multiple' | undefined; sortMode?: 'single' | 'multiple' | undefined;
/** /**
@ -305,7 +305,7 @@ export interface TreeTableProps {
filters?: TreeTableFilterMeta; filters?: TreeTableFilterMeta;
/** /**
* Mode for filtering. * Mode for filtering.
* @defaultValue lenient * @defaultValue 'lenient'
*/ */
filterMode?: 'lenient' | 'strict' | undefined; filterMode?: 'lenient' | 'strict' | undefined;
/** /**
@ -318,7 +318,7 @@ export interface TreeTableProps {
resizableColumns?: boolean | undefined; resizableColumns?: boolean | undefined;
/** /**
* Defines whether the overall table width should change on column resize. * Defines whether the overall table width should change on column resize.
* @defaultValue fit * @defaultValue 'fit'
*/ */
columnResizeMode?: 'fit' | 'expand' | undefined; columnResizeMode?: 'fit' | 'expand' | undefined;
/** /**
@ -342,12 +342,12 @@ export interface TreeTableProps {
scrollHeight?: 'flex' | string | undefined; scrollHeight?: 'flex' | string | undefined;
/** /**
* Orientation of the scrolling. * Orientation of the scrolling.
* @defaultValue vertical * @defaultValue 'vertical'
*/ */
scrollDirection?: 'vertical' | 'horizontal' | 'both' | undefined; scrollDirection?: 'vertical' | 'horizontal' | 'both' | undefined;
/** /**
* Defines the responsive mode, currently only option is scroll. * Defines the responsive mode, currently only option is scroll.
* @defaultValue stack * @defaultValue 'stack'
*/ */
responsiveLayout?: 'stack' | 'scroll' | undefined; responsiveLayout?: 'stack' | 'scroll' | undefined;
/** /**

File diff suppressed because it is too large Load Diff