Browse Source

Docs: Added 'Using the existing components' chapter in the framework architecture introduction guide.

Aleksander Nowodzinski 8 years ago
parent
commit
7bcb4ea8f3

BIN
docs/assets/img/framework-architecture-toolbar.png


+ 53 - 0
docs/framework/guides/architecture/intro.md

@@ -592,4 +592,57 @@ EditorUIView
 
 ### Using the existing components
 
+The framework provides a number of common {@link module:ui components} like {@link module:ui/button/buttonview~ButtonView `ButtonView`} or {@link module:ui/toolbar/toolbarview~ToolbarView `ToolbarView`} that can be helpful when developing a new user interface.
+
+For example, to create a toolbar with a few buttons inside, `ToolbarView` and `ButtonView` classes need to be imported first:
+
+```js
+import ToolbarView from '@ckeditor/ckeditor5-ui/src/toolbar/toolbarview';
+import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
+```
+
+Let's create the toolbar and a couple of buttons with labels first. Then append the buttons to the toolbar:
+
+```js
+const toolbar = new ToolbarView();
+const buttonFoo = new ButtonView();
+const buttonBar = new ButtonView();
+
+buttonFoo.set( {
+	label: 'Foo',
+	withText: true
+} );
+
+buttonBar.set( {
+	label: 'Bar',
+	withText: true
+} );
+
+toolbar.items.add( buttonFoo );
+toolbar.items.add( buttonBar );
+```
+
+The toolbar can now join the [UI tree](##View-collections-and-the-UI-tree) or it can be injected straight into DOM. To keep the example simple, let's proceed the the later scenario:
+
+```js
+toolbar.init();
+
+document.body.appendChild( toolbar.element );
+```
+
+The result should look like this:
+
+{@img assets/img/framework-architecture-toolbar.png 442 A simple toolbar created using existing components.}
+
+The toolbar renders correctly but it doesn't do much. To execute an action when the button is clicked, a listener must be defined. To shorten the code and instead of two listener define just one, the buttons can {@link module:utils/emittermixin~EmitterMixin#delegate delegate} the {@link module:ui/button/buttonview~ButtonView#execute `execute`} event to their parent:
+
+```js
+buttonFoo.delegate( 'execute' ).to( toolbar );
+buttonBar.delegate( 'execute' ).to( toolbar );
+
+toolbar.on( 'execute', evt => {
+	console.log( `The "${ evt.source.label }" button has been clicked!` );
+} );
+```
+
 ### Keystrokes and focus management