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

Added the documentation for Sortable widget #5358

Merged

Conversation

serhiyzhovnir
Copy link
Contributor

@serhiyzhovnir serhiyzhovnir commented Sep 11, 2019

Purpose of this pull request

This pull request (PR) adds the documentation for the Sortable widget.

Affected DevDocs pages

This documentation will have the following links:

Page look

screencapture-127-0-0-1-4000-guides-v2-3-javascript-dev-guide-widgets-widget-sortable-html-2019-09-11-13_38_54

Links to Magento source code

whatsnew
Added the Sortable Widget topic to the JavaScript Developer Guide.

@devops-devdocs
Copy link
Collaborator

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

@rogyar rogyar self-assigned this Sep 11, 2019
@rogyar rogyar added New Topic A major update published as an entirely new document Technical Updates to the code or processes that alter the technical content of the doc 2.2.x 2.3.x Magento 2.3 related changes labels Sep 11, 2019
@hguthrie hguthrie removed the Technical Updates to the code or processes that alter the technical content of the doc label Sep 12, 2019
contributor_link: https://www.atwix.com/
---

The Sortable [widget](https://glossary.magento.com/widget/) is a customized jQuery [Sortable Widget] that allows sorting sortable items with *Up* and *Down* buttons.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The Sortable [widget](https://glossary.magento.com/widget/) is a customized jQuery [Sortable Widget] that allows sorting sortable items with *Up* and *Down* buttons.
The Sortable [widget](https://glossary.magento.com/widget/) is a customized jQuery [Sortable Widget][] that allows you to reorder sortable items using *Up* and *Down* buttons.


The Sortable [widget](https://glossary.magento.com/widget/) is a customized jQuery [Sortable Widget] that allows sorting sortable items with *Up* and *Down* buttons.

The Sortable widget can be used only on the [adminhtml](https://glossary.magento.com/adminhtml) area.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The Sortable widget can be used only on the [adminhtml](https://glossary.magento.com/adminhtml) area.
The Sortable widget is only available in the [adminhtml](https://glossary.magento.com/adminhtml) area.


Where:

- `#sortable` is the selector of the block element for which Sortable is initialized.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- `#sortable` is the selector of the block element for which Sortable is initialized.
- `#sortable` is the selector of the block element where Sortable is initialized.


For information about how to initialize a widget in a JS component or `.phtml` template, see the [Initialize JavaScript][] topic.

The following example shows how to instantiate the Sortable widget:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The following example shows how to instantiate the Sortable widget:
Use the `sortable()` function to instantiate the Sortable widget:

@serhiyzhovnir
Copy link
Contributor Author

Hi @jcalcaben
The requested changes were added.
Can you, please, review the PR again?
Thank you!

Copy link
Contributor

@jcalcaben jcalcaben left a comment

Choose a reason for hiding this comment

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

Looks like there are conflicts in your PR. These need to be fixed before I can merge.

# Conflicts:
#	_data/toc/javascript-developer-guide.yml
#	guides/v2.2/javascript-dev-guide/widgets/jquery-widgets-about.md
@serhiyzhovnir
Copy link
Contributor Author

Hey @jcalcaben
The conflict is resolved.
Thank you!

@jcalcaben
Copy link
Contributor

running tests

@jcalcaben jcalcaben merged commit aab6298 into magento:master Sep 18, 2019
@serhiyzhovnir serhiyzhovnir deleted the add-sortable-widget-documentation branch September 18, 2019 16:29
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
2.2.x 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 Progress: review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants