Skip to content

Scheduler/PivotGrid: align @default tags with option types in public d.ts#34374

Open
aleksei-semikozov wants to merge 1 commit into
mainfrom
feature/26_2_pivotgrid-scheduler-jsdoc-defaults
Open

Scheduler/PivotGrid: align @default tags with option types in public d.ts#34374
aleksei-semikozov wants to merge 1 commit into
mainfrom
feature/26_2_pivotgrid-scheduler-jsdoc-defaults

Conversation

@aleksei-semikozov

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates DevExtreme’s public TypeScript declarations for Scheduler and PivotGrid to better align @default tags with the declared option types, and propagates those changes into the aggregated dx.all.d.ts bundle and framework wrappers.

Changes:

  • Align multiple Scheduler template/event options to @default undefined and update their types to explicitly include | undefined.
  • Update PivotGrid / PivotGridFieldChooser option typings and defaults (including runtime _getDefaultOptions) to use undefined instead of null for several existing options.
  • Remove redundant @default undefined tags from many PivotGridDataSourceField (config-item) properties, and adjust a PivotGrid FieldChooser test expectation accordingly.

Reviewed changes

Copilot reviewed 10 out of 15 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
packages/devextreme/ts/dx.all.d.ts Updates the bundled declaration output to reflect new `
packages/devextreme/testing/tests/DevExpress.ui.widgets.pivotGrid/fieldChooser.tests.js Adjusts a QUnit assertion to expect undefined instead of null for the default state option.
packages/devextreme/js/ui/scheduler.d.ts Changes Scheduler option @default tags (notably templates/events) to undefined and updates types accordingly.
packages/devextreme/js/ui/pivot_grid/data_source.d.ts Aligns fields option typing with @default undefined; removes redundant @default undefined tags from many field config properties.
packages/devextreme/js/ui/pivot_grid.d.ts Updates PivotGrid event option defaults/types and stateStoring.storageKey to undefined semantics.
packages/devextreme/js/ui/pivot_grid_field_chooser.d.ts Updates FieldChooser onContextMenuPreparing and state defaults/types to undefined semantics.
packages/devextreme/js/__internal/grids/pivot_grid/m_widget.ts Changes PivotGrid runtime defaults for several options from null to undefined.
packages/devextreme/js/__internal/grids/pivot_grid/field_chooser/m_field_chooser.ts Changes FieldChooser runtime default for onContextMenuPreparing from null to undefined.
packages/devextreme/js/__internal/grids/pivot_grid/field_chooser/m_field_chooser_base.ts Changes FieldChooserBase runtime default for state from null to undefined.
packages/devextreme-react/src/scheduler.ts Updates narrowed React wrapper event typings to match the updated `
packages/devextreme-react/src/pivot-grid.ts Updates narrowed React wrapper event typings and storageKey typing to match updated declarations.
packages/devextreme-react/src/pivot-grid-field-chooser.ts Updates narrowed React wrapper event typing to include `
packages/devextreme-angular/src/ui/pivot-grid/nested/state-storing.ts Updates Angular wrapper nested option storageKey typing to `string
packages/devextreme-angular/src/ui/pivot-grid/index.ts Updates Angular wrapper stateStoring typing to allow `storageKey?: string
packages/devextreme-angular/src/ui/pivot-grid-field-chooser/index.ts Updates Angular wrapper state typing to `any

Comment thread packages/devextreme/js/__internal/grids/pivot_grid/m_widget.ts
Comment thread packages/devextreme/js/__internal/grids/pivot_grid/m_widget.ts
Comment thread packages/devextreme/js/__internal/grids/pivot_grid/m_widget.ts
Comment thread packages/devextreme/js/__internal/grids/pivot_grid/m_widget.ts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants