Vue UI Components Documentation

jQWidgets for Vue · version 27 · Vue 3 and script setup

Vue UI components for data-heavy apps

Grids that stay fast with 100,000 rows, a scheduler, Gantt and Kanban boards, 30+ chart types, pivot tables and every editor a business app needs: 63 Vue 3 components for script setup, with props, events and v-model.

Get started Explore 800+ live demos
  • 63components
  • 800+live demos with source
  • 40+themes, light and dark
  • 4frameworks, one API

All 63 components, by category

Why teams build with jQWidgets #

  • Fast with big data #

    Virtual scrolling, paging and server-side modes keep a grid of 100,000 rows responsive, and live cell updates take milliseconds.

    The 100,000-row tutorial
  • One API, four frameworks #

    The same components and options in JavaScript, Angular, React and Vue, so what you learn carries over: JavaScript, React, Angular.

  • Written for Vue 3 #

    Components for script setup with props, events and v-model, in a Vite project with TypeScript.

    Set up a Vite project
  • Themes, light and dark #

    Fluent, Material, Tailwind and 35+ more themes, set per component, or your own from the Theme Builder.

    Theme Builder
  • Accessible and accountable #

    ARIA roles and keyboard navigation in the components; a published security policy, advisories and a software bill of materials.

    Security and compliance
  • Ready for AI #

    An AI-assisted Grid and a Chat component for your apps, and an MCP server and llms.txt that let coding assistants write correct jQWidgets code.

    The MCP server

Getting started #

This page shows the current setup: a Vite project created with create-vue, Vue 3.5 and <script setup>. Vue CLI, which older versions of this page used, is in maintenance mode and has been replaced by create-vue.

Before you start #

Install Node.js 22 LTS or later. Check the version with:

node -v

1. Create the project #

npm create vue@latest asks a few questions. Answer Yes to TypeScript; the other features are optional. Then install jQWidgets, which contains the library, the themes and the Vue 3 components:

npm create vue@latest my-app
cd my-app
npm install
npm install jqwidgets-scripts

2. Load the styles #

Replace src/main.ts. Every component needs jqx.base.css; the second import is the theme:

import { createApp } from 'vue';
import 'jqwidgets-scripts/jqwidgets/styles/jqx.base.css';
import 'jqwidgets-scripts/jqwidgets/styles/jqx.tailwind-blue-dark.css';
import App from './App.vue';

createApp(App).mount('#app');

The Vue components are plain JavaScript files, so TypeScript's strict mode rejects importing them (TS7016: Could not find a declaration file). Declare them once in a new file, src/jqwidgets-vue3.d.ts:

// src/jqwidgets-vue3.d.ts
declare module 'jqwidgets-scripts/jqwidgets-vue3/*.vue' {
    import type { DefineComponent } from 'vue';
    const component: DefineComponent<Record<string, any>, Record<string, any>, any>;
    export default component;
}

3. Use a component #

Components are in jqwidgets-scripts/jqwidgets-vue3, one file per widget, named vue_<widget>.vue. Replace src/App.vue:

<script setup lang="ts">
import { ref } from 'vue';
import JqxBarGauge from 'jqwidgets-scripts/jqwidgets-vue3/vue_jqxbargauge.vue';

const values = ref([10, 20, 30, 40, 50]);

function randomize() {
    values.value = values.value.map(() => Math.round(Math.random() * 60));
}
</script>

<template>
    <main>
        <JqxBarGauge :width="600" :height="600" :max="60" colorScheme="scheme02" :values="values" />
        <button type="button" @click="randomize">New values</button>
    </main>
</template>

Start the development server and open http://localhost:5173:

npm run dev

Events #

Component events have the same names as the widget events in the JavaScript API. Listen to them with @, like any Vue event:

<script setup lang="ts">
import JqxBarGauge from 'jqwidgets-scripts/jqwidgets-vue3/vue_jqxbargauge.vue';

const values = [10, 20, 30, 40, 50];

function onDrawEnd(event: Event) {
    console.log('The Bar Gauge finished drawing', event);
}
</script>

<template>
    <JqxBarGauge :width="600" :height="600" :values="values" @drawEnd="onDrawEnd" />
</template>

Properties and methods #

Widget options are props. Bind them with : to reactive values: when a value changes, the component passes it to the widget. To call a method such as refresh() or val(), put a template ref on the component:

<script setup lang="ts">
import { onMounted, ref } from 'vue';
import JqxBarGauge from 'jqwidgets-scripts/jqwidgets-vue3/vue_jqxbargauge.vue';

// The methods this page calls on the component.
interface BarGaugeMethods {
    refresh: () => void;
    val: (value?: number[]) => number[];
}

const myBarGauge = ref<BarGaugeMethods | null>(null);
const values = ref([10, 20, 30, 40, 50]);

// Called for every bar; returns the bar's color.
const formatFunction = (value: number, index: number, color: string) => color;

onMounted(() => {
    console.log('Current values:', myBarGauge.value?.val());
});

function addValue() {
    values.value = [...values.value, 60];
}
</script>

<template>
    <JqxBarGauge ref="myBarGauge" :width="600" :height="600" :values="values" :formatFunction="formatFunction" />
    <button type="button" @click="addValue">Add a value</button>
    <button type="button" @click="myBarGauge?.refresh()">Refresh</button>
</template>

Every component also has setOptions, which changes several options at once:

myBarGauge.value?.setOptions({ width: 500, values: [50, 70, 90] });

(Add setOptions: (options: object) => void to the interface to call it from TypeScript.)

Two-way data binding #

Input components support v-model, so a ref always holds the widget's current value:

<script setup lang="ts">
import { ref } from 'vue';
import JqxInput from 'jqwidgets-scripts/jqwidgets-vue3/vue_jqxinput.vue';

const country = ref('');
const countries = ['Argentina', 'Australia', 'Austria', 'Belgium', 'Brazil', 'Bulgaria', 'Canada', 'France', 'Germany', 'Japan', 'Mexico', 'Spain', 'Sweden', 'United Kingdom', 'United States'];
</script>

<template>
    <p>The value is: {{ country }}</p>
    <JqxInput v-model="country" :width="200" :height="30" :source="countries" placeHolder="Type a country" />
</template>

v-model works with these components: JqxCalendar, JqxCheckBox, JqxComboBox, JqxComplexInput, JqxDateTimeInput, JqxDropDownList, JqxFormattedInput, JqxInput, JqxListBox, JqxMaskedInput, JqxNumberInput, JqxPasswordInput, JqxRadioButton, JqxRating, JqxSlider, JqxSwitchButton and JqxTextArea.

Documentation for AI assistants #

Every page of this documentation has a Markdown copy (the Markdown button at the top of a page), and the whole documentation is one file at llms-full.txt, with an index at llms.txt. Point your assistant there, or use Ask AI on any page.

Next steps #

Every component has a live example with source code at jqwidgets.com/vue.

Components #

Every Vue component, by category. Each one links to its getting-started guide and its API reference.

Data Grids and Tables #

Charts and Visualization #

Scheduling and Planning #

AI and Collaboration #

Editors and Inputs #

Lists and Selection #

Layout and Containers #

Popups and Feedback #

Data and Utilities #