[ADF-2764] Updated doc files with latest script features (#3368)

* [ADF-2764] Updated doc files with latest script features

* [ADF-2764] Rebuilt full index instead of just content services index
This commit is contained in:
Andy Stark
2018-05-23 00:40:02 +01:00
committed by Eugenio Romano
parent f69bad3732
commit c8f04193c7
39 changed files with 353 additions and 280 deletions
@@ -21,6 +21,7 @@ Adds options to a Document List actions menu for a particular content type.
- [Details](#details)
- [Examples](#examples)
- [Conditional visibility](#conditional-visibility)
- [Customizing built-in actions](#customizing-built-in-actions)
- [Error, Permission and Success callbacks](#error-permission-and-success-callbacks)
@@ -90,9 +91,9 @@ export class MyView {
| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". |
| icon | `string` | | The name of the icon to display next to the menu command (can be left blank). |
| permission | `string` | | The permission type. |
| target | `string` | ContentActionTarget.All | Type of item that the action applies to. Can be "document" or "folder" |
| target | `string` | [`ContentActionTarget`](../../lib/content-services/document-list/models/content-action.model.ts).All | Type of item that the action appies to. Can be "document" or "folder" |
| title | `string` | "Action" | The title of the action as shown in the menu. |
| visible | `boolean` or `Function` | Visibility state (see examples further in the document) |
| visible | `boolean | Function` | true | Visibility state (see examples). |
### Events
@@ -122,7 +123,7 @@ will trigger the same action.) You can also add your own handler by implementing
`execute` event.
Note that you can use _both_ a built-in handler and your own `execute`
function in the same action. The `execute` function is passed a `NodeMinimalEntry` as its
function in the same action. The `execute` function is passed a [`NodeMinimalEntry`](../../lib/content-services/document-list/models/document-library.model.ts) as its
parameter (see the [Document Library model](document-library.model.md) page for more
information) which contains full details of the item that the action is operating on. For
example, with `handler="delete"` you could use `execute` to show a message with the name,
@@ -324,9 +325,9 @@ allow the item being copied/moved to be the destination if it is itself a folder
The `<content-action>` component allows you to control visibility with the help of the `visible` property and supports three major scenarios:
* direct value of `boolean` type
* binding to a property of the `boolean` type
* binding to a property of the `Function` type that evaluates condition and returns `boolean` value
- direct value of `boolean` type
- binding to a property of the `boolean` type
- binding to a property of the `Function` type that evaluates condition and returns `boolean` value
#### Using direct value of boolean type