Are You Giving Out the Wrong Signal?

Free AI web copilot to create summaries, insights and extended knowledge, download it at here

7759

Abstract

component template how the upload blue button and the invisible file input are linked. When the user clicks on the blue button, a click handler triggers the file input via <code>fileUpload.click()</code>.The user will then choose a file from the file upload dialog, and the <code>change</code> event will be triggered and handled by <code>onFileSelected()</code>.<h1 id="7571">Uploading a file to the backend using the Angular HTTP Client</h1>Let’s now have a look at our component class and the implementation of <code>onFileSelected()</code>:<div id="98fa"><pre>@Component({ selector: 'file-upload', templateUrl: "file-upload.component.html", styleUrls: ["file-upload.component.scss"] }) export class FileUploadComponent {

fileName = <span class="hljs-string">''</span>;

<span class="hljs-title function_">constructor</span>(<span class="hljs-params"><span class="hljs-keyword">private</span> http: HttpClient</span>) {}

<span class="hljs-title function_">onFileSelected</span>(<span class="hljs-params">event</span>) {

    <span class="hljs-keyword">const</span> <span class="hljs-attr">file</span>:<span class="hljs-title class_">File</span> = event.<span class="hljs-property">target</span>.<span class="hljs-property">files</span>[<span class="hljs-number">0</span>];

    <span class="hljs-keyword">if</span> (file) {

        <span class="hljs-variable language_">this</span>.<span class="hljs-property">fileName</span> = file.<span class="hljs-property">name</span>;

        <span class="hljs-keyword">const</span> formData = <span class="hljs-keyword">new</span> <span class="hljs-title class_">FormData</span>();

        formData.<span class="hljs-title function_">append</span>(<span class="hljs-string">"thumbnail"</span>, file);

        <span class="hljs-keyword">const</span> upload$ = <span class="hljs-variable language_">this</span>.<span class="hljs-property">http</span>.<span class="hljs-title function_">post</span>(<span class="hljs-string">"/api/thumbnail-upload"</span>, formData);

        upload$.<span class="hljs-title function_">subscribe</span>();
    }
}

}</pre></div>Here is what is going in this component:<ul><li>we are getting a reference to the files that the user selected by accessing the <code>event.target.files</code> property.</li><li>we then build a form payload by using the <code>FormData</code> API. This is a standard browser API, it's not Angular-specific.</li><li>we then use the Angular HTTP client to create an HTTP request and send the file to the backend</li></ul>At this point, we would already have a working file upload component. But we want to take this component one step further. We want to be able to display a progress indicator to the user, and also support upload cancelation.<h1 id="2e9b">How to Display a File Upload Progress Indicator</h1>We are going to add a few more elements to the UI of our file upload component. Here is the final version of the file upload component template:<div id="2cff"><pre><input type="file" class="file-input" [accept]="requiredFileType" (change)="onFileSelected($event)" #fileUpload>

<span class="hljs-tag">&lt;<span class="hljs-name">button</span> <span class="hljs-attr">mat-mini-fab</span> <span class="hljs-attr">color</span>=<span class="hljs-string">"primary"</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"upload-btn"</span>
  (<span class="hljs-attr">click</span>)=<span class="hljs-string">"fileUpload.click()"</span>&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">mat-icon</span>&gt;</span>attach_file<span class="hljs-tag">&lt;/<span class="hljs-name">mat-icon</span>&gt;</span>

<span class="hljs-tag">&lt;/<span class="hljs-name">button</span>&gt;</span>

</div>

<mat-progress-bar class="progress-bar" mode="determinate" [value]="uploadProgress" *ngIf="uploadProgress">

</mat-progress-bar>

<mat-icon class="cancel-upload" (click)="cancelUpload()" *ngIf="uploadProgress">delete_forever</mat-icon>

</div></pre></div>The two main elements that we have added to the UI are:<ul><li>An Angular Material progress bar, which is visible only while the file upload is still in progress.</li><li>A cancel upload button, also only visible when an upload is still ongoing</li></ul><h2 id="8e22">How to know how much of the file has been uploaded?</h2>The way that we implement the progress indicator, is by using the <code>reportProgress</code> feature of the Angular HTTP client.With this feature, we can get notified of the progress of a file upload via multiple events emitted by the HTTP Observable.To see it in action, let’s have a look at the final version of the file upload component class, with all its features implemented:<div id="88a0"><pre>@Component({ selector: 'file-upload', templateUrl: "file-upload.component.html", styleUrls: ["file-upload.component.scss"] }) export class FileUploadComponent {

<span class="hljs-meta">@Input</span>()
<span class="hljs-attr">requiredFileType</span>:<span class="hljs-built_in">string</span>;

fileName = <span class="hljs-string">''</span>;
<span class="hljs-attr">uploadProgress</span>:<span class="hljs-built_in">number</span>;
<span class="hljs-attr">uploadSub</span>: <span class="hljs-title class_">Subscription</span>;

<span class="hljs-title function_">constructor</span>(<span class="hljs-

Options

params">private http: HttpClient) {}

<span class="hljs-title function_">onFileSelected</span>(<span class="hljs-params">event</span>) {
    <span class="hljs-keyword">const</span> <span class="hljs-attr">file</span>:<span class="hljs-title class_">File</span> = event.<span class="hljs-property">target</span>.<span class="hljs-property">files</span>[<span class="hljs-number">0</span>];
  
    <span class="hljs-keyword">if</span> (file) {
        <span class="hljs-variable language_">this</span>.<span class="hljs-property">fileName</span> = file.<span class="hljs-property">name</span>;
        <span class="hljs-keyword">const</span> formData = <span class="hljs-keyword">new</span> <span class="hljs-title class_">FormData</span>();
        formData.<span class="hljs-title function_">append</span>(<span class="hljs-string">"thumbnail"</span>, file);

        <span class="hljs-keyword">const</span> upload$ = <span class="hljs-variable language_">this</span>.<span class="hljs-property">http</span>.<span class="hljs-title function_">post</span>(<span class="hljs-string">"/api/thumbnail-upload"</span>, formData, {
            <span class="hljs-attr">reportProgress</span>: <span class="hljs-literal">true</span>,
            <span class="hljs-attr">observe</span>: <span class="hljs-string">'events'</span>
        })
        .<span class="hljs-title function_">pipe</span>(
            <span class="hljs-title function_">finalize</span>(<span class="hljs-function">() =&gt;</span> <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">reset</span>())
        );
      
        <span class="hljs-variable language_">this</span>.<span class="hljs-property">uploadSub</span> = upload$.<span class="hljs-title function_">subscribe</span>(<span class="hljs-function"><span class="hljs-params">event</span> =&gt;</span> {
          <span class="hljs-keyword">if</span> (event.<span class="hljs-property">type</span> == <span class="hljs-title class_">HttpEventType</span>.<span class="hljs-property">UploadProgress</span>) {
            <span class="hljs-variable language_">this</span>.<span class="hljs-property">uploadProgress</span> = <span class="hljs-title class_">Math</span>.<span class="hljs-title function_">round</span>(<span class="hljs-number">100</span> * (event.<span class="hljs-property">loaded</span> / event.<span class="hljs-property">total</span>));
          }
        })
    }
}

cancelUpload() { this.uploadSub.unsubscribe(); this.reset(); }

reset() { this.uploadProgress = null; this.uploadSub = null; } }</pre></div>As we can see, we have set the <code>reportProgress</code> property to true in our HTTP call, and we have also set the <code>observe</code> property to the value <code>events</code>.This means that, as the POST call continues, we are going to receive event objects reporting the progress of the HTTP request.These events will be emitted as values of the <code>http $</code> Observable, and come in different types:<ul><li>events of type <code>UploadProgress</code> report the percentage of the file that has already been uploaded</li><li>events of types <code>Response</code> report that the upload has been completed</li></ul>Using the events of type <code>UploadProgress</code>, we are saving the ongoing upload percentage in a member variable <code>uploadProgress</code>, which we then use to update the value of the progress indicator bar.When the upload either completes or fails, we need to hide the progress bar from the user.We can make sure that we do so by using the RxJs <code>finalize</code> operator, which is going to call the <code>reset()</code> method in both cases: upload success or failure.<h1 id="29cb">How to Cancel an Ongoing File Upload</h1>In order to support file upload cancellation, all we have to is keep a reference to the RxJs Subscription object that we get when the <code>http$ </code> Observable gets subscribed to.In our component, we store this subscription object in the <code>uploadSub</code> member variable.While the upload is still in progress, the user might decide to cancel it by clicking on the cancel button. Then the <code>cancelUpload()</code> upload method is going to get triggered and the HTTP request can be canceled by unsubscribing from the <code>uploadSub</code> subscription.This unsubscription will trigger the immediate cancelation of the ongoing file upload.<h1 id="9aad">How to accept only files of a certain type</h1>In the final version of our file upload component, we can require the user to upload a file of a certain type, by using the <code>requiredFileType</code> property:<div id="8c53"><pre><file-upload requiredFileType="image/png"></file-upload></pre></div>This property is then passed directly to the <code>accept</code> property of the file input in the file upload template, forcing the user to select a png file from the file upload dialog.<h1 id="a737">How to Upload Multiple Files</h1>By default, the browser file selection dialog will allow the user to select only one file for upload.But using the <code>multiple</code> property, we can allow the user to select multiple files instead:<div id="af5a"><pre><input type="file" class="file-upload" multiple></pre></div>Notice that this would need a completely different UI than the one that we have built. A styled upload button with a progress indicator only works well for the upload of a single file.For a multi-file upload scenario, there are a variety of UIs that could be built: a floating dialog with the upload progress of all files, etc.<h1 id="f2f4">Summary</h1>The best way to handle file upload in Angular is to build one or more custom components, depending on the supported upload scenarios.A file upload component needs to contain internally an HTML input of type file, that allows the user to select one or more files from the file system.This file input should be hidden from the user as it’s not styleable and replaced by a more user-friendly UI.Using the file input in the background, we can get a reference to the file via the <code>change</code> event, which we can then use to build an HTTP request and send the file to the backend.Also, if you have some questions or comments please let me know in the comments below and I will get back to you.</article></body>

AUTHENTICITY

Are You Giving Out the Wrong Signal?

3 Tips For Living an Authentic Life and Staying True To Yourself

It comes down to this: Are you willing to trade your truth for another’s vision?

We all want others to like us.

How Clearing the Trappings Of My Past Opened the Door to Happiness

Life is so much more — especially in my mind.

Who Are You Now That You’ve Grown Up?

It’s not too late to choose your own path to happiness.