mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-3921] Reviewed docs where deprecated stuff was removed (#4172)
This commit is contained in:
committed by
Eugenio Romano
parent
ad572fed1d
commit
b7284051ab
@@ -2,7 +2,7 @@
|
||||
Title: Form component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-14
|
||||
Last reviewed: 2019-01-16
|
||||
---
|
||||
|
||||
# [Form component](../../lib/core/form/components/form.component.ts "Defined in form.component.ts")
|
||||
@@ -58,7 +58,7 @@ Any content in the body of `<adf-form>` will be shown when no form definition is
|
||||
| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. |
|
||||
| fieldValidators | [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Contains a list of form field validator instances. |
|
||||
| form | [`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../lib/core/form/components/widgets/core/form.model.ts) instance. |
|
||||
| formId | `string` | | The id of the form definition to load and display with custom values. |
|
||||
| formId | `number` | | The id of the form definition to load and display with custom values. |
|
||||
| formName | `string` | | Name of the form definition to load and display with custom values. |
|
||||
| nameNode | `string` | | Name to assign to the new node where the metadata are stored. |
|
||||
| nodeId | `string` | | Content Services node ID for the form metadata. |
|
||||
@@ -77,6 +77,7 @@ Any content in the body of `<adf-form>` will be shown when no form definition is
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs. |
|
||||
| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
|
||||
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
|
||||
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. |
|
||||
@@ -84,7 +85,6 @@ Any content in the body of `<adf-form>` will be shown when no form definition is
|
||||
| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../core/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. |
|
||||
| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. |
|
||||
| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs. |
|
||||
|
||||
## Details
|
||||
|
||||
|
@@ -2,7 +2,7 @@
|
||||
Title: Host settings component
|
||||
Added: v2.0.0
|
||||
Status: Internal
|
||||
Last reviewed: 2018-09-13
|
||||
Last reviewed: 2019-01-16
|
||||
---
|
||||
|
||||
# [Host settings component](../../lib/core/settings/host-settings.component.ts "Defined in host-settings.component.ts")
|
||||
|
@@ -2,7 +2,7 @@
|
||||
Title: Infinite Pagination component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-13
|
||||
Last reviewed: 2019-01-16
|
||||
---
|
||||
|
||||
# [Infinite Pagination component](../../lib/core/pagination/infinite-pagination.component.ts "Defined in infinite-pagination.component.ts")
|
||||
@@ -46,7 +46,7 @@ Adds "infinite" pagination to the component it is used with.
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when the "Load More" button is clicked. |
|
||||
| loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../lib/core/models/pagination.model.ts)`>` | Emitted when the "Load More" button is clicked. |
|
||||
|
||||
## Details
|
||||
|
||||
|
@@ -2,7 +2,7 @@
|
||||
Title: Login component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-13
|
||||
Last reviewed: 2019-01-16
|
||||
---
|
||||
|
||||
# [Login component](../../lib/core/login/components/login.component.ts "Defined in login.component.ts")
|
||||
@@ -24,7 +24,7 @@ Authenticates to Alfresco Content Services and Alfresco Process Services.
|
||||
- [Customizing validation rules](#customizing-validation-rules)
|
||||
- [Call an external identity provider to fetch the auth token](#call-an-external-identity-provider-to-fetch-the-auth-token)
|
||||
- [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour)
|
||||
- [SSO login](#sso-login)
|
||||
- [Single Sign-On (SSO)](#single-sign-on-sso)
|
||||
- [See Also](#see-also)
|
||||
|
||||
## Basic usage
|
||||
@@ -98,7 +98,7 @@ with custom input fields handled by your application or parent component:
|
||||
|
||||
### Handling events
|
||||
|
||||
**[app.component](../../demo-shell/src/app/app.component.ts).html**
|
||||
**app.component.html**
|
||||
|
||||
```html
|
||||
<adf-login
|
||||
@@ -107,7 +107,7 @@ with custom input fields handled by your application or parent component:
|
||||
</adf-login>
|
||||
```
|
||||
|
||||
**[app.component](../../demo-shell/src/app/app.component.ts).ts**
|
||||
**app.component.ts**
|
||||
|
||||
```ts
|
||||
export class AppComponent {
|
||||
@@ -302,8 +302,8 @@ automatically to the authorization server when the user is not logged-in
|
||||
You can also enable automatic redirection to OAuth provider
|
||||
by utilising the following properties:
|
||||
|
||||
* silentLogin
|
||||
* redirectSilentIframeUri
|
||||
- silentLogin
|
||||
- redirectSilentIframeUri
|
||||
|
||||
```json
|
||||
{
|
||||
|
@@ -2,7 +2,7 @@
|
||||
Title: Node Restore directive
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-13
|
||||
Last reviewed: 2019-01-16
|
||||
---
|
||||
|
||||
# [Node Restore directive](../../lib/core/directives/node-restore.directive.ts "Defined in node-restore.directive.ts")
|
||||
|
@@ -2,7 +2,7 @@
|
||||
Title: Upload Service
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-12
|
||||
Last reviewed: 2019-01-16
|
||||
---
|
||||
|
||||
# [Upload Service](../../lib/core/services/upload.service.ts "Defined in upload.service.ts")
|
||||
|
@@ -2,7 +2,7 @@
|
||||
Title: User Preferences Service
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-20
|
||||
Last reviewed: 2019-01-16
|
||||
---
|
||||
|
||||
# [User Preferences Service](../../lib/core/services/user-preferences.service.ts "Defined in user-preferences.service.ts")
|
||||
|
@@ -2,7 +2,7 @@
|
||||
Title: Viewer component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-13
|
||||
Last reviewed: 2019-01-16
|
||||
---
|
||||
|
||||
# [Viewer component](../../lib/core/viewer/components/viewer.component.ts "Defined in viewer.component.ts")
|
||||
@@ -80,15 +80,14 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
|
||||
| allowFullScreen | `boolean` | true | Toggles the 'Full Screen' feature. |
|
||||
| allowGoBack | `boolean` | true | Allows `back` navigation |
|
||||
| allowLeftSidebar | `boolean` | false | Allow the left the sidebar. |
|
||||
| allowRightSidebar | `boolean` | false | Allow the right sidebar. |
|
||||
| allowNavigate | `boolean` | false | Toggles before/next navigation. You can use the arrow buttons to navigate between documents in the collection. |
|
||||
| allowPrint | `boolean` | false | Toggles printing. |
|
||||
| allowRightSidebar | `boolean` | false | Allow the right sidebar. |
|
||||
| allowThumbnails | `boolean` | true | Toggles PDF thumbnails. |
|
||||
| blobFile | [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) | | Loads a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) File |
|
||||
| canNavigateBefore | `boolean` | true | Toggles the "before" ("<") button. Requires `allowNavigate` to be enabled. |
|
||||
| canNavigateNext | `boolean` | true | Toggles the next (">") button. Requires `allowNavigate` to be enabled. |
|
||||
| displayName | `string` | | Specifies the name of the file when it is not available from the URL. |
|
||||
| downloadUrl | `string` | null | URL to download. |
|
||||
| fileName | `string` | | Content filename. |
|
||||
| maxRetries | `number` | 10 | Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts. |
|
||||
| mimeType | `string` | | MIME type of the file content (when not determined by the filename extension). |
|
||||
@@ -96,11 +95,11 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
|
||||
| overlayMode | `boolean` | false | If `true` then show the Viewer as a full page over the current content. Otherwise fit inside the parent div. |
|
||||
| sharedLinkId | `string` | null | Shared link id (to display shared file). |
|
||||
| showLeftSidebar | `boolean` | false | Toggles left sidebar visibility. Requires `allowLeftSidebar` to be set to `true`. |
|
||||
| showRightSidebar | `boolean` | false |Toggles Right sidebar visibility. Requires `allowRightSidebar` to be set to `true`. |
|
||||
| showRightSidebar | `boolean` | false | Toggles right sidebar visibility. Requires `allowRightSidebar` to be set to `true`. |
|
||||
| showToolbar | `boolean` | true | Hide or show the toolbar |
|
||||
| showViewer | `boolean` | true | Hide or show the viewer |
|
||||
| sidebarLeftTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`<any>` | null | The template for the left sidebar. The template context contains the loaded node data. |
|
||||
| sidebarRightTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`<any>` | null | The template for right sidebar. The template context contains the loaded node data. |
|
||||
| sidebarRightTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`<any>` | null | The template for the right sidebar. The template context contains the loaded node data. |
|
||||
| thumbnailsTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`<any>` | null | The template for the pdf thumbnails. |
|
||||
| urlFile | `string` | "" | If you want to load an external file that does not come from ACS you can use this URL to specify where to load the file from. |
|
||||
| urlFileViewer | `string` | null | Viewer to use with the `urlFile` address (`pdf`, `image`, `media`, `text`). Used when `urlFile` has no filename and extension. |
|
||||
@@ -109,14 +108,12 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| download | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Download' button. |
|
||||
| extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the filename extension changes. |
|
||||
| goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Back' button. |
|
||||
| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the shared link used is not valid. |
|
||||
| navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when user clicks 'Navigate Before' ("<") button. |
|
||||
| navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when user clicks 'Navigate Next' (">") button. |
|
||||
| print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Print' button. |
|
||||
| share | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Share' button. |
|
||||
| showViewerChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the viewer is shown or hidden. |
|
||||
|
||||
## Keyboard shortcuts
|
||||
|
Reference in New Issue
Block a user