@bryntum/grid-vue-3

v7.2.2

Published

10 days ago

Vue 3 wrappers for Bryntum Grid JavaScript component

0High
0Medium
0Low

mats.bryntse

rasmus.ersmarker

bryntum grid vue-3 wrapper

Vue 3 wrapper for Bryntum Grid

This package provides a wrapper that turns Bryntum Grid into a Vue 3 component, exposing configuration options, properties, features, and events.

Version Requirement

Vue: 3.2 or higher
TypeScript: 4.2 or higher
Vite 5 or higher

Package Contents

| Path | Description | |--------------|------------------------------------------------| | lib/ | Vue 3 wrapper components (BryntumGrid etc.) | | src/ | Original Vue source files | | src/*.d.ts | TypeScript type definitions |

Note: This is a wrapper package. The core @bryntum/grid package must be installed separately.

Installation

Vue 3 Wrapper

npm install @bryntum/grid-vue-3@latest

Component Package (Required)

npm install @bryntum/grid@latest

Try Bryntum Online Demos

View Online Vue Demos

Quick Start

Edit the src/App.vue file and replace the content with the following:

<script setup>
import { BryntumGrid } from '@bryntum/grid-vue-3';
import { gridProps } from './AppConfig.js';
</script>

<template>
  <bryntum-grid v-bind=gridProps />
</template>

<style lang="scss">
@import './App.scss';
</style>

Create a GridConfig.ts file in the src/ directory with the following content:

import { BryntumGridProps } from '@bryntum/grid-vue-3';

export const gridProps: BryntumGridProps = {
    columns : [
        {
            text   : 'Name',
            field  : 'name',
            flex   : 1,
            editor : {
                type     : 'textfield',
                required : true
            }
        }, {
            text  : 'Age',
            field : 'age',
            width : 100,
            type  : 'number'
        }, {
            text  : 'City',
            field : 'city',
            flex  : 1
        }, {
            text  : 'Food',
            field : 'food',
            flex  : 1
        }, {
            text     : 'Color',
            field    : 'color',
            flex     : 1,
            sortable : false,
            type     : 'color'
        }
    ],

    data : [
        { id : 1, name : 'Don A Taylor', age : 30, city : 'Moscow', food : 'Salad', color : 'Black' },
        { id : 2, name : 'John B Adams', age : 65, city : 'Paris', food : 'Bolognese', color : 'Orange' },
        { id : 3, name : 'John Doe', age : 40, city : 'London', food : 'Fish and Chips', color : 'Blue' },
        { id : 4, name : 'Maria Garcia', age : 28, city : 'Madrid', food : 'Paella', color : 'Green' },
        { id : 5, name : 'Li Wei', age : 35, city : 'Beijing', food : 'Dumplings', color : 'Yellow' },
        { id : 6, name : 'Sara Johnson', age : 32, city : 'Sydney', food : 'Sushi', color : 'Purple' },
        { id : 7, name : 'Lucas Brown', age : 22, city : 'Toronto', food : 'Poutine', color : 'Orange' },
        { id : 8, name : 'Emma Wilson', age : 27, city : 'Paris', food : 'Croissant', color : 'Pink' },
        { id : 9, name : 'Ivan Petrov', age : 45, city : 'St. Petersburg', food : 'Borscht', color : 'Grey' },
        { id : 10, name : 'Zhang Ming', age : 50, city : 'Shanghai', food : 'Hot Pot', color : 'Purple' },
        { id : 11, name : 'Sophia Martinez', age : 20, city : 'Mexico City', food : 'Tacos', color : 'Crimson' },
        { id : 12, name : 'Noah Smith', age : 55, city : 'Cape Town', food : 'Biltong', color : 'Turquoise' },
        { id : 13, name : 'Isabella Jones', age : 33, city : 'Rio de Janeiro', food : 'Feijoada', color : 'Magenta' },
        { id : 14, name : 'Ethan Taylor', age : 29, city : 'Chicago', food : 'Deep-Dish Pizza', color : 'Cyan' },
        { id : 15, name : 'Olivia Brown', age : 37, city : 'Berlin', food : 'Schnitzel', color : 'Maroon' },
        { id : 16, name : 'Mia Wilson', age : 26, city : 'Rome', food : 'Pasta', color : 'Olive' },
        { id : 17, name : 'Jacob Miller', age : 60, city : 'Amsterdam', food : 'Stroopwafel', color : 'Lime' },
        { id : 18, name : 'Chloe Davis', age : 23, city : 'Los Angeles', food : 'Burger', color : 'Teal' },
        { id : 19, name : 'Aiden Martinez', age : 48, city : 'Buenos Aires', food : 'Asado', color : 'Violet' },
        { id : 20, name : 'Liam Lee', age : 38, city : 'Seoul', food : 'Kimchi', color : 'Indigo' },
        { id : 21, name : 'Sophie Kim', age : 21, city : 'Tokyo', food : 'Ramen', color : 'Pink' },
        { id : 22, name : 'Alexander Nguyen', age : 41, city : 'Hanoi', food : 'Pho', color : 'Coral' },
        { id : 23, name : 'Ella Patel', age : 19, city : 'Mumbai', food : 'Curry', color : 'Amber' },
        { id : 24, name : 'James O Connor', age : 34, city : 'Dublin', food : 'Irish Stew', color : 'Green' },
        { id : 25, name : 'Isabelle Chen', age : 31, city : 'Hong Kong', food : 'Dim Sum', color : 'Brown' }
    ]
};

Lastly, add some styling to your src/style.css:

/* FontAwesome is used for icons */
@import '@bryntum/grid/fontawesome/css/fontawesome.css';
@import '@bryntum/grid/fontawesome/css/solid.css';
/* Structural CSS */
@import "@bryntum/grid/grid.css";
/* Bryntum theme of your choice */
@import "@bryntum/grid/svalbard-light.css";

Integration Guide

For details on installing and using this package, see the Vue Integration Guide.

Wrappers

Vue wrappers encapsulate Bryntum components as native Vue components, exposing all configuration options, properties, features, and events through Vue-familiar patterns like props, events, and slots.

Visit Wrappers documentation for the complete list of available wrapper components.

Features

Features are optional modules that extend Bryntum Grid functionality. Each feature is suffixed with Feature and can be enabled and configured through standard Vue props.

Visit Features documentation for the complete list of available features and their configuration options.

Explore All Bryntum Products

Bryntum Grid - High-performance data grid
Bryntum Scheduler - Resource scheduling component
Bryntum Scheduler Pro - Advanced scheduling with dependencies
Bryntum Gantt - Project planning and management
Bryntum Calendar - Full-featured calendar component
Bryntum TaskBoard - Kanban-style task management

Explore our comprehensive collection of demos:

| Product | JavaScript | React | Vue | Angular | |-------------------|:------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------:|:----------------------------------------------------------------------:|:------------------------------------------------------------------------------:| | Grid | Grid JavaScript demos | Grid React demos | Grid Vue demos | Grid Angular demos | | Scheduler | Scheduler JavaScript demos | Scheduler React demos | Scheduler Vue demos | Scheduler Angular demos | | Scheduler Pro | Scheduler Pro JavaScript demos | Scheduler Pro React demos | Scheduler Pro Vue demos | Scheduler Pro Angular demos | | Gantt | Gantt JavaScript demos | Gantt React demos | Gantt Vue demos | Gantt Angular demos | | Calendar | Calendar JavaScript demos | Calendar React demos | Calendar Vue demos | Calendar Angular demos | | TaskBoard | TaskBoard JavaScript demos | TaskBoard React demos | TaskBoard Vue demos | TaskBoard Angular demos |

Online references

License and copyright

This wrapper depends on Bryntum Grid, which is commercial software and requires a paid license. Please visit the Bryntum Grid End User License for the full text of the license.