Skip to main content

Scratch Card Integration In Vuejs Application Using vue-scratchable Plugin

In this article, we will learn about scratch card integration in the vuejs application using a 'vue-scratchable' plugin.

Create A Vuejs Sample Application:

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-scratchable Npm Package:

Command To Install Scratch Card Package:
npm i vue-scratchable

Register Scratch Component Globally:

Now let's register the 'vue-scratchable' library component globally by importing in main.js(entry file).
src/main.js:
import Vue from 'vue'
import App from './App.vue'
import VueScratchable from 'vue-scratchable';

Vue.component('vue-scratchable', VueScratchable);
Vue.config.productionTip = false

new Vue({
  render: h => h(App),
}).$mount('#app')
  • (Line: 3) Imported 'vue-scratchable' library.
  • (Line: 5) Registered 'VueScratchable' component with the 'Vue' instance globally.

Scratch Card To Display Text:

Let's begin by creating a simple scratch card which displays hidden text on scratching the card.
src/components/HelloWorld.vue:(Html Part)
<template>
  <div>
    <div class="card" style="width: 18rem;">
      <div class="card-body">
        <vue-scratchable>
          <h3>Hello Scratchable World</h3>
          <h4>Hurray! you own a car</h4>
        </vue-scratchable>
      </div>
    </div>
  </div>
</template>
  • (Line: 5) Rendered 'vue-scratchable' component.
  • (Line: 6-7) Hidden text by the scratch card.

Scratch Card To Display Image:

In the previous sample replace the text with the image tag.
src/components/HelloWorld.vue:(Html Part)
<vue-scratchable>
  <img src="https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcT1l5fR_5J_LRooC8aw-PkMF8XJWK18bdikQQ&usqp=CAU"  height="300px">
</vue-scratchable>

brushOptions Property:

The 'brushOptions' property changes the style and size of the scratch. This 'brushOptions' takes javascript object as an input parameter and this input object contains props like 'shape', 'size'. The 'shape' property to change the style of the scratch, it configuration value is like 'round', 'bevel', 'miter'. The default value of the 'shape' property is 'round'. The 'size' property to increase the width of the scratch, its default value is 20.
src/components/HelloWorld.vue:(Html Part)
<vue-scratchable
:brushOptions="brush">
  <img src="yourImageUrl"  height="300px">
</vue-scratchable>
src/components/HelloWorld.vue:(Script Part)
data(){
return{
  brush:{
	size: 30,
	shape: 'bevel'
  }
}
}
  • The 'brush' options configured with values of 'size' and 'shape' property.

hideOptions Property:

The categories in the 'hideOptions' property are like:
  • Color
  • Pattern
Color: The color category to mask the scratch content with color. This category configuration contains two properties like 'type', 'value'. The 'type' value always set to 'color' if we preferred to use the color category. The 'value' will be the color name or color hash code.
src/components/HelloWorld.vue:(Html Part)
<vue-scratchable
:brushOptions="brush"
:hideOptions="hide">
  <img src="your_image"  height="300px">
</vue-scratchable>
  • The 'hideOptions' property configured
src/components/HelloWorld.vue:(Script Part)
data(){
return{
  brush:{
	size: 30,
	shape: 'round'
  },
  hide:{
	type:"color",
	value:"yellow"
  }
}
}
  • Configured area need to be scratched will be displayed in yellow color.
Pattern: The Pattern category to mask the scratchable area with another image. This pattern category configuration properties are like 'type', 'src', 'repeat'. The 'type' property value always should be 'pattern' if want to use the pattern category. The 'src' URL of the image, this image will mask our scratch card content. The 'repeat' property provides values like 'repeat', 'repeat-x', 'repeat-y', 'no-repeat', this repeat property helps us to cover the area to mask the scratch card content.
src/components/HelloWorld.vue:(Script Part)
data(){
return{
  brush:{
	size: 30,
	shape: 'round'
  },
  hide:{
	type:"pattern",
	src:"https://media.prod.mdn.mozit.cloud/attachments/2012/07/09/222/bcf90d24adf679755d47e6e2adf31afa/Canvas_createpattern.png",
	repeat:"repeat"
  }
}
}
These are some of the key features of the vue-scratchable plugin. To explore more options for the plugin visit "https://github.com/sebastianwachter/vue-scratchable".

Wrapping Up:

Hopefully, I think this article delivered some useful information on the vue-scratchable to integrate into 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

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

GraphQL API Integration In Asp.Net Core Application

Introduction: GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data. How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions. HTTP-POST is the only Http verb recommended by the GraphQL. The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API: The main building blocks of GraphQL API is Schemas and Types.  A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc. T

ASP.NET Core Web API Versioning

Introduction: An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API. When To Use Versioning: Any API response changes. Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production. Deprecating an API which means API going to be removed or upgraded by a version within a short period. Versioning Types: Query String Versioning Url Path Versioning Media Type Versioning API Version Nuget: To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.              Install-Package Microsoft.A

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

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

Blazor Server CRUD Operations

Introduction: Blazor Server is a web framework to develop server-side single-page applications. Blazor is made up of components with the combinations on C#, Html, CSS.  Blazor Server is production-ready from the .Net Core 3.0.  Blazor Server Working Mechanism: Blazor Server is a very light-weight web development framework.  In Blazor Server, not all code gets downloaded to the client browsers. Blazor Server made of components these components can be a block of code or page with respective navigation.  Blazor server application communicates with the server with a SignalR background connection which is inbuilt functionality. Application click,  form submission, change events, application page navigation every operation is carried out by the SignalR connection by communicating with the server.  Blazor updates the Html DOM very gently on every data update without any overhead. Blazor Server application maintains a nice intelligent tree structure to update the required inform

NestJS API CRUD Operations With MongoDB

Introduction: NestJS is a framework used to develop server-side applications. NestJS built on top of Node.js frameworks like Express. It is a combination of Progressive Javascript, Object-Oriented Programming, Functional Programming, and Functional Reactive Programming. Nest CLI Installation: Using Nest CLI we are able to generate the NestJS starter project with the default template. To install Nest CLI globally over our system open command prompt and run the command               npm i -g @nestjs/cli Now create a sample project by using Nest CLI command              nest new your_project_name package.json: Now open the package.json file from the sample application created, you can observe few properties like "scripts", "dependencies", and "devDependencies". "dependencies" contains all plugins to be installed and used them to run the application. "devDependencies" contain all plugins to be installed and used them

Blazor WebAssembly Dynamic Form Validation

Introduction: In Blazor WebAssembly(client-side framework) form validation can be done with Data Annotations. Using Data Annotations we can validate form either by default validation attributes or by creating custom validation attributes. Using this Data Annotation attribute we can dynamically add or remove validation on a specific field in a form. Create Blazor WebAssembly Project: To create a Blazor WebAssembly template project need to install the latest version of VisualStudio 2019 for rich intelligence support or we can use VisualStudio code but less intelligence support from the editor.  Click here to know about Blazor WebAssembly template creation. Blazor WebAssembly is in preview mode, not yet ready for production. Create Razor Component: After creating a sample project using the Blazor WebAssembly template, in "Pages" folder add new Razor Component , name it as "UserForm.razor" Add Route: In Blazor routing can be configured using @