.d.ts default false value updates

pull/3737/head
Tuğçe Küçükoğlu 2023-03-10 17:00:58 +03:00
parent 5f5c7c6add
commit 98304ea853
15 changed files with 37 additions and 3 deletions

View File

@ -16,10 +16,12 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
export interface BlockUIProps {
/**
* Controls the blocked state.
* @defaultValue false
*/
blocked?: boolean | undefined;
/**
* When enabled, the whole document gets blocked.
* @defaultValue false
*/
fullScreen?: boolean | undefined;
/**

View File

@ -46,11 +46,12 @@ export interface ChipsProps {
max?: number | undefined;
/**
* Whether to add an item when the input loses focus.
* @defaultValue false
*/
addOnBlur?: boolean | undefined;
/**
* Whether to allow duplicate values or not.
* @defaultValue true.
* @defaultValue true
*/
allowDuplicate?: boolean | undefined;
/**

View File

@ -94,6 +94,7 @@ export interface ColumnProps {
dataType?: string | undefined;
/**
* Defines if a column is sortable.
* @defaultValue false
*/
sortable?: boolean | undefined;
/**
@ -177,6 +178,7 @@ export interface ColumnProps {
maxConstraints?: number | undefined;
/**
* Whether to exclude from global filtering or not.
* @defaultValue false
*/
excludeGlobalFilter?: boolean | undefined;
/**
@ -201,6 +203,7 @@ export interface ColumnProps {
selectionMode?: 'single' | 'multiple' | undefined;
/**
* Displays an icon to toggle row expansion.
* @defaultValue false
*/
expander?: boolean | undefined;
/**
@ -213,6 +216,7 @@ export interface ColumnProps {
rowspan?: number | undefined;
/**
* Whether this column displays an icon to reorder the rows.
* @defaultValue false
*/
rowReorder?: boolean | undefined;
/**
@ -222,14 +226,17 @@ export interface ColumnProps {
rowReorderIcon?: string | undefined;
/**
* Defines if the column itself can be reordered with dragging.
* @defaultValue false
*/
reorderableColumn?: boolean | undefined;
/**
* When enabled, column displays row editor controls.
* @defaultValue false
*/
rowEditor?: boolean | undefined;
/**
* Whether the column is fixed in horizontal scrolling.
* @defaultValue false
*/
frozen?: boolean | undefined;
/**
@ -239,6 +246,7 @@ export interface ColumnProps {
alignFrozen?: 'left' | 'right' | undefined;
/**
* Whether the column is included in data export.
* @defaultValue false
*/
exportable?: boolean | undefined;
/**
@ -255,6 +263,7 @@ export interface ColumnProps {
filterMatchMode?: string | undefined;
/**
* Whether the column is rendered.
* @defaultValue false
*/
hidden?: boolean | undefined;
}

View File

@ -37,6 +37,7 @@ export interface ConfirmationOptions {
icon?: string | undefined;
/**
* Whether background scroll should be blocked when dialog is visible.
* @defaultValue false
*/
blockScroll?: boolean | undefined;
/**

View File

@ -80,6 +80,7 @@ export interface DropdownProps {
scrollHeight?: string | undefined;
/**
* When specified, displays a filter input at header.
* @defaultValue false
*/
filter?: boolean | undefined;
/**
@ -101,6 +102,7 @@ export interface DropdownProps {
filterFields?: string[] | undefined;
/**
* When present, custom value instead of predefined options can be entered using the editable input field.
* @defaultValue false
*/
editable?: boolean | undefined;
/**
@ -109,6 +111,7 @@ export interface DropdownProps {
placeholder?: string | undefined;
/**
* When present, it specifies that the component should be disabled.
* @defaultValue false
*/
disabled?: boolean | undefined;
/**
@ -117,6 +120,7 @@ export interface DropdownProps {
dataKey?: string | undefined;
/**
* When enabled, a clear icon is displayed to clear the value.
* @defaultValue false
*/
showClear?: boolean | undefined;
/**
@ -162,6 +166,7 @@ export interface DropdownProps {
appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
/**
* Whether the dropdown is in loading state.
* @defaultValue false
*/
loading?: boolean | undefined;
/**
@ -186,6 +191,7 @@ export interface DropdownProps {
loadingIcon?: string | undefined;
/**
* Clears the filter value when hiding the dropdown.
* @defaultValue false
*/
resetFilterOnHide?: boolean;
/**

View File

@ -91,6 +91,7 @@ export interface EditorProps {
placeholder?: string | undefined;
/**
* Whether to instantiate the editor to readonly mode.
* @defaultValue false
*/
readonly?: boolean | undefined;
/**

View File

@ -16,6 +16,7 @@ import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
export interface InputSwitchProps {
/**
* Specifies whether a inputswitch should be checked or not.
* @defaultValue false
*/
modelValue?: boolean | string | undefined;
/**

View File

@ -32,12 +32,12 @@ export interface OrganizationChartNode {
data?: any;
/**
* Whether node is selectable when selection is enabled.
* Default value is true.
* @defaultValue true
*/
selectable?: boolean;
/**
* Whether node is collapsible when node expansion is enabled.
* Default value is true.
* @defaultValue true
*/
collapsible?: boolean;
/**
@ -86,6 +86,7 @@ export interface OrganizationChartProps {
collapsedKeys?: OrganizationChartCollapsedKeys;
/**
* Whether the nodes can be expanded or toggled.
* @defaultValue false
*/
collapsible?: boolean;
}

View File

@ -35,10 +35,12 @@ export interface PanelProps {
header?: string;
/**
* Defines if content of panel can be expanded and collapsed.
* @defaultValue false
*/
toggleable?: boolean;
/**
* Defines the initial state of panel content.
* @defaultValue false
*/
collapsed?: boolean;
/**

View File

@ -12,6 +12,7 @@ export interface PortalProps {
appendTo?: PortalAppendToType;
/**
* If disabled, the Portal feature is eliminated and the content is displayed directly.
* @defaultValue false
*/
disabled?: boolean | undefined;
}

View File

@ -28,6 +28,7 @@ export interface RadioButtonProps {
name?: string | undefined;
/**
* When present, it specifies that the component should be disabled.
* @defaultValue false
*/
disabled?: boolean | undefined;
/**

View File

@ -21,6 +21,7 @@ export interface TextareaProps extends TextareaHTMLAttributes {
modelValue?: string | undefined;
/**
* When present, height of textarea changes as being typed.
* @defaultValue false
*/
autoResize?: boolean | undefined;
}

View File

@ -21,6 +21,7 @@ export interface TieredMenuProps {
model?: MenuItem[] | undefined;
/**
* Defines if menu would displayed as a popup.
* @defaultValue false
*/
popup?: boolean | undefined;
/**
@ -45,6 +46,7 @@ export interface TieredMenuProps {
exact?: boolean | undefined;
/**
* When present, it specifies that the component should be disabled.
* @defaultValue false
*/
disabled?: boolean | undefined;
/**

View File

@ -48,10 +48,12 @@ export interface TreeNode {
styleClass?: string;
/**
* Whether the node is selectable when selection mode is enabled.
* @defaultValue false
*/
selectable?: boolean;
/**
* Specifies if the node has children. Used in lazy loading.
* @defaultValue false
*/
leaf?: boolean;
/**
@ -126,6 +128,7 @@ export interface TreeProps {
loadingIcon?: string | undefined;
/**
* When specified, displays an input field to filter the items.
* @defaultValue false
*/
filter?: boolean | undefined;
/**

View File

@ -196,6 +196,7 @@ export interface TreeTableProps {
totalRecords?: number | undefined;
/**
* When specified as true, enables the pagination.
* @defaultValue false
*/
paginator?: boolean | undefined;
/**
@ -314,6 +315,7 @@ export interface TreeTableProps {
filterLocale?: string | undefined;
/**
* When enabled, columns can be resized using drag and drop.
* @defaultValue false
*/
resizableColumns?: boolean | undefined;
/**