Skip to main content

Vuejs Application JSON To Excel Generation

In this article, we will explore JSON data to excel file generation in the Vuejs application.

An Overview On vue-json-excel:

The technique to download your JSON data as an excel file directly from the browser. The following are key options for the excel vue component.
  • data: The array of data to be exported.
  • fields: Fields inside the JSON object that you want to export. If none provided, all properties in the JSON will be exported.
  • type: Mime type[xls, csv].
  • name: Filename to export.
  • header: Title(s) for the data. Can be a string(one title) or an array of string (multiple titles).
  • footer: Footer(s) for the data. Can be a string(one footer) or an array of strings(multiple footers).
  • default-value: Use as a fallback when the row has no field values.
  • worksheet: Name of the worksheet tab.
  • fetch: Callback to fetch data before download if it's set it runs immediately function after mouse pressed and before the download process(Note: Only works if no data prop is defined).
  • before-generate: Callback to call a method right before the generate/fetch data(eg: shows loading progress).
  • before-finish: Callback to call a method right before the download box pops out(eg: hiding loading progress).

Unavoidable Excel Warning Popup:

The method implemented in this component uses HTML tables to draw the .xls files, Microsoft Excel no longer recognizes HTML as native content so a warning message will be displayed before opening the file. The content will be rendered perfectly but the message can't be avoided.

Create A VueJS Sample App:

Command To Install Vue CLI Globally On Your System:
npm run -g @vue/cli
Command To Create Vue App:
vue create your_application_name
After creating a sample application run the following command to start the application.
Command To Run Vue App:
npm run serve

Install vue-json-excel Npm Package:

Command To Install Excel Package:
npm install vue-json-excel
After successful installation package reference will be added to the package.json file.

Global Registration:

Now let's register our excel plugin in main.js(entry file)
src/main.js:
import Vue from 'vue'
import App from './App.vue'
import JsonExcel from "vue-json-excel";

Vue.component("downloadExcel", JsonExcel);

Vue.config.productionTip = false

new Vue({
  render: h => h(App),
}).$mount('#app')
  • (Line: 3) Imported 'vue-json-excel' plugin library.
  • (Line: 5) Registered json excel component to 'Vue' instance.

Excel With Simple Example:

Let's now implement a simple example to import JSON object to excel.
src/components/HelloWorld.Vue:(Html Part)
<template>
  <div>
    <download-excel :data="json_data">
      <button type="button" class="btn btn-success">Download Excel</button>
    </download-excel>
  </div>
</template>
  • Rendered 'download-excel' component.
  • (Line: 3) The 'data' property takes an array of objects(JSON data exported to excel).
src/components/HelloWorld.Vue:(Script Part)
data() {
return {
 json_data: [
   {
     name: "naveen"
    }
 ]
};
}

field Property:

The 'field' property takes a javascript object as input. The 'field' property can configure with only required columns from the JSON object to import into an excel sheet. By default, JSON object properties will be taken as heading for the excel column, but while mapping the JSON object properties to 'field' object we can change the heading names.
src/components/HelloWorld.vue:
<download-excel 
:data="json_data"
:fields="json_fields">
  <button type="button" class="btn btn-success">Download Excel</button>
</download-excel>
  • (Line: 3) Configured 'fields' option.d
src/components/HelloWorld.vue:
data() {
 return {
  json_fields:{
	"My Friends Name":"name",
	"Designation":"job"
  },
  json_data: [
	{
	  name: "naveen",
	  job: ".net developer",
	  experience: 5
	}
  ]
 };
}
The 'json_data' object contains props like 'name', 'job', 'experience' but only configured 'name', 'job' properties with 'json_fields' object . The "My Friends Name", "Designation" props in 'fields' object will be taken as column heading in the excel.

name Property:

The 'name' property to define the filename. By default plugin uses excel name as 'data'.
src/components/HelloWorld.vue:(Html Part)
<download-excel 
:data="json_data"
:fields="json_fields"
:name="fileName">
  <button type="button" class="btn btn-success">Download Excel</button>
</download-excel>
(Line: 4) The 'name' property defined.
src/components/HelloWorld.vue:(Script Part)
data() {
 return{
  fileName:"my-friends-data",
 };
}

header And footer Properties:

The 'header' and 'footer' props can define for excel.
src/components/HelloWorld.vue:(Html Part)
<download-excel 
:data="json_data"
:fields="json_fields"
:name="fileName"
:header="header"
:footer="footer">
  <button type="button" class="btn btn-success">Download Excel</button>
</download-excel>
src/components/HelloWorld.vue:(Script Part)
data() {
 return {
  header:"Welcome!",
  footer:"Good bye",
 };
}

fetch Property:

In case you need to fetch data from the server, you could use the fetch prop that allows you to define a callback function that is executed when your user clicks the download button. If you use the 'fetch' property then you should not use the 'data' property.
src/components/HelloWorld.vue:
<download-excel 
:fetch="fetchTodos">
  <button type="button" class="btn btn-success">Download Excel</button>
</download-excel>
  • (Line: 2) The 'fetch' property assigned with callback function 'fetchTodos'
src/components/HelloWorld.vue:
methods:{
async fetchTodos(){
  const response = await axios.get('https://jsonplaceholder.typicode.com/users/1/todos');
  return response.data;
}
}
  • The 'fetchTodos' callback method invokes 'Todos'(test endpoint).

before-generate And before-finish Properties:

The 'before-generate' property takes a callback function. This property can be used to write login for loading message while 'fetch' property invoking API and reading the JSON data.

The 'before-finish' property takes a callback function. This property to dispose of the loading message or notify that API invoked by the 'fetch' callback function completed.
src/components/HelloWorld.vue:(Html Part)
<download-excel 
:fetch="fetchTodos"
:before-generate="beforeGenerate"
:before-finish="beforeFinish">
  <button type="button" class="btn btn-success">Download Excel</button>
</download-excel>
src/components/HelloWorld.vue:(Script Part)
methods:{
async fetchTodos(){
  const response = await axios.get('https://jsonplaceholder.typicode.com/users/1/todos');
  return response.data;
},
beforeGenerate(){
  alert('loading')
},
beforeFinish(){
  alert('close')
}
}
That's all about some of the key options to configure the JSON to Excel generation Vuejs application. To explore more configuration and options check at "https://github.com/jecovier/vue-json-excel".

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on the JSON to Excel generation in the Vuejs application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

Popular posts from this blog

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo

Different HttpClient Techniques To Consume API Calls In Minimal API[.NET6]

In this article, we are going to implement different HttpClient techniques to consume API calls in minimal API. The different HttpClient techniques that we are going to explore are like: Register HttpClient Object Explicitly In DI(Dependency Injection Service) Named Client Type Client HttpRequestMessage Object Create A .NET6 Minimal API Project: Let's create a .Net6 Minimal API sample project to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. CLI command For Minimal API Project dotnet new webapi -minimal -o Your_Project_Name Create A Third Party API Response Model: Here I'm going to use a free third-party rest API that is "https://jsonplaceholder.typicode.com/posts". So to receive the response let's create a response model like 'Post.cs'. Program.cs:(Add Post.cs c

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl