mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
Eugenio Romano
GitHub
@@ -20,7 +20,7 @@ Defines column properties for DataTable, Tasklist, Document List and other compo
|
||||
- [Custom tooltips](#custom-tooltips)
|
||||
- [Column Template](#column-template)
|
||||
- [Styling Techniques](#styling-techniques)
|
||||
- [Using the `copyContent` option](#using-the-copycontent-option)
|
||||
- [Using the copyContent option](#using-the-copycontent-option)
|
||||
- [See also](#see-also)
|
||||
|
||||
## Basic Usage
|
||||
@@ -303,7 +303,7 @@ Now you can declare columns and assign the `desktop-only` class where needed:
|
||||
### Using the `copyContent` option
|
||||
|
||||
When the `copyContent` property is true, a
|
||||
Clipboard directive
|
||||
[Clipboard directive](../../core/directives/clipboard.directive.md)
|
||||
is added to each cell in the column. This lets the user copy the cell content
|
||||
to the clipboard with a mouse click.
|
||||
|
||||
@@ -328,6 +328,7 @@ HTML `<data-column>` element example:
|
||||
</data-columns>
|
||||
</adf-tasklist>
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [Document list component](../../content-services/components/document-list.component.md)
|
||||
|
||||
@@ -311,7 +311,7 @@ while the data for the table is loading:
|
||||
}
|
||||
```
|
||||
|
||||
###Styling transcluded content
|
||||
\###Styling transcluded content
|
||||
|
||||
When adding your custom templates you can style them as you like. However, for an out of the box experience, if you want to apply datatable styles to your column you will need to follow this structure:
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ this.router.navigate(['/error', errorCode]);
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| errorCode | `string` | "UNKNOWN" | Error code associated with this error. |
|
||||
| errorCode | `string` | | Error code associated with this error. |
|
||||
| returnButtonUrl | `string` | "/" | Target URL for the return button. |
|
||||
| secondaryButtonUrl | `string` | "report-issue" | Target URL for the secondary button. |
|
||||
|
||||
|
||||
@@ -38,8 +38,8 @@ uses `<adf-form-field>` components to render the form fields.
|
||||
|
||||
Forms defined in APS have the following default mappings for the form fields:
|
||||
|
||||
| _APS [Form](../../../lib/process-services/task-list/models/form.model.ts) Designer_ Widget | Field Type | Component Type |
|
||||
| ------------------------------------------------------------------------------------------ | ---------- | -------------- |
|
||||
| _APS [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Designer_ Widget | Field Type | Component Type |
|
||||
| -------------------------------------------------------------------------------------------- | ---------- | -------------- |
|
||||
| Text | text | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) |
|
||||
| Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) |
|
||||
| Number | integer | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) |
|
||||
|
||||
@@ -40,7 +40,7 @@ Adds "infinite" pagination to the component it is used with.
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| isLoading | `boolean` | false | Is a new page loading? |
|
||||
| pageSize | `number` | | Number of items that are added with each "load more" event. |
|
||||
| target | | | Component that provides custom pagination support. |
|
||||
| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@@ -69,13 +69,13 @@ sub-components (note the use of `<ng-template>` in the sub-components' body sect
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| direction | `string` | "ltr" | The direction of the layout. 'ltr' or 'rtl' |
|
||||
| expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? |
|
||||
| hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region. |
|
||||
| position | `string` | "start" | The side that the drawer is attached to. Possible values are 'start' and 'end'. |
|
||||
| sidenavMax | `number` | | Maximum size of the navigation region. |
|
||||
| sidenavMin | `number` | | Minimum size of the navigation region. |
|
||||
| stepOver | `number` | | Screen size at which display switches from small screen to large screen configuration. |
|
||||
| direction | `string` | `ltr` | The direction of the layout. 'ltr' or 'rtl' |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ Status: Active
|
||||
Last reviewed: 2018-06-08
|
||||
---
|
||||
|
||||
# [Start Form component](../../../lib/core/form/components/start-form.component.ts "Defined in start-form.component.ts")
|
||||
# [Start Form component](../../../lib/process-services/form/start-form.component.ts "Defined in start-form.component.ts")
|
||||
|
||||
Displays the Start [`Form`](../../../lib/process-services/task-list/models/form.model.ts) for a process.
|
||||
|
||||
@@ -42,7 +42,6 @@ Displays the Start [`Form`](../../../lib/process-services/task-list/models/form.
|
||||
| readOnlyForm | `boolean` | false | Is the form read-only (ie, can't be edited)? |
|
||||
| saveMetadata | `boolean` | false | Toggle saving of form metadata. |
|
||||
| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. |
|
||||
| showDebugButton | `boolean` | false | Toggle debug options. |
|
||||
| showOutcomeButtons | `boolean` | true | Should form outcome buttons be shown? |
|
||||
| showRefreshButton | `boolean` | true | Should the refresh button be shown? |
|
||||
| showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. |
|
||||
|
||||
@@ -24,7 +24,7 @@ See it live: [Viewer Quickstart](https://embed.plnkr.co/iTuG1lFIXfsP95l6bDW6/)
|
||||
- [Custom file parameters](#custom-file-parameters)
|
||||
- [Supported file formats](#supported-file-formats)
|
||||
- [Content Renditions](#content-renditions)
|
||||
- [Configuring PDF.js library](#configuring-pdf-js-library)
|
||||
- [Configuring PDF.js library](#configuring-pdfjs-library)
|
||||
- [Extending the Viewer](#extending-the-viewer)
|
||||
- [Custom layout](#custom-layout)
|
||||
- [Printing](#printing)
|
||||
@@ -475,7 +475,7 @@ Note: For the pdf viewer the value has to be within the range of 25 - 1000.
|
||||
"adf-viewer": {
|
||||
"pdf-viewer-scaling": 150
|
||||
}
|
||||
|
||||
|
||||
In the same way you can set a default zoom scaling value for the image viewer by adding the following code in `app.config.json`.
|
||||
|
||||
"adf-viewer": {
|
||||
|
||||
@@ -27,8 +27,8 @@ Copies text to the clipboard.
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| adf-clipboard | `string` | | Translation key or message for the tooltip. |
|
||||
| clipboard-notification | `string` | | Translation key or message for snackbar notification. |
|
||||
| message | `string` | | Translation key or message for snackbar notification. |
|
||||
| placeholder | `string` | | Translation key or message for the tooltip. |
|
||||
| target | [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)` \| `[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) | | Reference to the HTML element containing the text to copy. |
|
||||
|
||||
## Details
|
||||
|
||||
@@ -81,9 +81,9 @@ Provides authentication to ACS and APS.
|
||||
- _password:_ `string` - Password for the login
|
||||
- _rememberMe:_ `boolean` - Stores the user's login details if true
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket
|
||||
- **logout**(): `any`<br/>
|
||||
- **logout**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Logs the user out.
|
||||
- **Returns** `any` - Response event called when logout is complete
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Response event called when logout is complete
|
||||
- **setRedirect**(url: [`RedirectionModel`](../../../lib/core/models/redirection.model.ts))<br/>
|
||||
Sets the URL to redirect to after login.
|
||||
- _url:_ [`RedirectionModel`](../../../lib/core/models/redirection.model.ts) - URL to redirect to
|
||||
|
||||
@@ -13,27 +13,27 @@ Maps type names to field component types for the [Card View component](../compon
|
||||
|
||||
### Methods
|
||||
|
||||
- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): `DynamicComponentResolveFunction`<br/>
|
||||
Gets the currently active DynamicComponentResolveFunction for a field type.
|
||||
- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)<br/>
|
||||
Gets the currently active [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type.
|
||||
- _type:_ `string` - The type whose resolver you want
|
||||
- _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped
|
||||
- **Returns** `DynamicComponentResolveFunction` - Resolver function
|
||||
- **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function
|
||||
- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`<br/>
|
||||
Finds the component type that is needed to render a form field.
|
||||
- _model:_ [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/task-list/models/form.model.ts) field model for the field to render
|
||||
- _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped.
|
||||
- **Returns** `Type<__type>` - Component type
|
||||
- **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)<br/>
|
||||
Sets or optionally replaces a DynamicComponentResolveFunction for a field type.
|
||||
- **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)<br/>
|
||||
Sets or optionally replaces a [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type.
|
||||
- _type:_ `string` - The type whose resolver you want to set
|
||||
- _resolver:_ `DynamicComponentResolveFunction` - The new resolver function
|
||||
- _resolver:_ [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - The new resolver function
|
||||
- _override:_ `boolean` - The new resolver will only replace an existing one if this parameter is true
|
||||
|
||||
## Details
|
||||
|
||||
The [Card View component](../components/card-view.component.md) uses this service to find the component
|
||||
type that is required to display a particular field type (text, date, etc). The service
|
||||
maps a type name string to a corresponding `DynamicComponentResolveFunction` that takes a
|
||||
maps a type name string to a corresponding [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) that takes a
|
||||
model object as a parameter and returns the component type needed to display that model.
|
||||
|
||||
The default mapping is shown below:
|
||||
|
||||
@@ -13,20 +13,20 @@ Maps a form field type string onto the corresponding form [widget component](../
|
||||
|
||||
### Methods
|
||||
|
||||
- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): `DynamicComponentResolveFunction`<br/>
|
||||
Gets the currently active DynamicComponentResolveFunction for a field type.
|
||||
- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)<br/>
|
||||
Gets the currently active [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type.
|
||||
- _type:_ `string` - The type whose resolver you want
|
||||
- _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped
|
||||
- **Returns** `DynamicComponentResolveFunction` - Resolver function
|
||||
- **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function
|
||||
- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`<br/>
|
||||
Finds the component type that is needed to render a form field.
|
||||
- _model:_ [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/task-list/models/form.model.ts) field model for the field to render
|
||||
- _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped.
|
||||
- **Returns** `Type<__type>` - Component type
|
||||
- **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)<br/>
|
||||
Sets or optionally replaces a DynamicComponentResolveFunction for a field type.
|
||||
- **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)<br/>
|
||||
Sets or optionally replaces a [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type.
|
||||
- _type:_ `string` - The type whose resolver you want to set
|
||||
- _resolver:_ `DynamicComponentResolveFunction` - The new resolver function
|
||||
- _resolver:_ [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - The new resolver function
|
||||
- _override:_ `boolean` - The new resolver will only replace an existing one if this parameter is true
|
||||
|
||||
## Details
|
||||
@@ -34,7 +34,7 @@ Maps a form field type string onto the corresponding form [widget component](../
|
||||
The [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Field component uses this service to choose which widget to use to render an instance of a
|
||||
form field. The [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Field model stores the field type name as a string (see the table below).
|
||||
The [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Rendering service maintains a mapping between each type name and
|
||||
a corresponding `DynamicComponentResolveFunction`. The function takes a [`FormFieldModel`](../../core/models/form-field.model.md) object as its argument and
|
||||
a corresponding [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts). The function takes a [`FormFieldModel`](../../core/models/form-field.model.md) object as its argument and
|
||||
uses the data from the object to determine which widget should be used to render the field.
|
||||
|
||||
In some cases, the field type string alone is enough to determine the widget type and so the function
|
||||
|
||||
@@ -17,16 +17,16 @@ Shows a notification message with optional feedback.
|
||||
|
||||
- **dismissSnackMessageAction**()<br/>
|
||||
dismiss the notification snackbar
|
||||
- **openSnackMessage**(message: `string`, config: `number|MatSnackBarConfig` = [`NotificationService`](../../core/services/notification.service.md)`.DEFAULT_DURATION_MESSAGE`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
|
||||
- **openSnackMessage**(message: `string`, config?: `number|MatSnackBarConfig`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
|
||||
Opens a SnackBar notification to show a message.
|
||||
- _message:_ `string` - The message (or resource key) to show.
|
||||
- _config:_ `number|MatSnackBarConfig` - Time before notification disappears after being shown or MatSnackBarConfig object
|
||||
- _config:_ `number|MatSnackBarConfig` - (Optional) Time before notification disappears after being shown or MatSnackBarConfig object
|
||||
- **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>` - Information/control object for the SnackBar
|
||||
- **openSnackMessageAction**(message: `string`, action: `string`, config: `number|MatSnackBarConfig` = [`NotificationService`](../../core/services/notification.service.md)`.DEFAULT_DURATION_MESSAGE`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
|
||||
- **openSnackMessageAction**(message: `string`, action: `string`, config?: `number|MatSnackBarConfig`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
|
||||
Opens a SnackBar notification with a message and a response button.
|
||||
- _message:_ `string` - The message (or resource key) to show.
|
||||
- _action:_ `string` - Caption for the response button
|
||||
- _config:_ `number|MatSnackBarConfig` - Time before notification disappears after being shown or MatSnackBarConfig object
|
||||
- _config:_ `number|MatSnackBarConfig` - (Optional) Time before notification disappears after being shown or MatSnackBarConfig object
|
||||
- **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>` - Information/control object for the SnackBar
|
||||
|
||||
## Details
|
||||
@@ -93,11 +93,10 @@ export class MyComponent implements OnInit {
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The default message duration is 5000 ms that is used only if you don't pass a custom duration in the parameters of openSnackMessageAction/openSnackMessage methods.
|
||||
You can also change the default 5000 ms adding the following configuration in the app.config.json:
|
||||
|
||||
```json
|
||||
|
||||
"notificationDefaultDuration" : "7000"
|
||||
|
||||
```
|
||||
|
||||
@@ -18,12 +18,12 @@ Manipulates content related to a Process Instance or Task Instance in APS.
|
||||
- _content:_ `any` - File to associate
|
||||
- _opts:_ `any` - (Optional) Options supported by JS-API
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Details of created content
|
||||
- **createTaskRelatedContent**(taskId: `string`, file: `any`, opts?: `any`): `any`<br/>
|
||||
- **createTaskRelatedContent**(taskId: `string`, file: `any`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Associates an uploaded file with a task instance.
|
||||
- _taskId:_ `string` - ID of the target task
|
||||
- _file:_ `any` - File to associate
|
||||
- _opts:_ `any` - (Optional) Options supported by JS-API
|
||||
- **Returns** `any` - Details of created content
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Details of created content
|
||||
- **createTemporaryRawRelatedContent**(file: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md)`>`<br/>
|
||||
Create temporary related content from an uploaded file.
|
||||
- _file:_ `any` - File to use for content
|
||||
|
||||
@@ -13,13 +13,13 @@ Manages prearranged conversions of content to different formats.
|
||||
|
||||
### Methods
|
||||
|
||||
- **convert**(nodeId: `string`, encoding: `string`, pollingInterval: `number` = `1000`, retries: `number` = `5`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Object>`<br/>
|
||||
- **convert**(nodeId: `string`, encoding: `string`, pollingInterval: `number` = `1000`, retries: `number` = `5`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>`<br/>
|
||||
Repeatedly attempts to create a rendition, through to success or failure.
|
||||
- _nodeId:_ `string` - ID of the target node
|
||||
- _encoding:_ `string` - Name of the rendition encoding
|
||||
- _pollingInterval:_ `number` - Time interval (in milliseconds) between checks for completion
|
||||
- _retries:_ `number` - Number of attempts to make before declaring failure
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Object>` - True if the rendition was created, false otherwise
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>` - True if the rendition was created, false otherwise
|
||||
- **createRendition**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<__type>`<br/>
|
||||
Creates a rendition for a node.
|
||||
- _nodeId:_ `string` - ID of the target node
|
||||
|
||||
@@ -15,6 +15,8 @@ Stores items in the form of key-value pairs.
|
||||
|
||||
- **clear**()<br/>
|
||||
Removes all currently stored items.
|
||||
- **getAppPrefix**()<br/>
|
||||
Sets the prefix that is used for the local storage of the app It assigns the string that is defined i the app config, empty prefix otherwise.
|
||||
- **getItem**(key: `string`): `string|null`<br/>
|
||||
Gets an item.
|
||||
- _key:_ `string` - Key to identify the item
|
||||
|
||||
@@ -43,6 +43,10 @@ Stores preferences for the app and for individual components.
|
||||
- **setStoragePrefix**(value: `string`)<br/>
|
||||
Sets the active storage prefix for preferences.
|
||||
- _value:_ `string` - Name of the prefix
|
||||
- **setWithoutStore**(property: `string`, value: `any`)<br/>
|
||||
Sets a preference property.
|
||||
- _property:_ `string` - Name of the property
|
||||
- _value:_ `any` - New value for the property
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
Reference in New Issue
Block a user