Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Add the documentation for the ColumnsResize UI component #6838

Merged
merged 4 commits into from
Mar 12, 2020
Merged

Add the documentation for the ColumnsResize UI component #6838

merged 4 commits into from
Mar 12, 2020

Conversation

serhiyzhovnir
Copy link
Contributor

Purpose of this pull request

This pull request (PR) adds the documentation for the ColumnsResize UI component.

The following sections were added for this component:

  • Configuration options - this section describes the options of the ColumnsResize UI component and their properties.
  • Sources files - this section provides information about files that is related to the ColumnsResize UI component.
  • Examples - this section provides examples of how to use this component.

Affected DevDocs pages

The new page will be created with the URL:

Links to Magento source code

whatsnew
Added topic for ColumnsResize UI

@devops-devdocs
Copy link
Collaborator

An admin must run tests on this PR before it can be merged.

@rogyar rogyar self-assigned this Mar 11, 2020
rogyar
rogyar suggested changes Mar 11, 2020
View reviewed changes
src/guides/v2.3/ui_comp_guide/components/ui-columns-resize.md Outdated
| `component` | The path to the component's `.js` file, relative to RequireJS. | String | `Magento_Ui/js/grid/resize` |
| `rootSelector` | The CSS selector of a table parent element. | String | `${ $.columnsProvider }:.admin__data-grid-wrap` |
| `tableSelector` | The CSS selector of a table element. | String | `${ $.rootSelector } -> table.data-grid` |
| `mainTableSelector` | The CSS selector of a main table element. | String | `[data-role="grid"]` |
Copy link
Contributor

Choose a reason for hiding this comment

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

Currently, it's a little bit hard to figure out a difference between the table and the main table. If we could clarify the table/main table definition it would be awesome.

Thank you

@rogyar rogyar added the New Topic A major update published as an entirely new document label Mar 11, 2020
@dobooth dobooth added the 2.3.x Magento 2.3 related changes label Mar 11, 2020
@serhiyzhovnir
Copy link
Contributor Author

serhiyzhovnir commented Mar 12, 2020 •
edited
Loading

Hi @rogyar
Thank you for the question.
I've added the additional information to the tableSelector and mainTableSelector options.
Additional code reference: https://github.com/magento/magento2/blob/2.3/app/code/Magento/Ui/view/base/web/js/grid/resize.js#L92-L96
May I kindly ask you to check this PR again and let me know if something is unclear.

@serhiyzhovnir serhiyzhovnir requested a review from rogyar March 12, 2020 10:34
@rogyar
Copy link
Contributor

rogyar commented Mar 12, 2020

Awesome, thank you!

@dobooth
Copy link
Contributor

dobooth commented Mar 12, 2020

running tests

@dobooth
Copy link
Contributor

dobooth commented Mar 12, 2020

running tests

@dobooth dobooth merged commit f8e5cd5 into magento:master Mar 12, 2020
@ghost
Copy link

ghost commented Mar 12, 2020

Hi @serhiyzhovnir, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@sidolov sidolov added New Topic A major update published as an entirely new document and removed New Topic A major update published as an entirely new document labels Mar 23, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@rogyar rogyar rogyar approved these changes

@dobooth dobooth dobooth approved these changes

Assignees

@rogyar rogyar

@dobooth dobooth

Labels
2.3.x Magento 2.3 related changes New Topic A major update published as an entirely new document Partner: Atwix partners-contribution PR created by Magento partner
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@serhiyzhovnir @devops-devdocs @rogyar @dobooth @sidolov @magento-engcom-team