Getting started in EJ2 TypeScript Uploader control

28 Jul 20263 minutes to read

This section explains the steps to create a simple Uploader and demonstrates the basic usage of the Uploader component using the Essential® JS 2 quickstart seed repository. This seed repository is pre-configured with the Essential® JS 2 package.

This application is integrated with the webpack.config.js configuration and uses the latest version of the webpack-cli. For more information about webpack and its features, refer to the webpack documentation.

Prerequisites

Ensure the following tools are installed on your machine:

Set up the development environment

Clone the Syncfusion® TypeScript (Essential® JS 2) quickstart project from GitHub in the command prompt:

git clone https://github.com/SyncfusionExamples/ej2-quickstart-webpack ej2-quickstart

Navigate to the project folder in the command prompt:

cd ej2-quickstart

Install Syncfusion® TypeScript Uploader packages

Syncfusion® TypeScript (Essential® JS 2) packages are available on the npmjs.com public registry. You can install all Syncfusion® TypeScript (Essential® JS 2) controls in a single @syncfusion/ej2 package or individual packages for each control.

Use the following command to install the @syncfusion/ej2-Uploader package:

npm install @syncfusion/ej2-inputs --save

Install the required npm packages:

npm install

For more information about individual packages and alternative installation methods, see the installation guide.

Import Syncfusion® CSS styles

Syncfusion® TypeScript controls provide built-in themes, which are available from the npm theme packages. Additionally, themes can be loaded via CDN or customized using the Theme Studio. For more information, refer to the themes documentation.

The quickstart application is preconfigured to use the Fluent2 theme. To install the Fluent2 theme package, use the following command:

npm install @syncfusion/ej2-fluent2-theme --save

The required styles are imported in the ~/src/styles/styles.css file, as shown below:

@import "../../node_modules/@syncfusion/ej2-fluent2-theme/styles/uploader/index.css";

Learn more about built-in themes and individual control CSS references.

Add Syncfusion® Uploader control to the application

Open the application in Visual Studio Code and add the Syncfusion® TypeScript UI controls.

In this article, the Uploader control is used as an example. Add the following Uploader element to the ~/src/index.html file.

<!DOCTYPE html>
<html lang="en">

<head>
    <title>Essential JS 2</title>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no" />
</head>

<body>
     <div id='container' style="margin:0 auto; width:300px;">
        <!--element which is going to render the Uploader-->
        <input type="file" id='uploader' />
    </div>
</body>

</html>

To render the Uploader control, add the following TypeScript code to the ~/src/app/app.ts file

import { Uploader } from '@syncfusion/ej2-inputs';

// initialize Uploader component
let uploadObject: Uploader = new Uploader();

// render initialized Uploader
uploadObject.appendTo('#uploader');

Run the application

Now, run the application in the browser using the following command.

npm start

Adding drop area

By default, the uploader component allows to upload files by drag the files from file explorer, and drop into the drop area. You can configure any other external element as drop target using dropArea property.

In the following sample, drop target is configured.

Configure asynchronous settings

The uploader component process the files to upload in Asynchronous mode by default. Define the properties saveUrl and removeUrl to handle the save and remove action as follows.

Handle success and failed upload

You can handle the success and failure actions using the success and failure  events. To handle these event, define the function and assign it to corresponding event as follows.

Registering Syncfusion license

See Also