Add Missing documentation for Javascript Dropdown Widget #4928

vasilii-b · 2019-07-10T15:12:48Z

Purpose of this pull request

This pull request aims to enrich the documentation with missing information regarding Dropdown Widget - #4926.

Affected DevDocs pages

N/A. Not yet present on the DevDocs website.

Links to Magento source code

https://github.com/magento/magento2/blob/2.2-develop/lib/web/mage/dropdowns.js

whatsnew
Added information about the JavaScript dropdown widget.

…ropdown # Conflicts: # guides/v2.1/javascript-dev-guide/widgets/jquery-widgets-about.md

devops-devdocs · 2019-07-10T15:13:04Z

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

guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

rogyar · 2019-07-10T16:01:33Z

guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

+content for each of available options.
+
+{:.bs-callout .bs-callout-info} Dropdown widget is not meant to replace default
+HTML select element. By replacing default select in store forms don't expect


By replacing default select in store forms don't expect the store to work 100% the same as before changes.

Could you provide some clarification there or, maybe, remove this section. Because currently it sounds mysterious and scary at the same time :)

Thank you.

rogyar · 2019-07-10T16:03:19Z

guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

+### Styles
+
+By default the dropdown is not styled. But, there is a handy
+[LESS mixin `.lib-dropdown()`] that comes to the rescue:


that comes to the rescue

Please, rephrase this part slightly to have it in more document-style format. Thank you.

guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

rogyar · 2019-07-10T16:12:13Z

guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

+### `activeClass`   {#d_activeClass}
+
+The CSS class that reflects the current state of the dropdown widget.
+Given class is added to the element widget was initialized when the dropdown


Please simplify this sentence slightly to make it easier to read. I.e.

Given class is added to the widget element when the menu is visible

rogyar · 2019-07-10T16:17:11Z

Hi @vasilii-b. Thank you for the great topic. Please, consider applying the adjustments provided in the review.
Also, I would kindly ask you to move the newly introduced image into common/images/widget/ directory. In that way, we can reuse this image for different versions without additional overhead.

The example is here https://github.com/magento/devdocs/pull/4731/files

Co-Authored-By: Yaroslav Rogoza <enarc@atwix.com>

…-b/devdocs into addition/widget-dropdown * 'addition/widget-dropdown' of https://github.com/vasilii-b/devdocs: Update guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md Update guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md Update guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

vasilii-b · 2019-07-10T18:55:04Z

Hi @rogyar,
Thanks for checking this so quickly and helping improve it! I've added requested changes. Could you please check them as well?
Thank you!

guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

erikmarr · 2019-07-12T15:58:27Z

guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

+
+## Overview
+
+Widget source file is [lib/web/mage/dropdowns.js].


Suggested change

Widget source file is [lib/web/mage/dropdowns.js].

The dropdown widget source is located in [lib/web/mage/dropdowns.js].

Also, move this sentence to be after the next sentence (before the Usages section).

guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

erikmarr · 2019-07-15T21:39:56Z

guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

+### `btnArrow`   {#d_btnArrow}
+
+A jQuery selector for the arrow that expresses the state of the dropdown.
+The widget changes given element's text to '+' or '-", depending on the dropdown state.


delete this line as it was combined above.

erikmarr · 2019-07-15T21:40:01Z

guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

+
+A jQuery selector for the arrow that expresses the state of the dropdown.
+The widget changes given element's text to '+' or '-", depending on the dropdown state.
+It's not required the element to be present in the dropdown HTML markup. It works


delete this line as it was combined above.

erikmarr · 2019-07-15T21:40:06Z

guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

+A jQuery selector for the arrow that expresses the state of the dropdown.
+The widget changes given element's text to '+' or '-", depending on the dropdown state.
+It's not required the element to be present in the dropdown HTML markup. It works
+just fine without it as well.


delete this line as it was combined above.

guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

erikmarr · 2019-07-15T21:44:19Z

guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

+### `menu`   {#d_menu}
+
+A jQuery selector that represents the dropdown's menu element.
+Looking at the HTML markup, given element has to be inside the `parent` option.


delete this line as it was combined above.

Co-Authored-By: Erik Marr <45772211+erikmarr@users.noreply.github.com>

Co-Authored-By: Erik Marr <45772211+erikmarr@users.noreply.github.com> Co-Authored-By: Erik Marr <45772211+erikmarr@users.noreply.github.com> Co-Authored-By: Erik Marr <45772211+erikmarr@users.noreply.github.com> Co-Authored-By: Erik Marr <45772211+erikmarr@users.noreply.github.com> Co-Authored-By: Erik Marr <45772211+erikmarr@users.noreply.github.com> Co-Authored-By: Erik Marr <45772211+erikmarr@users.noreply.github.com> Co-Authored-By: Erik Marr <45772211+erikmarr@users.noreply.github.com> Co-Authored-By: Erik Marr <45772211+erikmarr@users.noreply.github.com> Co-Authored-By: Erik Marr <45772211+erikmarr@users.noreply.github.com>

vasilii-b · 2019-07-16T07:12:12Z

Hi @erikmarr,
Could you please review added requested changes? Thank you!

erikmarr · 2019-07-16T15:24:34Z

running tests

ghost · 2019-07-16T15:42:51Z

Hi @vasilii-b, 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.

erikmarr · 2019-07-16T15:42:59Z

Thanks @vasilii-b!

Vasilii Burlacu added 3 commits July 10, 2019 17:37

Add new docs page about Dropdown Widget

ce27fda

Merge remote-tracking branch 'upstream/master' into addition/widget-d…

243a92f

…ropdown # Conflicts: # guides/v2.1/javascript-dev-guide/widgets/jquery-widgets-about.md

Added adjustments according to latest DevDocs changes

75ca94d

magento-engcom-team added Partner: Atwix partners-contribution PR created by Magento partner labels Jul 10, 2019

vasilii-b changed the title ~~Addition/widget dropdown~~ Add Missing documentation for Javascript Dropdown Widget Jul 10, 2019

rogyar self-assigned this Jul 10, 2019

rogyar suggested changes Jul 10, 2019

View reviewed changes

rogyar added 2.2.x 2.3.x Magento 2.3 related changes New Topic A major update published as an entirely new document labels Jul 10, 2019

rogyar added the Waiting for Response Waiting for response from internal/external parties label Jul 10, 2019

Burlacu Vasilii and others added 5 commits July 10, 2019 21:40

Update guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

de00f12

Co-Authored-By: Yaroslav Rogoza <enarc@atwix.com>

Update guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

46133a1

Co-Authored-By: Yaroslav Rogoza <enarc@atwix.com>

Update guides/v2.2/javascript-dev-guide/widgets/widget_dropdown.md

e0d4d6b

Co-Authored-By: Yaroslav Rogoza <enarc@atwix.com>

Added text adjustments and moved result screenshot to appropriate path

6055341

erikmarr self-requested a review July 10, 2019 20:54

Minor refactoring

3aa13ff

rogyar approved these changes Jul 12, 2019

View reviewed changes

rogyar removed the Waiting for Response Waiting for response from internal/external parties label Jul 12, 2019

erikmarr suggested changes Jul 15, 2019

View reviewed changes

m2-community-project bot assigned erikmarr Jul 15, 2019

Burlacu Vasilii and others added 2 commits July 16, 2019 09:25

Refactor functional areas

ffe02d5

Co-Authored-By: Erik Marr <45772211+erikmarr@users.noreply.github.com>

vasilii-b force-pushed the addition/widget-dropdown branch from 675647d to c66d513 Compare July 16, 2019 07:10

erikmarr approved these changes Jul 16, 2019

View reviewed changes

Merge branch 'master' into addition/widget-dropdown

cfc0af0

erikmarr merged commit d62705f into magento:master Jul 16, 2019

vasilii-b deleted the addition/widget-dropdown branch July 16, 2019 16:32


		## Overview

		Widget source file is [lib/web/mage/dropdowns.js].

	Widget source file is [lib/web/mage/dropdowns.js].
	The dropdown widget source is located in [lib/web/mage/dropdowns.js].

Add Missing documentation for Javascript Dropdown Widget #4928

Add Missing documentation for Javascript Dropdown Widget #4928

Uh oh!

Conversation

vasilii-b commented Jul 10, 2019 • edited by erikmarr Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose of this pull request

Affected DevDocs pages

Links to Magento source code

Uh oh!

devops-devdocs commented Jul 10, 2019

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rogyar commented Jul 10, 2019

Uh oh!

vasilii-b commented Jul 10, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vasilii-b commented Jul 16, 2019

Uh oh!

erikmarr commented Jul 16, 2019

Uh oh!

ghost commented Jul 16, 2019

Uh oh!

erikmarr commented Jul 16, 2019

Uh oh!

Uh oh!

vasilii-b commented Jul 10, 2019 •

edited by erikmarr

Loading