Control the borders around rows, cells and UI elements, and the appearance of scrollbars.
Borders are controlled using theme parameters ending Border. See the Borders section of the parameters reference for the core border parameters, or search "border" in the "All Parameters" section of the Theme Builder for a full list of border parameters.
The most important parameters relating to borders are:
borderColorandborderWidth- sets the default color and width for all borders, which can be overridden for individual borders using the parameters belowrowBorderandheaderRowBorder- sets the horizontal borders between rows in the grid and headercolumnBorderandheaderColumnBorder- sets the vertical borders between columns in the grid and headerwrapperBorder- sets the border around the grid itself
Example: row borders Copy Link
const myTheme = themeQuartz.withParams({
wrapperBorder: false,
headerRowBorder: false,
rowBorder: { style: 'dotted', width: 3, color: '#9696C8' },
columnBorder: { style: 'dashed', color: '#9696C8' },
});import {
createApp,
defineComponent,
onBeforeMount,
ref,
shallowRef,
} from "vue";
import { AgGridVue } from "ag-grid-vue3";
import {
AllCommunityModule,
ColDef,
ColGroupDef,
GridApi,
GridOptions,
GridReadyEvent,
ModuleRegistry,
Theme,
enableDevValidations,
themeQuartz,
} from "ag-grid-community";
import { IOlympicData } from "./interfaces";
if (process.env.NODE_ENV !== "production") {
// Enable extended validations only for development
enableDevValidations();
}
ModuleRegistry.registerModules([AllCommunityModule]);
const myTheme = themeQuartz.withParams({
borderColor: "#9696C8",
wrapperBorder: false,
headerRowBorder: false,
rowBorder: { style: "dotted", width: 3 },
columnBorder: { style: "dashed" },
});
const VueExample = defineComponent({
template: `
<div style="height: 100%">
<ag-grid-vue
style="width: 100%; height: 100%;"
@grid-ready="onGridReady"
:theme="theme"
:columnDefs="columnDefs"
:rowData="rowData"></ag-grid-vue>
</div>
`,
components: {
"ag-grid-vue": AgGridVue,
},
setup(props) {
const gridApi = shallowRef<GridApi<IOlympicData> | null>(null);
const theme = ref<Theme | "legacy">(myTheme);
const columnDefs = ref<ColDef[]>([
{ field: "athlete", minWidth: 170 },
{ field: "age" },
{ field: "country" },
{ field: "year" },
{ field: "date" },
{ field: "sport" },
{ field: "gold" },
{ field: "silver" },
{ field: "bronze" },
{ field: "total" },
]);
const rowData = ref<IOlympicData[]>(null);
const onGridReady = (params: GridReadyEvent) => {
gridApi.value = params.api;
const updateData = (data) => (rowData.value = data);
fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
.then((resp) => resp.json())
.then((data) => updateData(data));
};
return {
gridApi,
theme,
columnDefs,
rowData,
onGridReady,
};
},
});
const app = createApp(VueExample);
app.mount("#app");
Borders between header cells Copy Link
Column borders between header cells have adjustable height, and there is also the option of styling the resize handle which is only present on resizable columns. See Customising Headers for more information.
Grand total row border Copy Link
The grandTotalRowBorder theme parameter sets the border between the grand total row and the data rows. See Enabling a Grand Total Row for an example.
Scrollbars Copy Link
By default the grid uses the browser's native scrollbars. These parameters change scrollbars throughout the grid, including those in tool panels and filters:
scrollbarThumbColorandscrollbarTrackColor- setting BOTH of these will change the colour of the draggable scroll thumb and of the track behind it. Setting only one will have no effect.scrollbarWidth- set to'thin'for narrow scrollbars or'auto'for the browser default.bodyScrollbarBorder- on browsers that always show scrollbars, this sets the border between the grid's main scrollbars and the cells.
const myTheme = themeQuartz.withParams({
scrollbarThumbColor: '#9696C8',
scrollbarTrackColor: 'transparent',
scrollbarWidth: 'thin',
bodyScrollbarBorder: { color: '#9696C8' },
});This example also opens the Filters Tool Panel with a Set Filter, so you can see the scrollbar styles applied to other scrolling elements in the grid:
import {
createApp,
defineComponent,
onBeforeMount,
ref,
shallowRef,
} from "vue";
import { AgGridVue } from "ag-grid-vue3";
import {
ColDef,
ColGroupDef,
GridApi,
GridOptions,
GridReadyEvent,
GridState,
ModuleRegistry,
NewFiltersToolPanelState,
SideBarDef,
Theme,
enableDevValidations,
themeQuartz,
} from "ag-grid-community";
import { AllEnterpriseModule } from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";
if (process.env.NODE_ENV !== "production") {
// Enable extended validations only for development
enableDevValidations();
}
ModuleRegistry.registerModules([AllEnterpriseModule]);
const myTheme = themeQuartz.withParams({
scrollbarThumbColor: "#9696C8",
scrollbarTrackColor: "transparent",
scrollbarWidth: "thin",
bodyScrollbarBorder: { color: "#9696C8" },
});
const VueExample = defineComponent({
template: `
<div style="height: 100%">
<ag-grid-vue
style="width: 100%; height: 100%;"
@grid-ready="onGridReady"
:theme="theme"
:columnDefs="columnDefs"
:defaultColDef="defaultColDef"
:sideBar="sideBar"
:enableFilterHandlers="true"
:initialState="initialState"
:rowData="rowData"></ag-grid-vue>
</div>
`,
components: {
"ag-grid-vue": AgGridVue,
},
setup(props) {
const gridApi = shallowRef<GridApi<IOlympicData> | null>(null);
const theme = ref<Theme | "legacy">(myTheme);
const columnDefs = ref<ColDef[]>([
{ field: "athlete", minWidth: 170 },
{ field: "age" },
{ field: "country" },
{ field: "year" },
{ field: "date" },
{ field: "sport" },
{ field: "gold" },
{ field: "silver" },
{ field: "bronze" },
{ field: "total" },
]);
const defaultColDef = ref<ColDef>({
filter: true,
});
const sideBar = ref<SideBarDef | string | string[] | boolean | null>(
"filters-new",
);
const initialState = ref<GridState>({
sideBar: {
visible: true,
position: "right",
openToolPanel: "filters-new",
toolPanels: {
"filters-new": {
filters: [{ colId: "country", expanded: true }],
} as NewFiltersToolPanelState,
},
},
});
const rowData = ref<IOlympicData[]>(null);
const onGridReady = (params: GridReadyEvent) => {
gridApi.value = params.api;
const updateData = (data) => (rowData.value = data);
fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
.then((resp) => resp.json())
.then((data) => updateData(data));
};
return {
gridApi,
theme,
columnDefs,
defaultColDef,
sideBar,
initialState,
rowData,
onGridReady,
};
},
});
const app = createApp(VueExample);
app.mount("#app");