inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2201] Fixed broken links (#2890)

Browse Source
This commit is contained in:
Andy Stark
2018-01-26 11:19:30 +00:00
committed by Eugenio Romano
parent d071250e24
commit 613b30bdb8
9 changed files with 87 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/README.md
View File

@@ -273,6 +273,7 @@ for more information about installing and using the source code.
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Filter model](filter.model.md) | Contains classes related to filters in Process Services. | [Source](../lib/process-services/task-list/models/filter.model.ts) | | [Filter model](filter.model.md) | Contains classes related to filters in Process Services. | [Source](../lib/process-services/task-list/models/filter.model.ts) |
| [Task details model](task-details.model.md) | Information about a task. | [Source](../lib/process-services/task-list/models/task-details.model.ts) |
## Services ## Services

2
docs/authentication.service.md
View File

@@ -33,4 +33,4 @@ export class AppComponent {
## Details ## Details
The authentication service is used inside the [login component](../ng2-components/ng2-alfresco-login/README.md) and is possible to find there an example of how to use it. The authentication service is used inside the [login component](login.component.md) and is possible to find there an example of how to use it.

132
docs/card-view.component.md
View File

@@ -8,19 +8,19 @@ Displays a configurable property list renderer.
<!-- toc --> <!-- toc -->
- [Basic Usage](#basic-usage) - [Basic Usage](#basic-usage)
* [Properties](#properties) - [Properties](#properties)
- [Details](#details) - [Details](#details)
* [Editing](#editing) - [Editing](#editing)
* [Defining properties](#defining-properties) - [Defining properties](#defining-properties)
+ [Card Text Item](#card-text-item) - [Card Text Item](#card-text-item)
+ [Card Map Item](#card-map-item) - [Card Map Item](#card-map-item)
+ [Card Date Item](#card-date-item) - [Card Date Item](#card-date-item)
* [Defining your custom card Item](#defining-your-custom-card-item) - [Defining your custom card Item](#defining-your-custom-card-item)
+ [1. Define the model for the custom type](#1-define-the-model-for-the-custom-type) - [1. Define the model for the custom type](#1-define-the-model-for-the-custom-type)
+ [2. Define the component for the custom type](#2-define-the-component-for-the-custom-type) - [2. Define the component for the custom type](#2-define-the-component-for-the-custom-type)
+ [3. Add you custom component to your module's entryComponents list](#3-add-you-custom-component-to-your-modules-entrycomponents-list) - [3. Add you custom component to your module's entryComponents list](#3-add-you-custom-component-to-your-modules-entrycomponents-list)
- [See also](#see-also) - [See also](#see-also)
<!-- tocstop --> <!-- tocstop -->
@@ -33,14 +33,13 @@ Displays a configurable property list renderer.
[properties]="[{label: 'My Label', value: 'My value'}]" [properties]="[{label: 'My Label', value: 'My value'}]"
[editable]="false"> [editable]="false">
</adf-card-view> </adf-card-view>
``` ```
### Properties ### Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | ---- | ---- | ------- | ----------- |
| properties | [CardViewItem](#cardviewitem)[] | - | (**required**) The custom view to render | | properties | [CardViewItem](#defining-properties)\[] | - | (**required**) The custom view to render |
| editable | boolean | - | If the component editable or not | | editable | boolean | - | If the component editable or not |
| displayEmpty | boolean | true | Whether to show empty properties in non-editable mode | | displayEmpty | boolean | true | Whether to show empty properties in non-editable mode |
@@ -51,8 +50,9 @@ You define the property list, the CardViewComponent does the rest. Each property
### Editing ### Editing
The card view can optionally allow its properties to be edited. You can control the editing of the properties in two level. The card view can optionally allow its properties to be edited. You can control the editing of the properties in two level.
- **global level** - *via the editable parameter of the card-view.component*
- **property level** - *in each property via the editable attribute* - **global level** - _via the editable parameter of the card-view.component_
- **property level** - _in each property via the editable attribute_
If you set the global editable parameter to false, no properties can be edited regardless of what is set inside the property. If you set the global editable parameter to false, no properties can be edited regardless of what is set inside the property.
@@ -78,13 +78,13 @@ export interface CardViewItem {
At the moment these are the models supported: At the moment these are the models supported:
- **CardViewTextItemModel** - *for text items* - **CardViewTextItemModel** - _for text items_
- **CardViewMapItemModel** - *for map items* - **CardViewMapItemModel** - _for map items_
- **CardViewDateItemModel** - *for date items* - **CardViewDateItemModel** - _for date items_
- **CardViewDatetimeItemModel** - *for datetime items* - **CardViewDatetimeItemModel** - _for datetime items_
- **CardViewBoolItemModel** - *for bool items (checkbox)* - **CardViewBoolItemModel** - _for bool items (checkbox)_
- **CardViewIntItemModel** - *for integers items* - **CardViewIntItemModel** - _for integers items_
- **CardViewFloatItemModel** - *for float items* - **CardViewFloatItemModel** - _for float items_
Each of them extends the abstract CardViewBaseItemModel class to add some custom functionality to the basic behaviour. Each of them extends the abstract CardViewBaseItemModel class to add some custom functionality to the basic behaviour.
@@ -151,16 +151,16 @@ const textItemProperty = new CardViewTextItemModel(options);
``` ```
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | ---- | ---- | ------- | ----------- |
| label* | string | --- | The label to render | | label\* | string | --- | The label to render |
| value* | any | --- | The original value | | value\* | any | --- | The original value |
| key* | string | --- | the key of the property. Have an important role when editing the property. | | key\* | string | --- | the key of the property. Have an important role when editing the property. |
| default | any | --- | The default value to render in case the value is empty | | default | any | --- | The default value to render in case the value is empty |
| displayValue* | string | --- | The value to render | | displayValue\* | string | --- | The value to render |
| editable | boolean | false | Whether the property editable or not | | editable | boolean | false | Whether the property editable or not |
| clickable | boolean | false | Whether the property clickable or not | | clickable | boolean | false | Whether the property clickable or not |
| multiline | string | false | Single or multiline text | | multiline | string | false | Single or multiline text |
| pipes | CardViewTextItemPipeProperty[] | [] | Pipes to be applied on the displayValue | | pipes | CardViewTextItemPipeProperty\[] | \[] | Pipes to be applied on the displayValue |
##### Using pipes in Card Text Item ##### Using pipes in Card Text Item
@@ -190,12 +190,12 @@ const mapItemProperty = new CardViewMapItemModel(options);
``` ```
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | ---- | ---- | ------- | ----------- |
| label* | string | --- | The label to render | | label\* | string | --- | The label to render |
| value* | Map | --- | A map that contains the key value pairs | | value\* | Map | --- | A map that contains the key value pairs |
| key* | string | --- | the key of the property. | | key\* | string | --- | the key of the property. |
| default | any | --- | The default value to render in case the value is empty | | default | any | --- | The default value to render in case the value is empty |
| displayValue* | string | --- | The value to render | | displayValue\* | string | --- | The value to render |
| clickable | boolean | false | Whether the property clickable or not | | clickable | boolean | false | Whether the property clickable or not |
#### Card Date Item #### Card Date Item
@@ -207,12 +207,12 @@ const dateItemProperty = new CardViewDateItemModel(options);
``` ```
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | ---- | ---- | ------- | ----------- |
| label* | string | --- | The label to render | | label\* | string | --- | The label to render |
| value* | any | --- | The original value | | value\* | any | --- | The original value |
| key* | string | --- | the key of the property. | | key\* | string | --- | the key of the property. |
| default | any | --- | The default value to render in case the value is empty | | default | any | --- | The default value to render in case the value is empty |
| displayValue* | any | --- | The value to render | | displayValue\* | any | --- | The value to render |
| editable | boolean | false | Whether the property editable or not | | editable | boolean | false | Whether the property editable or not |
| format | boolean | "MMM DD YYYY" | any format that momentjs accepts | | format | boolean | "MMM DD YYYY" | any format that momentjs accepts |
@@ -225,12 +225,12 @@ const datetimeItemProperty = new CardViewDatetimeItemModel(options);
``` ```
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | ---- | ---- | ------- | ----------- |
| label* | string | --- | The label to render | | label\* | string | --- | The label to render |
| value* | any | --- | The original value | | value\* | any | --- | The original value |
| key* | string | --- | the key of the property. | | key\* | string | --- | the key of the property. |
| default | any | any | The default value to render in case the value is empty | | default | any | any | The default value to render in case the value is empty |
| displayValue* | string | --- | The value to render | | displayValue\* | string | --- | The value to render |
| editable | boolean | false | Whether the property editable or not | | editable | boolean | false | Whether the property editable or not |
| format | boolean | "MMM DD YYYY HH:mm" | any format that momentjs accepts | | format | boolean | "MMM DD YYYY HH:mm" | any format that momentjs accepts |
@@ -243,12 +243,12 @@ const boolItemProperty = new CardViewBoolItemModel(options);
``` ```
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | ---- | ---- | ------- | ----------- |
| label* | string | --- | The label to render | | label\* | string | --- | The label to render |
| value* | boolean | --- | The original value | | value\* | boolean | --- | The original value |
| key* | string | --- | the key of the property. | | key\* | string | --- | the key of the property. |
| default | boolean | false | The default value to render in case the value is empty | | default | boolean | false | The default value to render in case the value is empty |
| displayValue* | boolean | --- | The value to render | | displayValue\* | boolean | --- | The value to render |
| editable | boolean | false | Whether the property editable or not | | editable | boolean | false | Whether the property editable or not |
#### Card Int Item #### Card Int Item
@@ -260,12 +260,12 @@ const intItemProperty = new CardViewIntItemModel(options);
``` ```
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | ---- | ---- | ------- | ----------- |
| label* | string | --- | The label to render | | label\* | string | --- | The label to render |
| value* | integer | --- | The original value | | value\* | integer | --- | The original value |
| key* | string | --- | the key of the property. | | key\* | string | --- | the key of the property. |
| default | integer | --- | The default value to render in case the value is empty | | default | integer | --- | The default value to render in case the value is empty |
| displayValue* | integer | --- | The value to render | | displayValue\* | integer | --- | The value to render |
| editable | boolean | false | Whether the property editable or not | | editable | boolean | false | Whether the property editable or not |
#### Card Float Item #### Card Float Item
@@ -277,12 +277,12 @@ const floatItemProperty = new CardViewFloatItemModel(options);
``` ```
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | ---- | ---- | ------- | ----------- |
| label* | string | --- | The label to render | | label\* | string | --- | The label to render |
| value* | float | --- | The original value | | value\* | float | --- | The original value |
| key* | string | --- | the key of the property. | | key\* | string | --- | the key of the property. |
| default | float | --- | The default value to render in case the value is empty | | default | float | --- | The default value to render in case the value is empty |
| displayValue* | float | --- | The value to render | | displayValue\* | float | --- | The value to render |
| editable | boolean | false | Whether the property editable or not | | editable | boolean | false | Whether the property editable or not |
### Defining your custom card Item ### Defining your custom card Item
@@ -294,7 +294,7 @@ Let's consider you want to have a **stardate** type to display Captain Picard's
#### 1. Define the Model for the custom type #### 1. Define the Model for the custom type
Your model has to extend the **CardViewBaseItemModel** and implement the **CardViewItem** and **DynamicComponentModel** interface. Your model has to extend the **CardViewBaseItemModel** and implement the **CardViewItem** and **DynamicComponentModel** interface.
*(You can check how the CardViewTextItemModel is implemented for further guidance.)* _(You can check how the CardViewTextItemModel is implemented for further guidance.)_
```js ```js
import { CardViewBaseItemModel, CardViewItem, DynamicComponentModel } from '@alfresco/adf-core'; import { CardViewBaseItemModel, CardViewItem, DynamicComponentModel } from '@alfresco/adf-core';
@@ -339,8 +339,8 @@ export class CardViewStarDateItemComponent {
... ...
} }
} }
``` ```
To make your component editable, you can have a look on either the CardViewTextItemComponent' or on the CardViewDateItemComponent's source. To make your component editable, you can have a look on either the CardViewTextItemComponent' or on the CardViewDateItemComponent's source.
#### 3. Add you custom component to your module's entryComponents list #### 3. Add you custom component to your module's entryComponents list
@@ -383,8 +383,10 @@ export class SomeParentComponent {
``` ```
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js --> <!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start --> <!-- seealso start -->
## See also ## See also
- [Card view update service](card-view-update.service.md) - [Card view update service](card-view-update.service.md)
<!-- seealso end --> <!-- seealso end -->

2
docs/file-uploading-dialog.component.md
View File

@@ -18,7 +18,7 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Are
This component should be used in combination with the This component should be used in combination with the
[Upload Button component](upload-button.component.md) or the [Upload Button component](upload-button.component.md) or the
[Drag Area component](drag-area.component.md). [Upload Drag Area component](upload-drag-area.component.md).
## See also ## See also

2
docs/form-field.model.md
View File

@@ -43,7 +43,7 @@ Contains the value and metadata for a field of an [ADF Form](form.component.md).
| fields | FormFieldModel\[] | \[] | Fields contained within a container field | | fields | FormFieldModel\[] | \[] | Fields contained within a container field |
| columns | ContainerColumnModel\[] | \[] | Column definitions for a container field | | columns | ContainerColumnModel\[] | \[] | Column definitions for a container field |
| emptyOption | FormFieldOption | | Dropdown menu item to use when no option is chosen | | emptyOption | FormFieldOption | | Dropdown menu item to use when no option is chosen |
| validationSummary | string | | Error/information message added during field validation (see [FormFieldValidator](FormFieldValidator) interface) | | validationSummary | string | | Error/information message added during field validation (see [FormFieldValidator](FormFieldValidator.md) interface) |
## Details ## Details

3
docs/search-control.component.md
View File

@@ -25,8 +25,7 @@ Displays a input text which shows find-as-you-type suggestions.
| expandable | boolean | true | Whether to use an expanding search control, if false then a regular input is used. | | expandable | boolean | true | Whether to use an expanding search control, if false then a regular input is used. |
| liveSearchEnabled | boolean | true | Whether find-as-you-type suggestions should be offered for matching content items. Set to false to disable. | | liveSearchEnabled | boolean | true | Whether find-as-you-type suggestions should be offered for matching content items. Set to false to disable. |
| liveSearchMaxResults | number | 5 | Maximum number of results to show in the live search. | | liveSearchMaxResults | number | 5 | Maximum number of results to show in the live search. |
| customQueryBody | [QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md) | | object which allow you to perform more elaborated query from the search api. This input is deprecated, to use the extended query body function please refer to the suggested solution [here](./search.component.md#querybody)| | customQueryBody | [QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md) | | object which allow you to perform more elaborated query from the search api. This input is deprecated, to use the extended query body function please refer to the suggested solution [here](search-configuration.interface.md) |
### Events ### Events

2
docs/search.component.md
View File

@@ -19,7 +19,7 @@ Searches items for supplied search terms.
| maxResults | number | 20 | Maximum number of results to show in the search. | | maxResults | number | 20 | Maximum number of results to show in the search. |
| skipResults | number | 0 | Number of results to skip from the results pagination. | | skipResults | number | 0 | Number of results to skip from the results pagination. |
| displayWith | function | | Function that maps an option's value to its display value in the trigger | | displayWith | function | | Function that maps an option's value to its display value in the trigger |
| queryBody | [QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md) | | object which allow you to perform more elaborated query from the search api. This input is deprecated, to use the extended query body function please refer to the suggested solution [here](./search.component.md#custom-search-configuration) | | queryBody | [QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md) | | object which allow you to perform more elaborated query from the search api. This input is deprecated, to use the extended query body function please refer to the suggested solution [here](search-configuration.interface.md) |
### Events ### Events

10
docs/task-details.model.md
View File

@@ -1,4 +1,8 @@
# TaskDetailsModel # Task Details model
Information about a task.
## Details
```json ```json
{ {
@@ -9,3 +13,7 @@
"description": "string" "description": "string"
} }
``` ```
## See Also
- [Task header component](task-header.component.md)

6
docs/task-header.component.md
View File

@@ -16,7 +16,7 @@ Shows all the information related to a task.
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- | | ---- | ---- | ------- | ----------- |
| taskDetails | [TaskDetailsModel](#taskdetailsmodel) | | (**required**) The task details related to the task. | | taskDetails | [TaskDetailsModel](task-details.model.md) | | (**required**) Details related to the task. |
| formName | string | | The name of the form. | | formName | string | | The name of the form. |
### Events ### Events
@@ -29,3 +29,7 @@ Shows all the information related to a task.
## Details ## Details
The purpose of the component is to populate the local variable called `properties` (array of CardViewModel), with all the information that we want to display. The purpose of the component is to populate the local variable called `properties` (array of CardViewModel), with all the information that we want to display.
## See also
- [Task Details model](task-details.model.md)