### Examples
We've created several demos to showcase AG Grid's rich feature set across different use cases. See them in action below, or interact with them on our [Demo](https://www.ag-grid.com/example/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github) page.
π¦ Financial Demo
Financial data example featuring live updates and sparklines:
## β‘οΈ Quick Start
AG Grid is easy to set up - all you need to do is provide your data and define your column structure.
### Installation
```sh
$ npm install --save ag-grid-vue3
```
### Setup
**1. Register Modules**
Register the `AllCommunityModule` to access all Community features:
```js
import { AllCommunityModule, ModuleRegistry } from 'ag-grid-community';
// Register all Community features
ModuleRegistry.registerModules([AllCommunityModule]);
```
βΉοΈ Note:
To minimize bundle size, only register the modules you want to use. See the Modules page for more information.
**2. Import the Vue Data Grid**
```js
```
**3. Define Rows and Columns**
```js
setup() {
// Row Data: The data to be displayed.
const rowData = ref([
{ make: "Tesla", model: "Model Y", price: 64950, electric: true },
{ make: "Ford", model: "F-Series", price: 33850, electric: false },
{ make: "Toyota", model: "Corolla", price: 29600, electric: false },
]);
// Column Definitions: Defines the columns to be displayed.
const colDefs = ref([
{ field: "make" },
{ field: "model" },
{ field: "price" },
{ field: "electric" }
]);
return {
rowData,
colDefs,
};
},
```
**4. Vue Data Grid Component**
Rows and Columns are set as ag-grid-vue component attributes. Grid height is applied through the style attribute.
```js
```
βΉοΈ Note:
For more information on building Data Grids with AG Grid, refer to our Documentation.
### Seed Projects
We also provide [Seed Projects](https://github.com/ag-grid/ag-grid-seed) to help you get started with common configurations:
## π οΈ Customisations
AG Grid is fully customisable, both in terms of appearance and functionality. There are many ways in which the grid can be customised and we provide a selection of tools to help create those customisations.
### Custom Components
You can create your own Custom Components to customise the behaviour of the grid. For example, you can customise how cells are rendered, how values are edited and also create your own filters.
There are a number of different [Component Types](https://www.ag-grid.com/vue-data-grid/components/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github) that you can provide to the grid, including:
- [Cell Component](https://www.ag-grid.com/vue-data-grid/component-cell-renderer/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github): To customise the contents of a cell.
- [Header Component](https://www.ag-grid.com/vue-data-grid/column-headers/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github): To customise the header of a column and column groups.
- [Edit Component](https://www.ag-grid.com/vue-data-grid/cell-editors/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github): To customise the editing of a cell.
- [Filter Component](https://www.ag-grid.com/vue-data-grid/component-filter/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github): For custom column filter that appears inside the column menu.
- [Floating Filter](https://www.ag-grid.com/vue-data-grid/component-floating-filter/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github): For custom column floating filter that appears inside the column menu.
- [Date Component](https://www.ag-grid.com/vue-data-grid/filter-date/#custom-selection-component?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github): To customise the date selection component in the date filter.
- [Loading Component](https://www.ag-grid.com/vue-data-grid/component-loading-cell-renderer/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github): To customise the loading cell row when using Server Side Row Model.
- [Overlay Component](https://www.ag-grid.com/vue-data-grid/overlays/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github): To customise loading and no rows overlay components.
- [Status Bar Component](https://www.ag-grid.com/vue-data-grid/status-bar/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github): For custom status bar components.
- [Tool Panel Component](https://www.ag-grid.com/vue-data-grid/component-tool-panel/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github): For custom tool panel components.
- [Tooltip Component](https://www.ag-grid.com/vue-data-grid/tooltips/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github): For custom cell tooltip components.
- [Menu Item Component](https://www.ag-grid.com/vue-data-grid/component-menu-item/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github): To customise the menu items shown in the Column and Context Menus.
To supply a custom cell renderer and filter components to the Grid, create a direct reference to your component within the `gridOptions.columnDefs` property:
```js
gridOptions = {
columnDefs: [
{
field: 'country', // The column to add the component to
cellRenderer: CountryCellRenderer, // Your custom cell component
filter: CountryFilter, // Your custom filter component
},
],
};
```
### Themes
AG Grid has 4 [themes](https://www.ag-grid.com/vue-data-grid/themes/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github), each available in `light` & `dark` modes:
Quartz
Material
Alpine
Balham
### Custom Themes
All AG Grid themes can be customised using the [Theming API](https://www.ag-grid.com/vue-data-grid/theming/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github), or you can create a new theme from scratch with the help of our [Theme Builder](https://www.ag-grid.com/theme-builder/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github) or [Figma Design System](https://www.figma.com/community/file/1360600846643230092/ag-grid-design-system).
## π Community
### Tools & Extensions
AG Grid has a large and active community who have created an [ecosystem of 3rd party tools, extensions and utilities](https://www.ag-grid.com/community/tools-extensions/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github) to help you build your next project with AG Grid, no matter which language or framework you use:
### Showcase
AG Grid is used by 100,000's of developers across the world, from almost every industry. Whilst most of these projects are private, we've curated a selection of open-source projects from different industries where household names use AG Grid, including **J.P.Morgan**, **MongoDB** and **NASA**. Visit our [Community Showcase](https://www.ag-grid.com/community/showcase/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github) page to learn more.
### Stargazers
Founded in 2016, AG Grid has seen a steady rise in popularity and is now the market leader for Data Grids:
## π€ Support
### Enterprise Support
AG Grid Enterprise customers have access to dedicated support via [ZenDesk](https://ag-grid.zendesk.com/hc/en-us), which is monitored by our engineering teams.
### Bug Reports
If you have found a bug, please report it in this repository's [issues](https://github.com/ag-grid/ag-grid/issues) section.
### Questions
Look for similar problems on [StackOverflow](https://stackoverflow.com/questions/tagged/ag-grid) using the `ag-grid` tag. If nothing seems related, post a new message there. Please do not use GitHub issues to ask questions.
### Contributing
AG Grid is developed by a team of co-located developers in London. If you want to join the team send your application to info@ag-grid.com.
## β οΈ License
`ag-grid-community` is licensed under the **MIT** license.
`ag-grid-enterprise` has a **Commercial** license.
See the [LICENSE file](./LICENSE.txt) for more info.
AG Charts
If you've made it this far, you may be interested in our latest project: [AG Charts](https://www.ag-grid.com/charts?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github) - The best Vue3 Charting library in the world.
Initially built to power [Integrated Charts](https://www.ag-grid.com/vue-data-grid/integrated-charts/?utm_source=ag-grid-vue3-readme&utm_medium=repository&utm_campaign=github) in AG Grid, we open-sourced this project in 2018. Having seen the steady rise in popularity since then, we have decided to invest in AG Charts with a dedicated Enterprise version (`ag-charts-enterprise`) in addition to our continued support of `ag-charts-community`.
Follow us to keep up to date with all the latest news from AG Grid:
React
β’
Angular
β’
Vue
β’
Python
β’
Svelte
β’
SolidJS
β’
.NET
β’
Rust
β’
Laravel
### Questions
Look for similar problems on [StackOverflow](https://stackoverflow.com/questions/tagged/ag-grid) using the `ag-grid` tag. If nothing seems related, post a new message there. Please do not use GitHub issues to ask questions.
### Contributing
AG Grid is developed by a team of co-located developers in London. If you want to join the team send your application to info@ag-grid.com.
## β οΈ License
`ag-grid-community` is licensed under the **MIT** license.
`ag-grid-enterprise` has a **Commercial** license.
See the [LICENSE file](./LICENSE.txt) for more info.
AG Charts
-black?style=for-the-badge&logo=x){kind=icon}
