Scheduler: Add snapToCellsMode API Desc.#8599
Scheduler: Add snapToCellsMode API Desc.#8599arman-boyakhchyan wants to merge 12 commits intoDevExpress:26_1from
Conversation
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for the snapToCellsMode API in dxScheduler and makes the corresponding enum/type visible (instead of hidden).
Changes:
- Moved
Enums.SnapToCellsModedoc from_hiddeninto the public dxScheduler “Types” section and added value descriptions. - Added detailed descriptions (including per-view defaults) to
dxScheduler.Options.snapToCellsModeanddxScheduler.Options.views.snapToCellsMode.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| api-reference/_hidden/Enums/SnapToCellsMode.md | Removes the hidden placeholder enum doc. |
| api-reference/10 UI Components/dxScheduler/9 Types/SnapToCellsMode.md | Adds public enum/type doc with value semantics. |
| api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md | Documents view-specific snapToCellsMode behavior and defaults. |
| api-reference/10 UI Components/dxScheduler/1 Configuration/snapToCellsMode.md | Documents global snapToCellsMode behavior and defaults. |
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/snapToCellsMode.md
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/snapToCellsMode.md
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/9 Types/SnapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/9 Types/SnapToCellsMode.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Vladimir Abadzhev <vladimira@devexpress.com>
| Specifies how the Scheduler component snaps appointments to grid (applies to all view types). | ||
|
|
||
| --- | ||
| <!-- Description goes here --> No newline at end of file | ||
| If a Scheduler is bound to a [dataSource](/Documentation/ApiReference/UI_Components/dxScheduler/Configuration/#dataSource), it can snap appointments to grid. If this functionality is active, the Scheduler increases appointment dimensions (never shrinks appointments). | ||
|
|
There was a problem hiding this comment.
The phrasing is grammatically incomplete in a few places (for example, “snaps appointments to grid” should be “to the grid”/“to grid cells”), and the first paragraph starts with an introductory dependent clause (“If a Scheduler is bound…, …”). Consider rewriting these sentences to use direct active voice and consistent articles (for example, start with “Bind the Scheduler to a dataSource to enable…”).
| Specifies how a Scheduler View snaps appointments to grid. | ||
|
|
||
| --- | ||
| <!-- Description goes here --> No newline at end of file | ||
| If a Scheduler is bound to a [dataSource](/Documentation/ApiReference/UI_Components/dxScheduler/Configuration/#dataSource), you can snap appointments to grid. If this functionality is active, the Scheduler increases appointment dimensions (never shrinks appointments). | ||
|
|
There was a problem hiding this comment.
Similar to the component-level option, a few sentences are missing articles (“to grid” → “to the grid”/“to grid cells”) and start with an introductory dependent clause (“If a Scheduler is bound…, …”). Consider rewriting for direct active voice (for example, “Bind the Scheduler to a dataSource to enable…”).
| Specifies how Scheduler snaps appointments to grid. | ||
|
|
||
| --- | ||
| The following **snapToCellsMode** values are available: | ||
|
|
||
| - *"always"*: Scheduler snaps all appointments to grid. | ||
| - *"auto"*: Appointments that cover more than half of a cell are stretched to occupy the entire cell. | ||
| - *"never"*: Scheduler does not snap appointments to grid. No newline at end of file |
There was a problem hiding this comment.
The enum’s short description and value descriptions are inconsistent with the corresponding option docs (for example, "always" is described as "Appointments occupy cells fully" here, but the option pages describe snapping behavior; "never" mentions dimension changes instead of snapping). To avoid confusing readers, align the enum’s wording with the option descriptions and use consistent phrasing (for example, “the Scheduler … the grid”).
| Specifies how Scheduler snaps appointments to grid. | |
| --- | |
| The following **snapToCellsMode** values are available: | |
| - *"always"*: Scheduler snaps all appointments to grid. | |
| - *"auto"*: Appointments that cover more than half of a cell are stretched to occupy the entire cell. | |
| - *"never"*: Scheduler does not snap appointments to grid. | |
| Specifies how the Scheduler snaps appointments to the grid. | |
| --- | |
| The following **snapToCellsMode** values are available: | |
| - *"always"*: The Scheduler always snaps appointments to the grid. | |
| - *"auto"*: The Scheduler snaps an appointment to the grid if it occupies more than half of a cell. | |
| - *"never"*: The Scheduler never snaps appointments to the grid. |
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md
Outdated
Show resolved
Hide resolved
Co-authored-by: dirkpieterse <dirk.pieterse@devexpress.com>
| --- | ||
| ##### shortDescription | ||
| <!-- Description goes here --> | ||
| Specifies how the Scheduler component snaps appointments to the grid (applies to all view types). |
There was a problem hiding this comment.
In this short description, "snaps appointments to grid" is missing the article "the". For consistency with the view-level documentation in this PR, consider using "to the grid".
|
|
||
| --- | ||
| <!-- Description goes here --> No newline at end of file | ||
| The Scheduler can snap appointments to the grid. When this feature is enabled, the component increases appointment dimensions and never reduces them. |
There was a problem hiding this comment.
This sentence is missing the definite article at the beginning. Consider changing "Scheduler can snap..." to "The Scheduler can snap..." to match the style used elsewhere in the Scheduler docs and in the view-level description added in this PR.
| - *"always"*: Scheduler snaps all appointments to the grid. | ||
| - *"auto"*: Appointments that cover more than half of a cell are stretched to occupy the entire cell. | ||
| - *"never"*: Scheduler does not snap appointments to the grid. |
There was a problem hiding this comment.
These bullet descriptions omit the article in "to grid". For readability and consistency with the view-level snapToCellsMode doc, use "to the grid" in each bullet.
| The following **snapToCellsMode** values are available: | ||
|
|
||
| - *"always"*: Scheduler snaps all appointments to the grid. | ||
| - *"auto"*: Appointments that cover more than half of a cell are stretched to occupy the entire cell. |
There was a problem hiding this comment.
These bullet descriptions omit the article in "to grid". For readability and consistency with the configuration-level docs in this PR, use "to the grid" in each bullet.
| - *"auto"*: Appointments that cover more than half of a cell are stretched to occupy the entire cell. | |
| - *"auto"*: Appointments that cover more than half of a cell are snapped to the grid and stretched to occupy the entire cell. |
| --- | ||
| ##### shortDescription | ||
| <!-- Description goes here --> | ||
| Specifies how the Scheduler component snaps appointments to the grid (applies to all view types). |
There was a problem hiding this comment.
The shortDescription says this setting "applies to all view types", but the note below states that the "agenda" view ignores this property. Please adjust the shortDescription to exclude agenda (or rephrase to avoid implying it applies to every view type).
| Specifies how the Scheduler component snaps appointments to the grid (applies to all view types). | |
| Specifies how the Scheduler component snaps appointments to the grid. |
| The default **snapToCellsMode** value varies by view: | ||
|
|
||
| <table class="dx-table"> | ||
| <tr> | ||
| <th>Value</th> | ||
| <th>Scheduler Views</th> | ||
| </tr> | ||
| <tr> | ||
| <td><i>"never"</i></td> | ||
| <td><i>"day"</i>, <i>"week"</i>, <i>"workWeek"</i>, <i>"timelineDay"</i>, <i>"timelineWeek"</i>, <i>"timelineWorkWeek"</i></td> | ||
| </tr> | ||
| <tr> | ||
| <td><i>"always"</i></td> | ||
| <td><i>"month"</i>, <i>"timelineMonth"</i></td> | ||
| </tr> |
There was a problem hiding this comment.
This section says the default snapToCellsMode value varies by view, but the table does not mention the "agenda" view (which is called out later as ignoring the property). Consider clarifying that the table applies only to views where snapToCellsMode is respected, or add an explicit agenda entry (for example, "ignored").
|
|
||
| --- | ||
| <!-- Description goes here --> No newline at end of file | ||
| The Scheduler can snap appointments to the grid. When this feature is enabled, the component increases appointment dimensions and never reduces them. |
There was a problem hiding this comment.
"When this feature is enabled" is ambiguous because snapToCellsMode itself controls whether snapping is enabled. Consider explicitly stating which values enable snapping (for example, that snapping is disabled when the value is "never").
| The Scheduler can snap appointments to the grid. When this feature is enabled, the component increases appointment dimensions and never reduces them. | |
| The Scheduler can snap appointments to the grid. When **snapToCellsMode** is set to *"always"* or *"auto"*, the component increases appointment dimensions and never reduces them. |
No description provided.