Skip to content

Overhaul Shared Code Snippets#8972

Merged
arman-boyakhchyan merged 10 commits into
DevExpress:26_1from
arman-boyakhchyan:includes-code-snippets-overhaul-26-1
Jul 15, 2026
Merged

Overhaul Shared Code Snippets#8972
arman-boyakhchyan merged 10 commits into
DevExpress:26_1from
arman-boyakhchyan:includes-code-snippets-overhaul-26-1

Conversation

@arman-boyakhchyan

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI left a comment

Copy link
Copy Markdown

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 shared DevExtreme documentation snippets to a more modern baseline (Vue 3 script setup + TypeScript, React function components/TSX, cleaner tab headers), and inlines some previously included notes into the API reference topic.

Changes:

  • Modernizes framework samples (Vue Composition API + TS, React function components + TSX) and normalizes tab headers.
  • Cleans up/condenses several snippets (imports, placeholders, HTTPS URLs, and minor formatting).
  • Removes grids-customize-columns-react-note include and replaces it with inline notes in the customizeColumns API topic.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
includes/uiwidgets-ref-validation-message.md Refactors validation message examples (Vue script setup, React TSX function components).
includes/tutorials-editors-add-label.md Updates label tutorial wording and converts Vue/React snippets to TS-oriented patterns.
includes/grids-customize-columns-react-note.md Removes the React-specific note include (content moved inline elsewhere).
includes/dataviz-ref-gauges-indicator-types-snippet.md Retitles Angular snippet tabs and converts React sample to TSX function component.
includes/dataviz-legend-customizeitems-example.md Updates tab headers and modernizes Vue/React samples.
includes/dataviz-code-customsource.md Standardizes tab headers, moves Angular parts into explicit tabs, and updates URLs/ES syntax.
includes/datalayer-ref-query-summarymethods-desc.md Migrates Vue/React examples to Composition API / hooks and updates tab headers.
includes/custom-templates.md Updates Vue and React samples to script setup / function component patterns and minor formatting.
includes/common-dataSource-description.md Simplifies and modernizes jQuery/Vue/React snippets and tab headers.
includes/common-code-register-key-handler.md Modernizes jQuery/Vue/React examples and tightens Angular typing.
includes/common-code-on-initialized.md Adds a Vue Composition API example and updates Angular/React typings around onInitialized.
includes/common-code-customsource-rawmode-withkey.md Updates tab headers and modernizes Angular/Vue/React samples, switches URLs to HTTPS.
includes/common-code-customsource-rawmode-pagingdisabled.md Updates tab headers and modernizes Angular/Vue/React samples, switches URLs to HTTPS.
api-reference/10 UI Components/dxDataGrid/1 Configuration/customizeColumns.md Inlines and expands per-framework notes about customizeColumns limitations and modernizes samples.

Comment thread includes/common-code-on-initialized.md Outdated
Comment thread includes/common-code-on-initialized.md Outdated
Comment thread includes/common-code-register-key-handler.md
Comment thread includes/dataviz-ref-gauges-indicator-types-snippet.md Outdated
Comment thread includes/tutorials-editors-add-label.md Outdated
Comment thread api-reference/10 UI Components/dxDataGrid/1 Configuration/customizeColumns.md Outdated
Comment thread api-reference/10 UI Components/dxDataGrid/1 Configuration/customizeColumns.md Outdated
Comment thread includes/common-code-customsource-rawmode-pagingdisabled.md Outdated
Comment thread includes/common-code-customsource-rawmode-pagingdisabled.md Outdated
Comment thread includes/common-code-customsource-rawmode-pagingdisabled.md Outdated
Comment thread includes/common-code-customsource-rawmode-pagingdisabled.md Outdated
Comment thread includes/common-code-customsource-rawmode-pagingdisabled.md Outdated
Comment thread includes/common-code-customsource-rawmode-pagingdisabled.md Outdated
Comment thread includes/common-code-customsource-rawmode-withkey.md
Comment thread includes/common-code-register-key-handler.md Outdated
Comment thread includes/common-dataSource-description.md Outdated
Comment thread includes/common-dataSource-description.md Outdated
Comment thread includes/common-dataSource-description.md Outdated
Comment thread includes/common-dataSource-description.md Outdated
arman-boyakhchyan and others added 2 commits July 13, 2026 14:37
Co-authored-by: Mark Allen Ramirez <allen.ramirez@devsoft.ph>
Comment thread includes/common-code-on-initialized.md
Comment thread includes/common-code-on-initialized.md
Comment thread includes/common-code-on-initialized.md
Comment thread includes/common-code-on-initialized.md
Comment thread includes/common-code-register-key-handler.md Outdated
Comment thread includes/common-code-register-key-handler.md Outdated
Comment thread includes/common-code-register-key-handler.md Outdated
arman-boyakhchyan and others added 4 commits July 14, 2026 16:45
Co-authored-by: Mark Allen Ramirez <21377435+markallenramirez@users.noreply.github.com>
Co-authored-by: Mark Allen Ramirez <21377435+markallenramirez@users.noreply.github.com>
Co-authored-by: Mark Allen Ramirez <21377435+markallenramirez@users.noreply.github.com>
---
##### jQuery

[note] Columns created using **customizeColumns** do not support data shaping operations such as sorting, filtering, and summaries.

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.

Since all these have the same limitation, can we write it as:

Suggested change
[note] Columns created using **customizeColumns** do not support data shaping operations such as sorting, filtering, and summaries.
[note]
- In all frameworks, columns created using **customizeColumns** do not support data shaping operations such as sorting, filtering, and summaries.
- In React, you also cannot configure templates in **customizeColumns**, including render functions and components such as [cellRender](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#cellRender) and [cellComponent](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#cellComponent)).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

We avoid displaying framework-specific information where the info is not relevant. I will apply your suggestion to the React-only note.

Comment thread includes/uiwidgets-ref-validation-message.md Outdated
Comment thread includes/uiwidgets-ref-validation-message.md Outdated
arman-boyakhchyan and others added 2 commits July 15, 2026 19:51
Co-authored-by: dirkpieterse <dirk.pieterse@devexpress.com>
@arman-boyakhchyan
arman-boyakhchyan merged commit 6f42ff9 into DevExpress:26_1 Jul 15, 2026
6 checks passed
@arman-boyakhchyan
arman-boyakhchyan deleted the includes-code-snippets-overhaul-26-1 branch July 15, 2026 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants