Search results

Getting Started with Vue 3 in Vue Skeleton component

25 Jan 2023 / 3 minutes to read

This section explains how to use Skeleton component in Vue 3 application.

Prerequisites

System requirements for Syncfusion Vue UI components

Creating Vue application using Vue CLI

The easiest way to create a Vue application is to use the Vue CLI. Vue CLI versions above 4.5.0 are mandatory for creating applications using Vue 3. Use the following command to uninstall older versions of the Vue CLI.

Copied to clipboard
npm uninstall vue-cli -g

Use the following commands to install the latest version of Vue CLI.

Copied to clipboard
npm install -g @vue/cli

npm install -g @vue/cli-init

Create a new project using the command below.

Copied to clipboard
vue create quickstart

cd quickstart

Initiating a new project prompts us to choose the type of project to be used for the current application. Select the option Default (Vue 3) from the menu.

Reference

Adding Syncfusion Skeleton package in the application

Syncfusion Vue packages are maintained in the npmjs.com registry. The Skeleton component will be used in this example. To install it use the following command.

Copied to clipboard
npm install @syncfusion/ej2-vue-notifications --save

Adding CSS reference for Syncfusion Vue Skeleton component

Import the needed css styles for the Skeleton component along with dependency styles in the <style> section of the src/App.vue file as follows.

Copied to clipboard
<style>
@import "../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-notifications/styles/material.css";
</style>

Adding Syncfusion Vue Skeleton component in the application

You have completed all the necessary configurations needed for rendering the Syncfusion Vue component. Now, you are going to add the Skeleton component using following steps.

  1. Import the Skeleton component in the <script> section of the src/App.vue file.
Copied to clipboard
  <script>
  import { SkeletonComponent } from "@syncfusion/ej2-vue-notifications";
  </script>
  1. Register the Skeleton component which is used in this example.
Copied to clipboard
  import { SkeletonComponent } from '@syncfusion/ej2-vue-notifications';
  // Component registration
  export default {
     name: "App",
     components: {
        'ejs-skeleton': SkeletonComponent
     }
  }
  1. Add the component definition in template section.
Copied to clipboard
<template>
   <div id='element'>
       <ejs-skeleton height='15px'></ejs-skeleton>
   </div>
</template>

Above is the Skeleton component definition, with content property binding definition.

  1. Summarizing the above steps, update the src/App.vue file with following code.
Copied to clipboard
<template>
<div id='element'>
    <ejs-skeleton height='15px'></ejs-skeleton>
</div>
</template>

<script>
    import { SkeletonComponent } from '@syncfusion/ej2-vue-notifications';
    // Component registration
    export default {
        name: "App",
        components: {
            'ejs-skeleton': SkeletonComponent
        }
    }
</script>
<style>
    @import "../node_modules/@syncfusion/ej2-base/styles/material.css";
    @import "../node_modules/@syncfusion/ej2-vue-notifications/styles/material.css";
</style>

Output

Skeleton Shapes

The shape property can be used to display skeleton in different shapes like circle, square, rectangle and text.

Copied to clipboard
<template>
<div class="control-section">
    <div style="width: 200px">
        <ejs-skeleton style="margin-right: 30px" shape="Circle" width="48px"></ejs-skeleton>
        <ejs-skeleton shape="Square" width="48px"></ejs-skeleton>
        <br /><br />
        <ejs-skeleton height="15px"></ejs-skeleton>
        <br /><br />
        <ejs-skeleton shape="Rectangle" height='50px'></ejs-skeleton>
    </div>
</div>
</template>

<script>
import { SkeletonComponent } from '@syncfusion/ej2-vue-notifications';
// Component registration
export default {
    name: "App",
    components: {
        'ejs-skeleton': SkeletonComponent
    }
}
</script>

<style>
@import "../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-notifications/styles/material.css";

.control-section {
    padding: 20px;
}
</style>

Output

Running the application

Run the application using the following command.

Copied to clipboard
npm run serve

Web server will be initiated, Open the quick start app in the browser at port localhost:8080.