Skip to content

Commit 0590fed

Browse files
committed
MAGEDOC-3441: Edit Knockout bindings topic
- Resolve knockout binding feedback
1 parent e5e8be1 commit 0590fed

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/reference/knockout-bindings.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## Summary
44

5-
As part of the Page Builder application, we provide a number of new Knockout bindings to add additional functionality to certain content types through Knockouts binding syntax.
5+
As part of the Page Builder application, we provide a number of several new Knockout bindings to add more functionality to certain content types through Knockouts binding syntax.
66

77
| Binding Name | Description |
88
| -------------- | -------------------------------------------------------------- |
99
| `sortable` | Enables sorting the children of a bound element. We use this within container content types such as the root container, row and columns to enable drag and drop capabilities on their children content types. This can be used for easy access to the jQuery UI sortable functionality within your module. |
1010
| `draggable` | Enables draggable functionality on DOM elements. We use this to enable the content types in the left menu to be dragged and dropped into containers on the stage. |
11-
| `liveEdit` | Enables basic live text editing on the stage, this also supports displaying additional items within the live edit UI for easier modification. You can read more about how to use live edit within our [How to add a custom Toolbar](../how-to/how-to-add-custom-toolbar.md) guide. |
12-
| `hasFocusNoScroll` | Enables an element to use Knockout `hasFocus` binding without it causing the browser to scroll to the element, we use this within Slider to ensure the correct slide is focused but we do not want to scroll this into view always. |
11+
| `liveEdit` | Enables basic live text editing on the stage. This also supports displaying additional items within the live edit UI for easier modification. You can read more about how to use live edit within our [How to add a custom Toolbar](../how-to/how-to-add-custom-toolbar.md) guide. |
12+
| `hasFocusNoScroll` | Enables an element to use Knockout `hasFocus` binding without it causing the browser to scroll to the element. We use this within Slider to ensure the correct slide is focused but we do not want to scroll this into view always. |
1313
{:style="table-layout:auto"}
1414

1515
### `sortable` binding
@@ -24,14 +24,14 @@ Within Page Builder, we use the `sortable` binding to pass preview-component opt
2424

2525
**Configuration:**
2626

27-
Please see the options listed on jQuery UI's Sortable API page: http://api.jqueryui.com/sortable/
27+
See the options listed on jQuery UI's Sortable API page: http://api.jqueryui.com/sortable/
2828

2929
**Usage:**
3030

3131
```html
3232
<div data-bind="sortable: getSortableOptions()" />
3333
```
34-
_As jQuery UI can have callback functions we recommend providing this configuration from a function within your Knockout view model._
34+
_Because jQuery UI can have callback functions, we recommend providing this configuration from a function within your Knockout view model._
3535

3636
### `draggable` binding
3737

@@ -45,18 +45,18 @@ Within Page Builder, we use this binding for the left panel's content types. The
4545

4646
**Configuration:**
4747

48-
Please see the options listed on jQuery UI's Sortable API page: http://api.jqueryui.com/draggable/
48+
See the options listed on jQuery UI's Sortable API page: http://api.jqueryui.com/draggable/
4949

5050
**Usage:**
5151

5252
```html
5353
<div data-bind="draggable: getDraggableOptions()" />
5454
```
55-
_As jQuery UI can have callback functions we recommend providing this configuration from a function within your Knockout view model._
55+
_Because jQuery UI can have callback functions, we recommend providing this configuration from a function within your Knockout view model._
5656

5757
### `liveEdit` binding
5858

59-
This binding provides basic text live editing functionality to the current element, it does this by adding the `contenteditable` functionality to the bound element.
59+
This binding provides basic text live editing functionality to the current element. It does this by adding the `contenteditable` functionality to the bound element.
6060

6161
**Configuration:**
6262

@@ -74,7 +74,7 @@ This binding provides basic text live editing functionality to the current eleme
7474

7575
### `hasFocusNoScroll` binding
7676

77-
This binding enables the functionality of Knockout's [hasFocus](https://knockoutjs.com/documentation/hasfocus-binding.html) binding whilst removing the automatic scrolling that will occur when focusing an element within the browser.
77+
This binding enables the functionality of Knockout's [hasFocus](https://knockoutjs.com/documentation/hasfocus-binding.html) binding while removing the automatic scrolling that occurs when focusing an element within the browser.
7878

7979
The binding has no configuration and must be passed an observable with a boolean value.
8080

0 commit comments

Comments
 (0)