From cb7a6b0a7ae7563e619d2b96def1e3e5b35271a2 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Tue, 7 Aug 2018 17:36:15 +0100 Subject: [PATCH] [ADF-3425] Minor edits to doc files (#3667) --- .../content-metadata.component.md | 4 ++-- .../upload-drag-area.component.md | 24 ++++++++++--------- docs/core/header.component.md | 23 +++++++++++------- docs/core/login.component.md | 19 ++++++++------- 4 files changed, 39 insertions(+), 31 deletions(-) diff --git a/docs/content-services/content-metadata.component.md b/docs/content-services/content-metadata.component.md index 04d593dd1f..915bd62062 100644 --- a/docs/content-services/content-metadata.component.md +++ b/docs/content-services/content-metadata.component.md @@ -1,7 +1,7 @@ --- Added: v2.1.0 Status: Active -Last reviewed: 2018-04-16 +Last reviewed: 2018-08-07 --- # Content Metadata Card component @@ -124,7 +124,7 @@ A final example shows the same process applied to a custom preset called "kitten ### Layout oriented config You can also go beyond the aspect oriented configuration if you need to configure the groups and properties in a more detailed way. With this type of configuration any property of any aspect/type -can be "cherry picked" and grouped into an accordion drawer, along wwith a translatable title +can be "cherry picked" and grouped into an accordion drawer, along with a translatable title defined in the preset configuration. #### Basic elements diff --git a/docs/content-services/upload-drag-area.component.md b/docs/content-services/upload-drag-area.component.md index 664f378753..159ba5db91 100644 --- a/docs/content-services/upload-drag-area.component.md +++ b/docs/content-services/upload-drag-area.component.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-05-04 +Last reviewed: 2018-08-07 --- # Upload Drag Area Component @@ -53,19 +53,21 @@ export class AppComponent { | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | -## Intercepting uploads +## Details -You can intercept the upload process by utilizing the `beginUpload` event. +### Intercepting uploads + +You can intercept the upload process using the `beginUpload` event. The event has a type of [`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts) and provides the following APIs: -- **files**: get access to the [`FileInfo`](../../lib/core/utils/file-utils.ts) objects that are prepared for the upload -- **pauseUpload**: pause the upload and perform additional tasks, like showing the confirmation dialog -- **resumeUpload**: resume the upload process +- **files**: accesses the [`FileInfo`](../../lib/core/utils/file-utils.ts) objects that are prepared for the upload +- **pauseUpload**: pauses the upload and performs additional tasks, like showing the confirmation dialog +- **resumeUpload**: resumes the upload process -## Example +### Example -Wire the `beginUpload` event at the template level +Wire the `beginUpload` event at the template level: ```html @@ -73,7 +75,7 @@ Wire the `beginUpload` event at the template level ``` -Create the `onBeginUpload` handler that invokes a confirmation dialog +Create the `onBeginUpload` handler that invokes a confirmation dialog: ```ts import { UploadFilesEvent, ConfirmDialogComponent } from '@alfresco/adf-content-services'; @@ -106,5 +108,5 @@ export class MyComponent { } ``` -The example above is going to raise confirmation dialog every time a user uploads more than 1 file. -That can be either 2 or more files, or a folder with multiple entries. +The example above shows a confirmation dialog every time a user uploads more than 1 file. +This could be either a selection of 2 or more files, or a folder with multiple entries. diff --git a/docs/core/header.component.md b/docs/core/header.component.md index fbd8a5ef55..9c16a2a4d7 100644 --- a/docs/core/header.component.md +++ b/docs/core/header.component.md @@ -1,9 +1,10 @@ --- Added: v2.4.0 Status: Experimental +Last reviewed: 2018-08-07 --- -## Header component +# Header component Reusable header for Alfresco applications @@ -25,21 +26,25 @@ Reusable header for Alfresco applications ## Class members ### Properties + | Name | Type | Description | | -- | -- | -- | -| title | string | Title of the application -| logo | string | Path to an image file for the application logo. -| redirectUrl | string\|any[] | The router link for the application logo. -| tooltip | string | The tooltip text for the application logo. -| color | string | Background color for the header. It can be any hex color code or the Material theme colors: 'primary', 'accent' or 'warn'. -| showSidenavToggle | boolean | Signals if the sidenav button will be displayed in the header or not. By default is true. +| title | `string` | Title of the application +| logo | `string` | Path to an image file for the application logo. +| redirectUrl | `string` \| `any[]` | The router link for the application logo. +| tooltip | `string` | The tooltip text for the application logo. +| color | `string` | Background color for the header. It can be any hex color code or the Material theme colors: 'primary', 'accent' or 'warn'. +| showSidenavToggle | `boolean` | Signals if the sidenav button will be displayed in the header or not. By default is true. ### Events + | Name | Type | Description | | -- | -- | -- | | clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when click on sidenav button ## Details -This component displays a customizable header which can be reused. The left side of the header (title, button) and the primary color for the header can be configured via input parameters. -The right part of the header are existing components which are transcluded in the header component. +This component displays a customizable header that can be reused. Use the input properties to +configure the left side (title, button) and the primary color of the header. + +The right part of the header can contain other components which are transcluded in the header component. diff --git a/docs/core/login.component.md b/docs/core/login.component.md index fc41b76dd5..fae51dc97e 100644 --- a/docs/core/login.component.md +++ b/docs/core/login.component.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-03-19 +Last reviewed: 2018-08-07 --- # Login component @@ -24,7 +24,6 @@ Authenticates to Alfresco Content Services and or Alfresco Process Services. - [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) - - [Implicit Flow](#implicit-flow) - [See Also](#see-also) ## Basic usage @@ -268,11 +267,15 @@ export class MyCustomLogin { } ``` +Note that if you do not call `event.preventDefault()` then the default behaviour +will execute _after_ your custom code has completed. + ### SSO login -### Implicit Flow +#### Implicit Flow -If the 'app.config.json' or you used the host-setting component to use the SSO Oauth the [login component](../core/login.component.md) will show only a button to login: +If you used the host-setting component to enable SSO Oauth (or if you +enabled the setting in `app.config.json`) then the [login component](../core/login.component.md) will show only a button to login: ```JSON "authType" :"OAUTH", @@ -290,11 +293,9 @@ If the 'app.config.json' or you used the host-setting component to use the SSO O ![Login component](../docassets/images/sso-login.png) -Note if the silentLogin property in the oauth2 configuration is true will not be possible to show the login page. with silentLogin true the application is automatically redirect to the -authorization server when is not logged-in - -Note that if you do not call `event.preventDefault()` then the default behaviour -will execute _after_ your custom code has completed. +Note that if the `silentLogin property` in the `oauth2` configuration is set to true +then the login page will not be shown. Instead, the application will redirect +automatically to the authorization server when the user is not logged-in ## See Also