Skip to content

Commit

Permalink
Add documentation about setting default tooltip font (#11968)
Browse files Browse the repository at this point in the history
  • Loading branch information
LeeLenaleee authored Dec 1, 2024
1 parent 79773b7 commit 4d034a0
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/configuration/tooltip.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

Namespace: `options.plugins.tooltip`, the global options for the chart tooltips is defined in `Chart.defaults.plugins.tooltip`.

:::warning
The `titleFont`, `bodyFont` and `footerFont` options default to the `Chart.defaults.font` options. To change the overrides for those options, you will need to pass a function that returns a font object. See section about [overriding default fonts](#default-font-overrides) for extra information below.
:::

| Name | Type | Default | Description
| ---- | ---- | ------- | -----------
| `enabled` | `boolean` | `true` | Are on-canvas tooltips enabled?
Expand Down Expand Up @@ -420,7 +424,7 @@ Tooltip.positioners.myCustomPositioner = function(elements, eventPosition) {
};

// Then, to use it...
new Chart.js(ctx, {
new Chart(ctx, {
data,
options: {
plugins: {
Expand All @@ -443,3 +447,15 @@ declare module 'chart.js' {
}
}
```

## Default font overrides

By default, the `titleFont`, `bodyFont` and `footerFont` listen to the `Chart.defaults.font` options for setting its values.
Overriding these normally by accessing the object won't work because it is backed by a get function that looks to the default `font` namespace.
So you will need to override this get function with your own function that returns the desired config.

Example:

```javascript
Chart.defaults.plugins.tooltip.titleFont = () => ({ size: 20, lineHeight: 1.2, weight: 800 });
```

0 comments on commit 4d034a0

Please sign in to comment.