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.
- 63components
- 800+live demos with source
- 40+themes, light and dark
- 4frameworks, one API
Data GridSort, filter, group, edit and export
SchedulerDay to timeline views
Charts30+ chart types
GanttTasks and dependencies
KanbanDrag-and-drop boards
Pivot GridTotals by rows and columns
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 tutorialOne 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 projectThemes, light and dark #
Fluent, Material, Tailwind and 35+ more themes, set per component, or your own from the Theme Builder.
Theme BuilderAccessible and accountable #
ARIA roles and keyboard navigation in the components; a published security policy, advisories and a software bill of materials.
Security and complianceReady 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 #
- Vite and Vue 3 with <script setup>
- Add a Grid to a Vue 3 app
- Add a Chart to a Vue 3 app
- What the jQWidgets Vue starter project contains
- Load Grid pages from a Node.js API
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 #
- jqxGrid
Data grid with sorting, filtering, grouping, paging, editing, aggregates, export and virtual scrolling for large datasets.
- jqxPivotGrid
Pivot table for summarising data by rows, columns and aggregate functions, with a drag-and-drop designer.
- jqxTreeGrid
Hierarchical grid that shows tree data in columns, with load-on-demand, editing, aggregates and export.
- jqxDataTable
Lightweight table built on native table markup, with paging, sorting, filtering, grouping and editing.
Charts and Visualization #
- jqxChart
Over 30 chart types (line, area, bar, pie, donut, range, financial, polar and spider) rendered as SVG or HTML5 Canvas.
- jqxGauge
Radial and linear gauges with ranges, ticks, labels and animated pointers.
- jqxBulletChart
Compact bullet chart that shows a measure against a target and qualitative ranges.
- jqxHeatMap
Heat map that colours a matrix of values on a configurable colour scale.
- jqxTreeMap
Treemap that shows hierarchical data as nested rectangles sized and coloured by value.
- jqxRangeSelector
Range slider over a numeric or date scale, often used to filter a chart or grid.
- jqxBarcode
Barcode generator for common 1D symbologies, rendered as SVG or Canvas.
- jqxQRcode
QR code generator with error-correction levels, colours and an embedded logo.
Scheduling and Planning #
- jqxScheduler
Calendar scheduler with day, week, month, timeline and agenda views, recurring appointments and resources.
- jqxGantt
Gantt chart with tasks, dependencies, milestones, resources and a task tree.
- jqxKanban
Kanban board with columns, swimlanes, drag-and-drop cards and templates.
AI and Collaboration #
- jqxChat
Chat UI with message list, typing indicator, attachments and AI assistant integration.
Editors and Inputs #
- jqxEditor
WYSIWYG HTML editor with a configurable toolbar, source view and paste cleanup.
- jqxForm
Form built from a JSON template of fields, groups and buttons, with layout and validation.
- jqxDateTimeInput
Masked date and time input with a drop-down calendar and range selection.
- jqxNumberInput
Numeric input with spin buttons, currency and percentage modes and min/max limits.
- jqxMaskedInput
Input that restricts typing to a mask such as phone numbers, zip codes or IDs.
- jqxFormattedInput
Numeric input for binary, octal, decimal and hexadecimal values.
- jqxPasswordInput
Password input with a show-password toggle and a strength indicator.
- jqxSlider
Horizontal or vertical slider with a single value or a range, ticks and tooltips.
- jqxFileUpload
File upload with multiple files, progress, validation and localisation.
Lists and Selection #
- jqxDropDownList
Drop-down list with check boxes, grouping, templates and filtering.
- jqxComboBox
Editable drop-down with auto-complete, multi-select tokens and remote search.
- jqxListBox
List with single or multiple selection, check boxes, grouping, filtering and drag-and-drop.
- jqxTree
Tree view with check boxes, drag-and-drop, load-on-demand and keyboard navigation.
Navigation and Menus #
- jqxTabs
Tabs with scrolling, closable and reorderable tabs, and lazy content loading.
- jqxMenu
Horizontal, vertical and context menus with nested submenus and keyboard support.
- jqxToolBar
Toolbar that holds buttons, inputs and drop-downs and collapses overflowing items into a menu.
Layout and Containers #
- jqxDockingLayout
Layout whose panels can be docked, floated and rearranged by drag-and-drop.
- jqxDocking
Dashboard of windows that can be dragged between columns, collapsed and closed.
- jqxResponsivePanel
Side panel that collapses into a toggle button on small screens.
Popups and Feedback #
- jqxWindow
Dialog window that can be modal, dragged, resized, collapsed and animated.