Update doc (#8085)

This commit is contained in:
Eugenio Romano
2023-01-02 15:00:01 +01:00
committed by GitHub
parent 093b1e8a67
commit 00dfd7c5d9
158 changed files with 758 additions and 928 deletions

View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-05-24
---
# [App Config Pipe](lib/core/src/lib/app-config/app-config.pipe.ts "Defined in app-config.pipe.ts")
# [App Config Pipe](../../../lib/core/src/lib/app-config/app-config.pipe.ts "Defined in app-config.pipe.ts")
Retrieves values from the application configuration file directly.

View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-08-05
---
# [Decimal Number Pipe](lib/core/src/lib/pipes/decimal-number.pipe.ts "Defined in decimal-number.pipe.ts")
# [Decimal Number Pipe](../../../lib/core/src/lib/pipes/decimal-number.pipe.ts "Defined in decimal-number.pipe.ts")
Transforms a number to have a certain amount of digits in its integer part and also in its decimal part.
@@ -15,7 +15,7 @@ Transforms a number to have a certain amount of digits in its integer part and a
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| digitsInfo | [`DecimalNumberModel`](lib/core/src/lib/models/decimal-number.model.ts) | | A format to apply to the date value. [Date Pipe Formats.](https://angular.io/api/common/DatePipe#custom-format-options) |
| digitsInfo | [`DecimalNumberModel`](../../../lib/core/src/lib/models/decimal-number.model.ts) | | A format to apply to the date value. [Date Pipe Formats.](https://angular.io/api/common/DatePipe#custom-format-options) |
| locale | string | 'en-US' | A locale id for the locale format rules to use. |
## Details
@@ -30,7 +30,7 @@ This pipe transforms a given number so it follows the set configuration for the
}
```
You can also overwrite this config by passing a [`DecimalNumberModel`](lib/core/src/lib/models/decimal-number.model.ts) as an argument for this pipe.
You can also overwrite this config by passing a [`DecimalNumberModel`](../../../lib/core/src/lib/models/decimal-number.model.ts) as an argument for this pipe.
The number can be also localized so it applies commas and dots in the right place depending on the locale id in use.

View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-14
---
# [File Size pipe](lib/core/src/lib/pipes/file-size.pipe.ts "Defined in file-size.pipe.ts")
# [File Size pipe](../../../lib/core/src/lib/pipes/file-size.pipe.ts "Defined in file-size.pipe.ts")
Converts a number of bytes to the equivalent in KB, MB, etc.

View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-27
---
# [Format Space pipe](lib/core/src/lib/pipes/format-space.pipe.ts "Defined in format-space.pipe.ts")
# [Format Space pipe](../../../lib/core/src/lib/pipes/format-space.pipe.ts "Defined in format-space.pipe.ts")
Replaces all the white space in a string with a supplied character.

View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-12
---
# [Full name pipe](lib/core/src/lib/pipes/full-name.pipe.ts "Defined in full-name.pipe.ts")
# [Full name pipe](../../../lib/core/src/lib/pipes/full-name.pipe.ts "Defined in full-name.pipe.ts")
Joins the first and last name properties from a [`UserProcessModel`](../../core/models/user-process.model.md) object into a single string.

View File

@@ -4,7 +4,7 @@ Added: v3.3.0
Status: Active
---
# [Localized Date pipe](lib/core/src/lib/pipes/localized-date.pipe.ts "Defined in localized-date.pipe.ts")
# [Localized Date pipe](../../../lib/core/src/lib/pipes/localized-date.pipe.ts "Defined in localized-date.pipe.ts")
Converts a date to a given format and locale.

View File

@@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active
---
# [Mime Type Icon pipe](lib/core/src/lib/pipes/mime-type-icon.pipe.ts "Defined in mime-type-icon.pipe.ts")
# [Mime Type Icon pipe](../../../lib/core/src/lib/pipes/mime-type-icon.pipe.ts "Defined in mime-type-icon.pipe.ts")
Retrieves an icon to represent a MIME type.

View File

@@ -4,9 +4,9 @@ Added: v3.2.0
Status: Active
---
# [Multi Value Pipe](lib/core/src/lib/pipes/multi-value.pipe.ts "Defined in multi-value.pipe.ts")
# [Multi Value Pipe](../../../lib/core/src/lib/pipes/multi-value.pipe.ts "Defined in multi-value.pipe.ts")
Takes an array of strings and turns it into one string where items are separated by a separator. The default separator applied to the list is the comma ```, ``` however, you can set your own separator in the params of the pipe.
Takes an array of strings and turns it into one string where items are separated by a separator. The default separator applied to the list is the comma `,` however, you can set your own separator in the params of the pipe.
## Basic Usage

View File

@@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active
---
# [Node Name Tooltip pipe](lib/content-services/src/lib/pipes/node-name-tooltip.pipe.ts "Defined in node-name-tooltip.pipe.ts")
# [Node Name Tooltip pipe](../../../lib/content-services/src/lib/pipes/node-name-tooltip.pipe.ts "Defined in node-name-tooltip.pipe.ts")
Formats the tooltip for a [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md).

View File

@@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active
---
# [Text Highlight pipe](lib/core/src/lib/pipes/text-highlight.pipe.ts "Defined in text-highlight.pipe.ts")
# [Text Highlight pipe](../../../lib/core/src/lib/pipes/text-highlight.pipe.ts "Defined in text-highlight.pipe.ts")
Adds highlighting to words or sections of text that match a search string.

View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19
---
# [Time Ago pipe](lib/core/src/lib/pipes/time-ago.pipe.ts "Defined in time-ago.pipe.ts")
# [Time Ago pipe](../../../lib/core/src/lib/pipes/time-ago.pipe.ts "Defined in time-ago.pipe.ts")
Converts a recent past date into a number of days ago.

View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-12
---
# [User Initial pipe](lib/core/src/lib/pipes/user-initial.pipe.ts "Defined in user-initial.pipe.ts")
# [User Initial pipe](../../../lib/core/src/lib/pipes/user-initial.pipe.ts "Defined in user-initial.pipe.ts")
Takes the name fields of a [`UserProcessModel`](../../core/models/user-process.model.md) object and extracts and formats the initials.