mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-3745] Added docs for the new pipes (#4178)
* [ADF-3745] Added docs for the new pipes * [ADF-3745] Added cont services readme file * [ADF-3745] Added group initial pipe to type name exceptions
This commit is contained in:
committed by
Eugenio Romano
parent
74475dbd42
commit
fdded83699
@@ -81,7 +81,7 @@ for more information about installing and using the source code.
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| _File upload error pipe_ | _Not currently documented_ | [Source](../../lib/content-services/upload/pipes/file-upload-error.pipe.ts) |
|
||||
| [File upload error pipe](file-upload-error.pipe.md) | Converts an upload error code to an error message. | [Source](../../lib/content-services/upload/pipes/file-upload-error.pipe.ts) |
|
||||
|
||||
## Services
|
||||
|
||||
|
34
docs/content-services/file-upload-error.pipe.md
Normal file
34
docs/content-services/file-upload-error.pipe.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
Title: File upload error pipe
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-01-17
|
||||
---
|
||||
|
||||
# [File upload error pipe](../../lib/content-services/upload/pipes/file-upload-error.pipe.ts "Defined in file-upload-error.pipe.ts")
|
||||
|
||||
Converts an upload error code to an error message.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
<!-- {% raw %} -->
|
||||
|
||||
```HTML
|
||||
<div>
|
||||
Upload failed: {{ errorCode | adfFileUploadError }}
|
||||
</div>
|
||||
```
|
||||
|
||||
<!-- {% endraw %} -->
|
||||
|
||||
## Details
|
||||
|
||||
The pipe takes an upload error code (eg, from the `error` event of one of the
|
||||
upload components) and converts it to a human-readable message. The message is
|
||||
automatically translated to the user's chosen language.
|
||||
|
||||
## See also
|
||||
|
||||
- [File uploading dialog component](../content-services/file-uploading-dialog.component.md)
|
||||
- [Upload drag area component](../content-services/upload-drag-area.component.md)
|
||||
- [Upload button component](../content-services/upload-button.component.md)
|
@@ -39,3 +39,4 @@ This component should be used in combination with the
|
||||
|
||||
- [Upload button component](upload-button.component.md)
|
||||
- [Upload drag area component](upload-drag-area.component.md)
|
||||
- [File upload error pipe](../content-services/file-upload-error.pipe.md)
|
||||
|
@@ -84,3 +84,4 @@ export class MyComponent {
|
||||
## See also
|
||||
|
||||
- [Upload Version Button component](upload-version-button.component.md)
|
||||
- [File upload error pipe](../content-services/file-upload-error.pipe.md)
|
||||
|
@@ -19,6 +19,7 @@ Adds a drag and drop area to upload files to ACS.
|
||||
- [Details](#details)
|
||||
- [Intercepting uploads](#intercepting-uploads)
|
||||
- [Example](#example)
|
||||
- [See also](#see-also)
|
||||
|
||||
## Basic Usage
|
||||
|
||||
@@ -134,3 +135,9 @@ export class MyComponent {
|
||||
|
||||
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.
|
||||
|
||||
## See also
|
||||
|
||||
- [File uploading dialog component](../content-services/file-uploading-dialog.component.md)
|
||||
- [Upload button component](../content-services/upload-button.component.md)
|
||||
- [File upload error pipe](../content-services/file-upload-error.pipe.md)
|
||||
|
Reference in New Issue
Block a user