Skip to content

Commit

Permalink
questions raised
Browse files Browse the repository at this point in the history
  • Loading branch information
marchenk-adobe committed Jan 12, 2017
1 parent b275c07 commit 03e616c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
16 changes: 10 additions & 6 deletions guides/v2.1/ui_comp_guide/bk-ui_comps.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,18 @@ This document started as a [week-long doc sprint in Kyiv](http://bhmarks.com/blo
In the meantime, until we have completed this new book, you can also still [access the former (v2.0) UI Components docs](http://devdocs.magento.com/guides/v2.0/ui-components/ui-component.html).

## Overview of UI components
Magento UI components are designed for simple and flexible user interface (UI) rendering. They allow you to configure the page manipulating the UI components.
Magento UI components are used to represent distinct UI elements, such as tables, buttons, dialogs, and others. They are designed for simple and flexible user interface (UI) rendering.

Magento UI components are implemented as a standard module and can be found under `Magento\UI` namespace.

<p class="q">Is it a correct notation, about namespace?</p>

Components are responsible for rendering result page fragments and providing/supporting further interactions of JavaScript components and server.

To use UI components in your custom module, you need to add a dependency for the Magento_UI module in [your component's composer.json file]({{page.baseurl}}extension-dev-guide/build/composer-integration.html).

<p class="q">Do we really need to say this here? cause it's only one of the steps required to use UI components</p>

### General structure
In Magento 2 there are basic and secondary UI components.

Expand Down Expand Up @@ -60,18 +64,18 @@ UI components configuration reader searches through all active modules and read

`<module root dir>/view/<area>/ui_component/etc/definition.xml`


And concrete instances of the components each in separate XML configuration file:


`<module root dir>/view/<area>/ui_component/<component_instance_name>.xml`

### Configuration
### Customization

Extension developers cannot introduce new components but can customize existing ones.
Extension developers cannot introduce new components, but can customize existing ones.

XSD file contains rules and limitations shared between all components (both definitions and instance configurations):
The following XSD file contains rules and limitations shared between all components (both definitions and instance configurations):

`<your module root dir>/Magento/Ui/etc/ui_definition.xsd`

It is possible to create custom component by setting `class`, `component` and `template` parameters of the Container UI component.

<p class="q">in the first sentence of this paragraph we say that extension devs cannot create custom components</p>
8 changes: 5 additions & 3 deletions guides/v2.1/ui_comp_guide/ui_component_explained.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ github_link: ui_comp_guide/ui_component_explained.md

Magento UI components are used to represent distinct UI elements, such as tables, buttons, dialogs, and others.

UI Component is a combination of:
UI component is a combination of:

1. **XML declaration** that specifies the component's configuration settings and inner structure;
1. **XML declaration** that specifies the component's configuration settings and inner structure.

2. **JavaScript** class inherited from one of the Magento JavaScript Framework UI Components base classes (such as [UIElement]({{page.baseurl}}ui_comp_guide/concepts/ui_comp_uielement_concept.html), [UIClass]({{page.baseurl}}ui_comp_guide/concepts/ui_comp_uiclass_concept.html) or [UICollection]({{page.baseurl}}ui_comp_guide/concepts/ui_comp_uicollection_concept.html))
2. **JavaScript** class inherited from one of the Magento JavaScript framework UI components base classes (such as [UIElement]({{page.baseurl}}ui_comp_guide/concepts/ui_comp_uielement_concept.html), [UIClass]({{page.baseurl}}ui_comp_guide/concepts/ui_comp_uiclass_concept.html) or [UICollection]({{page.baseurl}}ui_comp_guide/concepts/ui_comp_uicollection_concept.html)).

<p class="q">what are JavaScript framework UI components base classes? Guess we need to give a strict definition</p>

3. **Related template(s)**

Expand Down

0 comments on commit 03e616c

Please sign in to comment.