Last modified: August 22, 2025
The BarChart component renders a bar chart for visualizing data. This type of chart is best suited for comparing categorical data. Alternatively, you can use a LineChart component for time series plots or visualizing trend data. Learn more about charts.
To see an example of how to implement charts in a UI extension, check out HubSpot’s Charts example project. Note that this is a version 2025.1 project, but the chart component implementation would be similar for 2025.2.
- Title: the title of the chart.
- Legend: lists the data categories with their corresponding color for readability.
- Axis label: the label for the axis.
- Data labels: labels for data points.
import { BarChart } from '@hubspot/ui-extensions';
const dailyInventorySample = [
{
Product: 'Hats',
Amount: 187,
},
{
Product: 'Socks',
Amount: 65,
},
{
Product: 'Ascots',
Amount: 120,
}
];
return (
<BarChart
data={dailyInventorySample}
axes={{
x: { field: 'Product', fieldType: 'category' },
y: { field: 'Amount', fieldType: 'linear' },
options: {groupFieldByColor: 'Product'}
}}
options={{
title: "My chart",
showLegend: true,
showDataLabels: true,
showTooltips: true
}}
/>
);
};
| Parameter | Type | Description |
|---|
data | Object | An object containing the chart’s data in an array. - Data should be formatted as comma-separated objects containing key-value pairs.
- Data will be displayed in the order it’s provided, so any sorting will need to be done before passing it to the component.
- While it’s recommended to pre-format your data to be human-readable, you can also provide the
propertyLabels parameter via this prop’s options to relabel data values. See example in the Stacking section below.
Learn more about formatting data. |
axes | Object | Configures the chart’s axes. Using the x and y fields, you’ll configure each axis individually with field and fieldType parameters, along with an optional label parameter:field (Required): the field from your dataset to use. This value will be used as the displayed axis label if no label is specified.fieldType (Required): the type of field. Can be category, datetime, or linear. Learn more about field types.label: the axis label. If not specified, the field value will be used.
You can also include an options field to further configure the axes with the following options:Learn more about chart axes. |
options | Object | Additional chart configuration options. Options include:title (string): a title for the chart.showLegend (boolean): set to true to display a legend above the chart. showDataLabels (boolean): set to true to display labels above data points.showTooltips (boolean): set to true to display tooltips for data points on hover.colorList (array): specify a custom order for colors to used in the report.
Learn more about chart options. |
Colors
To apply colors to a chart for visual clarity, you can group data fields by color using the groupFieldByColor parameter within the axes options. For example, the bar chart below use groupFieldByColor to add colors to each Product defined in the dataset.
const dailyInventorySample = [
{
Product: 'Standalone product A',
Sales: 159,
},
{
Product: 'Bundle A',
Sales: 53,
},
{
Product: 'Bundle B',
Sales: 99,
},
];
return (
<BarChart
data={dailyInventorySample}
axes={{
x: { field: 'Product', fieldType: 'category' },
y: { field: 'Sales', fieldType: 'linear' },
options: { groupFieldByColor: 'Product' },
}}
/>
);
groupFieldByColor configured for the axes:
Colors will be automatically assigned in a preset order. To customize the color selection order, include the colorList field in the options prop, then specify the colors to pick from as shown below.
const dailyInventorySample = [
{
Product: 'Standalone product A',
Sales: 159,
},
{
Product: 'Bundle A',
Sales: 53,
},
{
Product: 'Bundle B',
Sales: 99,
},
];
return (
<BarChart
data={dailyInventorySample}
axes={{
x: { field: 'Product', fieldType: 'category' },
y: { field: 'Sales', fieldType: 'linear' },
options: { groupFieldByColor: 'Product' },
}}
options={{
colorList: ['purple', 'green', 'darkBlue'],
}}
/>
);
groupFieldByColor. To do so, include the colors field within the axes options, then specify each field value and color, as shown below. Learn more about colors.
const dailyInventorySample = [
{
Product: 'Standalone product A',
Sales: 159,
},
{
Product: 'Bundle A',
Sales: 53,
},
{
Product: 'Bundle B',
Sales: 99,
},
];
return (
<BarChart
data={dailyInventorySample}
axes={{
x: { field: 'Product', fieldType: 'category' },
y: { field: 'Sales', fieldType: 'linear' },
options: {
groupFieldByColor: 'Product',
colors: {
'Standalone product A': 'blue',
'Bundle A': 'orange',
'Bundle B': 'yellow',
},
},
}}
/>
);
Stacking
Use the stacking axes option to stack grouped data rather than rendering individual bars. For example, the following bar chart displays the number of deals by deal stage. The data also includes the sales rep who owns each deal. Because two sales reps have deals in the same deal stage, stacking has been set to true to visually combine the data into one bar.
const Extension = ({ context }) => {
const dealCountSample = [
{
count: 1,
dealstage: 'appointmentScheduled',
user_id: '194784',
},
{
count: 2,
dealstage: 'closedWon',
user_id: '295834',
},
{
count: 1,
dealstage: 'closedWon',
user_id: '938453',
},
];
return (
<BarChart
data={{
data: dealCountSample,
options: {
propertyLabels: {
dealstage: {
appointmentScheduled: 'Appointments scheduled (Sales)',
closedWon: 'Closed won (Sales)',
},
user_id: {
194784: 'Sales user A',
295834: 'Sales user B',
938453: 'Sales user C',
},
},
},
}}
axes={{
x: {
field: 'dealstage',
fieldType: 'category',
label: 'Deal Stage',
},
y: {
field: 'count',
fieldType: 'linear',
label: 'Count of Deals',
},
options: { groupFieldByColor: 'user_id', stacking: true },
}}
options={{
showLegend: true,
showDataLabels: true,
showTooltips: true,
}}
/>
);
};
Because the dealstage field data is not written in a human-readable format (e.g., appointmentScheduled), the data prop includes propertyLabels in its options to convert the labels. Note that the data prop formatting is slightly different to accommodate both the dataset and its options. Learn more about data options. Guidelines
- DO: title your data categories with human-readable text so they are easy to understand.
- DO: use sentence-casing for the data categories and chart title (only first letter capitalized).
- DO: sort your data in ascending/descending order of your x-axis field to prevent unordered rendering prior to passing it to a charting component. If you intend to display information over time, your data will be displayed in the order you provide it.
- DO: display the chart legend if you’re graphing more than one category of data. This prevents your users from having to rely only on color to identify different data on your chart.
- DO: for readability, use larger surfaces to showcase charts, such as the record page middle column. Avoid using charts with many data points on smaller surfaces such as the preview panel or sidebar.
- DON’T: use more than 14 data categories unless it cannot be avoided for your use case.
- DON’T: use the same colors to indicate different data categories.
