Documentation build (#6762)

* move doc dependency in doctools

* add ignore link

* rebuild doc

* version index

* put it back some deps
This commit is contained in:
Eugenio Romano
2021-03-03 14:08:15 +00:00
committed by GitHub
parent e05c80f04f
commit c3452a4f62
227 changed files with 6994 additions and 4146 deletions

View File

@@ -13,17 +13,17 @@ Adds options to a Document List actions menu for a particular content type.
## Contents
* [Basic Usage](#basic-usage)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Examples](#examples)
* [Conditional visibility](#conditional-visibility)
* [Conditional disabled state](#conditional-disabled-state)
* [Customizing built-in actions](#customizing-built-in-actions)
* [Error, Permission and Success callbacks](#error-permission-and-success-callbacks)
* [See also](#see-also)
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Examples](#examples)
- [Conditional visibility](#conditional-visibility)
- [Conditional disabled state](#conditional-disabled-state)
- [Customizing built-in actions](#customizing-built-in-actions)
- [Error, Permission and Success callbacks](#error-permission-and-success-callbacks)
- [See also](#see-also)
## Basic Usage
@@ -83,7 +83,7 @@ export class MyView {
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| disableWithNoPermission | `boolean` | | Should this action be disabled in the menu if the user doesn't have permission for it? |
| disabled | `boolean \| Function` | false | Is the menu item disabled? |
| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". |
@@ -96,11 +96,11 @@ export class MyView {
### Events
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during the action. Applies to copy and move actions. |
| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the user selects the action from the menu. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a permission error occurs |
| success | `EventEmitter<any>` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. |
| ---- | ---- | ----------- |
| error | `any` | Emitted when an error occurs during the action. Applies to copy and move actions. |
| execute | `any` | Emitted when the user selects the action from the menu. |
| permissionEvent | `any` | Emitted when a permission error occurs |
| success | `any` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. |
## Details
@@ -109,18 +109,18 @@ The document actions are rendered on a dropdown menu for each items of content.
A number of built-in actions are defined to handle common use cases:
* **Download** (document)
* **lock** (document)
* **Copy** (document, folder)
* **Move** (document, folder)
* **Delete** (document, folder)
- **Download** (document)
- **lock** (document)
- **Copy** (document, folder)
- **Move** (document, folder)
- **Delete** (document, folder)
You can use one of the built-in handlers by assigning its name to the `handler` property.
(The names are case-insensitive, so `handler="download"` and `handler="DOWNLOAD"`
will trigger the same action.) You can also add your own handler by implementing the
`execute` event.
Note that you can use *both* a built-in handler and your own `execute`
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`](../../../lib/content-services/src/lib/document-list/models/document-library.model.ts) as its
parameter. For
example, with `handler="delete"` you could use `execute` to show a message with the name,
@@ -322,8 +322,8 @@ 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 the following scenarios:
* direct value of `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 `Function` type that evaluates condition and returns `boolean` value
#### Using direct boolean value
@@ -379,8 +379,8 @@ funcName = (parameters): boolean => {
As with the `visible` property, you can control the `disabled` state with the following options:
* direct value of `boolean` type
* binding to a property of the `Function` type that evaluates a condition and returns a `boolean` value
- direct value of `boolean` type
- binding to a property of the `Function` type that evaluates a condition and returns a `boolean` value
#### Using direct value of boolean type
@@ -442,14 +442,14 @@ for details and examples.
You can define error, permission and success callbacks in much the same way as for the delete permission handling.
* The error handler callback gets the error object that was raised
* The success callback's only parameter is the translatable success message string (which could be shown in a snackbar, for example)
* The `permissionEvent` callback is the same as described above for the delete action
- The error handler callback gets the error object that was raised
- The success callback's only parameter is the translatable success message string (which could be shown in a snackbar, for example)
- The `permissionEvent` callback is the same as described above for the delete action
![Copy/move document action](../../docassets/images/document-action-copymove.png)
## See also
* [Document list component](document-list.component.md)
* [Document actions service](../services/document-actions.service.md)
* [Folder actions service](../services/folder-actions.service.md)
- [Document list component](document-list.component.md)
- [Document actions service](../services/document-actions.service.md)
- [Folder actions service](../services/folder-actions.service.md)