You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/knockout-bindings.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,14 @@
2
2
3
3
## Summary
4
4
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.
|`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. |
10
10
|`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. |
13
13
{:style="table-layout:auto"}
14
14
15
15
### `sortable` binding
@@ -24,14 +24,14 @@ Within Page Builder, we use the `sortable` binding to pass preview-component opt
24
24
25
25
**Configuration:**
26
26
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/
28
28
29
29
**Usage:**
30
30
31
31
```html
32
32
<divdata-bind="sortable: getSortableOptions()" />
33
33
```
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._
35
35
36
36
### `draggable` binding
37
37
@@ -45,18 +45,18 @@ Within Page Builder, we use this binding for the left panel's content types. The
45
45
46
46
**Configuration:**
47
47
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/
_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._
56
56
57
57
### `liveEdit` binding
58
58
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.
60
60
61
61
**Configuration:**
62
62
@@ -74,7 +74,7 @@ This binding provides basic text live editing functionality to the current eleme
74
74
75
75
### `hasFocusNoScroll` binding
76
76
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.
78
78
79
79
The binding has no configuration and must be passed an observable with a boolean value.
0 commit comments