JSDoc @default / type mismatch — Components Area by dmlvr · Pull Request #34287 · DevExpress/DevExtreme

dmlvr · 2026-07-13T15:46:25Z

No description provided.

Widen onValueChanged, validationError, validationErrors and value to include | null, matching the null stored in Editor._getDefaultOptions(). Widen _getValidationErrors() return type to unknown[] | null | undefined since it directly returns the now-nullable validationErrors option. Co-authored-by: Copilot <[email protected]>

Widen value to include | null, matching the null stored in DataExpressionMixin._dataExpressionDefaultOptions(). Co-authored-by: Copilot <[email protected]>

…d.ts Widen buttons to | undefined (runtime stores void 0) and onChange, onCopy, onCut, onEnterKey, onFocusIn, onFocusOut, onInput, onKeyDown, onKeyUp, onPaste to | null (runtime stores null), matching TextEditorBase._getDefaultOptions(). Co-authored-by: Copilot <[email protected]>

…et.base.d.ts Widen keyExpr, onItemClick, onItemContextMenu, onItemHold, onItemRendered, onSelectionChanging, onSelectionChanged and selectedItem to include | null, matching the null stored in CollectionWidget._getDefaultOptions() (collection_widget.base.ts / collection_widget.edit.ts). Widen List.scrollToItem() parameter type to accept | null: isDefined() already treats null and undefined identically at runtime, so this only corrects the signature to match the now-nullable selectedItem consumer in select_box.ts. Co-authored-by: Copilot <[email protected]>

Widen searchExpr to include | null: the mixin has no own default, but consumers (list.edit.search.ts, drop_down_list.ts) store null. Follow-on fixes required to keep check-types clean: - data_adapter.ts: widen DataAdapterOptions.searchExpr to | null since tree_view.search.ts passes the now-nullable option straight through; verified safe (data_adapter.ts consumes it via a nullish coalescing fallback and passes it as an opaque filter value). - list.edit.search.ts: remove the ts-expect-error over searchExpr: null, now unused after widening. - list.base.ts: add an explicit cast at the single affected call site in _getSpecificDataSourceOption() to work around a TS overload resolution fragility in component.d.ts option() (see Known Issues in progres_report.md for the full root-cause writeup). Co-authored-by: Copilot <[email protected]>

…_editor.d.ts Verified against js/__internal/ui/drop_down_editor/drop_down_editor.ts _getDefaultOptions(): - buttons stores void 0 -> add | undefined - onClosed, onOpened, value store null -> add | null Co-authored-by: Copilot <[email protected]>

@default

…_list.d.ts Verified against js/__internal/ui/drop_down_editor/drop_down_list.ts _getDefaultOptions() (onValueChanged inherited from editor.ts): - onSelectionChanged, onValueChanged, searchExpr, selectedItem store null -> add | null - onItemClick stores noop (a function) at this level, not null; the type is already correct (a function), so corrected the inaccurate @default null tag instead of widening the type (doc-only change, no behavior impact) Co-authored-by: Copilot <[email protected]>

Verified against js/__internal/ui/select_box.ts _getDefaultOptions(): fieldTemplate stores null -> add | null. Co-authored-by: Copilot <[email protected]>

@ts-expect-error

Verified against js/__internal/ui/color_box/color_box.ts _getDefaultOptions(): fieldTemplate stores null -> add | null. Removed the now-unused @ts-expect-error directly above fieldTemplate: null in color_box.ts, made stale by the widened type. Co-authored-by: Copilot <[email protected]>

fieldTemplate is inherited from js/__internal/ui/drop_down_editor/drop_down_editor.ts _getDefaultOptions(), which stores null -> add | null. Co-authored-by: Copilot <[email protected]>

@ts-expect-error

Verified against js/__internal/ui/lookup.ts _getDefaultOptions() (fieldTemplate inherited from drop_down_editor.ts, onValueChanged inherited from editor.ts): fieldTemplate, onPageLoading, onPullRefresh, onScroll, onValueChanged all store null -> add | null. Removed the 3 now-unused @ts-expect-error directives above onScroll/onPullRefresh/onPageLoading in lookup.ts, made stale by the widened types. Co-authored-by: Copilot <[email protected]>

Verified against js/__internal/ui/tag_box.ts _getDefaultOptions() (onSelectionChanged inherited from collection_widget.base.ts): onMultiTagPreparing, onSelectAllValueChanged, onSelectionChanged all store null -> add | null. Co-authored-by: Copilot <[email protected]>

Verified against js/__internal/ui/text_box/text_box.ts _getDefaultOptions(): maxLength stores null -> add | null. Co-authored-by: Copilot <[email protected]>

Verified against js/__internal/ui/number_box/m_number_box.base.ts _getDefaultOptions(): buttons stores void 0 -> add | undefined. Co-authored-by: Copilot <[email protected]>

@ts-expect-error

Verified against js/__internal/ui/date_box/date_box.base.ts _getDefaultOptions() (maxLength inherited from text_box.ts): - disabledDates, maxLength, displayFormat store null -> add | null - value?: DateLike is a known linter blind spot (DateLike already includes null; the linter does not resolve type aliases) -> left untouched, no edit needed Follow-on fixes required to keep check-types clean: - Removed 2 now-unused @ts-expect-error above displayFormat/ disabledDates in date_box.base.ts, made stale by the widened types. - Widened Strategy.getDisplayFormat's displayFormat param to accept | null across all 6 date_box strategy implementations (base, calendar, calendar_with_time, date_view, list, native); all bodies already treat null/undefined identically via `||` fallback, so this is a safe, behavior-preserving signature widening (same pattern as the earlier List.scrollToItem() fix). - Fixed a separate, unrelated latent bug exposed by the above: added the missing `useHiddenSubmitElement?: boolean;` field to DateBoxBaseProperties (already present on the internal DropDownEditorProperties type it structurally extends), resolving an excess-property-check error on the _getDefaultOptions() object literal that TypeScript had not previously surfaced. Co-authored-by: Copilot <[email protected]>

Verified against js/__internal/ui/calendar/calendar.ts _getDefaultOptions(): disabledDates stores null -> add | null. value?: DateLike | DateLike[] is a known linter blind spot (DateLike already includes null; the linter does not resolve type aliases) -> left untouched, no edit needed. Follow-on fix: widened the same-named disabledDates field on BaseViewProperties in calendar.base_view.ts (which also stores null in its own _getDefaultOptions()) to keep the object literal built in calendar.ts:_viewConfig() assignable. Co-authored-by: Copilot <[email protected]>

@default

value had a concrete @default false but the type included a spurious | undefined (R2: a concrete @default must not include | undefined). Verified against js/__internal/ui/check_box/check_box.tsx (defaultCheckBoxProps.defaultValue: false, used whenever value is untouched) that the real stored/resolved default is the concrete false, never undefined -> removed | undefined, kept | null (used for the indeterminate three-state case). Co-authored-by: Copilot <[email protected]>

@ts-expect-error

Fixed jsdoc-default-matches-type warnings for 12 event handler options in js/ui/list.d.ts: onGroupRendered, onItemClick, onItemContextMenu, onItemDeleted, onItemDeleting, onItemHold, onItemReordered, onItemSwipe, onPageLoading, onPullRefresh, onScroll, onSelectAllValueChanged. Verified runtime defaults are null in list.base.ts, list.edit.ts and collection_widget.base.ts/collection_widget.edit.ts (already fixed in a prior batch). Widened each type with `| null` and removed the now-stale @ts-expect-error suppressions in list.base.ts and list.edit.ts. Co-authored-by: Copilot <[email protected]>

Fixed jsdoc-default-matches-type warnings for 9 event handler options in js/ui/tree_view.d.ts: onItemClick, onItemCollapsed, onItemContextMenu, onItemExpanded, onItemHold, onItemRendered, onItemSelectionChanged, onSelectAllValueChanged, onSelectionChanged. Verified runtime defaults are null in tree_view.base.ts (onItemSelectionChanged, onItemExpanded, onItemCollapsed, onSelectAllValueChanged), collection_widget.base.ts (onItemClick, onItemContextMenu, onItemHold, onItemRendered — already widened in a prior batch), and collection_widget.edit.ts (onSelectionChanged). Widened each type with `| null`. Co-authored-by: Copilot <[email protected]>

@ts-expect-error

Fixed jsdoc-default-matches-type warnings for 4 event handler options in js/ui/menu.d.ts: onSubmenuHidden, onSubmenuHiding, onSubmenuShowing, onSubmenuShown. Verified runtime defaults are null in js/__internal/ui/menu/menu.ts _getDefaultOptions(). Widened each type with `| null` and removed the now-stale @ts-expect-error suppressions. Co-authored-by: Copilot <[email protected]>

Fixed jsdoc-default-matches-type warnings for 5 event handler options in js/ui/context_menu.d.ts: onHidden, onHiding, onPositioning, onShowing, onShown. Verified runtime defaults are null in js/__internal/ui/context_menu/context_menu.ts _getDefaultOptions(). Widened each type with `| null`. Co-authored-by: Copilot <[email protected]>

@ts-expect-error

Fixed jsdoc-default-matches-type warning for onItemTitleClick in js/ui/accordion.d.ts. Verified runtime default is null in js/__internal/ui/accordion.ts _getDefaultOptions(). Widened the type with `| null` and removed the now-stale @ts-expect-error suppression. Co-authored-by: Copilot <[email protected]>

@ts-expect-error

Fixed jsdoc-default-matches-type warnings for 3 event handler options in js/ui/tab_panel.d.ts: onTitleClick, onTitleHold, onTitleRendered. Verified runtime defaults are null in js/__internal/ui/tab_panel/tab_panel.ts _getDefaultOptions(). Widened each type with `| null` and removed the now-stale @ts-expect-error suppressions. Co-authored-by: Copilot <[email protected]>

Fixed jsdoc-default-matches-type warning for onClick in js/ui/button.d.ts. Verified runtime: js/__internal/ui/button/button.tsx's defaultButtonProps has no onClick entry, so the ComponentWrapper-merged _getDefaultOptions() never sets onClick, meaning .option('onClick') stays undefined until explicitly assigned (same "no explicit null in _getDefaultOptions -> undefined" case as the buttons field in ui.drop_down_editor.d.ts, per the convention doc). The previous `@default null` was inaccurate; corrected to `@default undefined` and widened the type with `| undefined`. Co-authored-by: Copilot <[email protected]>

@ts-expect-error

Fixed jsdoc-default-matches-type warnings for 2 event handler options in js/ui/button_group.d.ts: onItemClick, onSelectionChanged. Verified runtime defaults are null in js/__internal/ui/button_group.ts _getDefaultOptions(). Widened each type with `| null` and removed the now-stale @ts-expect-error suppressions. Co-authored-by: Copilot <[email protected]>

@ts-expect-error

Fixed jsdoc-default-matches-type warnings in js/ui/action_sheet.d.ts: - onCancelClick (widget-level option): verified runtime default is null in js/__internal/ui/action_sheet.ts _getDefaultOptions(); widened the type with `| null` and removed the now-stale @ts-expect-error suppression. - onClick (dxActionSheetItem property, Category B per the optional-fields typing convention): this is a per-item data field with no widget-level default (used only as a point-of-use fallback in the item template, not stored via _getDefaultOptions), so `.option()` never returns it. Removed the inaccurate `@default null` tag; the type is left unchanged. Co-authored-by: Copilot <[email protected]>

Fixed jsdoc-default-matches-type warning for onContentReady in js/ui/speed_dial_action.d.ts. Verified runtime default is null in js/__internal/ui/speed_dial_action/m_speed_dial_action.ts _getDefaultOptions(). Widening only the local override initially broke the WidgetProperties<any> constraint check in m_speed_dial_action.ts (`class SpeedDialAction extends Widget<Properties>`), because dxSpeedDialActionOptions.onContentReady overrides the base WidgetOptions.onContentReady (js/ui/widget/ui.widget.d.ts), which itself had the exact same pre-existing jsdoc-default-matches-type warning (`@default null` but no `| null` in the type) and a confirmed `null` runtime default in js/__internal/core/widget/widget.ts _getDefaultOptions(). Per user decision, widened the shared base WidgetOptions.onContentReady with `| null` as well, which is the root cause fix and keeps the override compatible. Co-authored-by: Copilot <[email protected]>

@ts-expect-error

Fixed jsdoc-default-matches-type warnings for 4 event handler options in js/ui/popup.d.ts: onResize, onResizeEnd, onResizeStart, onTitleRendered. Verified runtime defaults are null in js/__internal/ui/popup/popup.ts _getDefaultOptions(). Widened each type with `| null` and removed a now-stale @ts-expect-error in js/__internal/ui/lookup.ts (its popup options literal sets onTitleRendered: null directly). Co-authored-by: Copilot <[email protected]>

@ts-expect-error

Widens the types of maxSize and minSize options to number | null in js/ui/drawer.d.ts to match their verified runtime default value of null in js/__internal/ui/drawer/drawer.ts. Also removes now-stale @ts-expect-error suppressions in drawer.ts. Co-authored-by: Copilot <[email protected]>

@default

…undefined Corrects JSDoc @default from null to undefined and widens types to | undefined for onResize, onResizeEnd, onResizeStart, onItemExpanded, and onItemCollapsed in js/ui/splitter.d.ts to match their verified runtime default value of undefined in js/__internal/ui/splitter/splitter.ts. Co-authored-by: Copilot <[email protected]>

…itOperation

…nTaskInserting, onTaskInserted, onTaskDeleting, onTaskDeleted, onTaskUpdating, onTaskUpdated, onTaskMoving, onTaskEditDialogShowing, onResourceManagerDialogShowing, onDependencyInserting, onDependencyInserted, onDependencyDeleting, onDependencyDeleted, onResourceInserting, onResourceInserted, onResourceDeleting, onResourceDeleted, onResourceAssigning, onResourceAssigned, onResourceUnassigning, onResourceUnassigned, onTaskClick, onTaskDblClick

…ng, onItemHold, onItemReordered, onItemSwipe, onPageLoading, onPullRefresh, onScroll, onSelectAllValueChanged

Copilot

Copilot wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

pharret31 · 2026-07-14T17:22:32Z

@@ -550,7 +545,7 @@ export class ListBase extends CollectionWidget<ListBaseProperties, Item> {
    | null
    | undefined {
    const { grouped } = this.option();
-    const dataSource = this.option('dataSource');
+    const dataSource = this.option('dataSource') as DataSourceLike<Item> | undefined;


It's better to use
const { dataSource } = this.option();

pharret31 · 2026-07-14T17:23:03Z

      onTitleClick: null,
-      // @ts-expect-error ts-error
-      onTitleHold: null,
-      // @ts-expect-error ts-error
-      onTitleRendered: null,
+      onTitleHold: undefined,
+      onTitleRendered: undefined,


Inconsistency looks weird

dmlvr and others added 30 commits July 13, 2026 18:44

Fix jsdoc-default-matches-type in js/ui/editor/ui.data_expression.d.ts

ea86e73

Widen value to include | null, matching the null stored in DataExpressionMixin._dataExpressionDefaultOptions(). Co-authored-by: Copilot <[email protected]>

Fix jsdoc-default-matches-type in js/ui/select_box.d.ts

befe530

Verified against js/__internal/ui/select_box.ts _getDefaultOptions(): fieldTemplate stores null -> add | null. Co-authored-by: Copilot <[email protected]>

Fix jsdoc-default-matches-type in js/ui/drop_down_box.d.ts

3381c19

fieldTemplate is inherited from js/__internal/ui/drop_down_editor/drop_down_editor.ts _getDefaultOptions(), which stores null -> add | null. Co-authored-by: Copilot <[email protected]>

Fix jsdoc-default-matches-type in js/ui/text_box.d.ts

2751e37

Verified against js/__internal/ui/text_box/text_box.ts _getDefaultOptions(): maxLength stores null -> add | null. Co-authored-by: Copilot <[email protected]>

Fix jsdoc-default-matches-type in js/ui/number_box.d.ts

e9162cd

Verified against js/__internal/ui/number_box/m_number_box.base.ts _getDefaultOptions(): buttons stores void 0 -> add | undefined. Co-authored-by: Copilot <[email protected]>

dmlvr added 13 commits July 13, 2026 19:15

Component: onInitialized, onOptionChanged, onDisposing

80a71e1

DOMComponent: onOptionChanged, onDisposing

bf589dc

regenerate-all

199b8b0

ContextMenu: onHidden, onHiding, onPositioning, onShowing, onShown

85efa63

Diagram: onItemClick, onItemDblClick, onSelectionChanged, onRequestEd…

47fd15f

…itOperation

List: onGroupRendered, onItemContextMenu, onItemDeleted, onItemDeleti…

45ff0be

…ng, onItemHold, onItemReordered, onItemSwipe, onPageLoading, onPullRefresh, onScroll, onSelectAllValueChanged

Lookup: onPageLoading, onPullRefresh, onScroll, onValueChanged

9f83ddc

Map: onMarkerAdded

590f6de

ProgressBar: onComplete

1d0e222

RangeSlider: onValueChanged

2a74cf1

RespociveBox: screenByWidth

99a5b1d

ScrollView: onPullDown, onReachBottom

b15d845

dmlvr added the force all tests label Jul 13, 2026

dmlvr added 2 commits July 13, 2026 19:54

TagBox: onMultiTagPreparing

876e843

regenerate-all

600a35b

dmlvr closed this Jul 14, 2026

dmlvr reopened this Jul 14, 2026

dmlvr added 3 commits July 14, 2026 11:22

fix tests for default options

f898549

fix tests for default options

d4477f3

update one more test

05e7c8d

marker-dao changed the title ~~JSDoc @default / type mismatch — Components Aria~~ JSDoc @default / type mismatch — Components Area Jul 14, 2026

dmlvr marked this pull request as ready for review July 14, 2026 11:09

Copilot AI review requested due to automatic review settings July 14, 2026 11:09

dmlvr requested a review from a team as a code owner July 14, 2026 11:09

Copilot AI reviewed Jul 14, 2026

marker-dao approved these changes Jul 14, 2026

View reviewed changes

pharret31 approved these changes Jul 14, 2026

View reviewed changes

pharret31 reviewed Jul 14, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

JSDoc @default / type mismatch — Components Area#34287

JSDoc @default / type mismatch — Components Area#34287
dmlvr wants to merge 100 commits into
mainfrom
feature/jsdoc_default_mismath

dmlvr commented Jul 13, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

pharret31 Jul 14, 2026

Uh oh!

pharret31 Jul 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

dmlvr commented Jul 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

pharret31 Jul 14, 2026

Choose a reason for hiding this comment

Uh oh!

pharret31 Jul 14, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants