Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(Highcharts plugin): use unsafe option for tooltip cell renderer #545

Merged
merged 2 commits into from
Dec 24, 2024
Merged

fix(Highcharts plugin): use unsafe option for tooltip cell renderer #545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3d7430
fix: use unsafe option for tooltip lines
kuzmadom Dec 23, 2024
feea634
add story
kuzmadom Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/plugins/highcharts/__stories__/UnsafeTooltip.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import React from 'react';

import {Meta, Story} from '@storybook/react';

import {ChartKit} from '../../../components/ChartKit';
import {data} from '../mocks/unsafe-tooltip';

import {ChartStory} from './components/ChartStory';

export default {
title: 'Plugins/Highcharts/UnsafeTooltip',
component: ChartKit,
} as Meta;

const Template: Story<any> = () => {
return <ChartStory data={data} />;
};

export const UnsafeTooltip = Template.bind({});
139 changes: 139 additions & 0 deletions src/plugins/highcharts/mocks/unsafe-tooltip.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
import type {HighchartsWidgetData} from '../types';

export const data: HighchartsWidgetData = {
data: {
graphs: [
{
title: '<i>Profit</i>',
tooltip: {
chartKitFormatting: true,
chartKitPrecision: 2,
unsafe: true,
},
data: [
{
y: 18451.2728,
dataLabels: {
enabled: false,
},
label: '',
},
{
y: 122490.80080000011,
dataLabels: {
enabled: false,
},
label: '',
},
{
y: 145454.9480999999,
dataLabels: {
enabled: false,
},
label: '',
},
],
legendTitle: 'Profit',
colorKey: 'Profit',
colorGuid: null,
connectNulls: false,
yAxis: 0,
colorValue: 'Profit',
color: '#4DA2F1',
dashStyle: 'Solid',
name: '<i>Profit</i>',
},
{
title: 'Sales',
tooltip: {
chartKitFormatting: true,
chartKitPrecision: 2,
},
data: [
{
y: 741999.7952999998,
dataLabels: {
enabled: false,
},
label: '',
},
{
y: 719047.0320000029,
dataLabels: {
enabled: false,
},
label: '',
},
{
y: 836154.0329999966,
dataLabels: {
enabled: false,
},
label: '',
},
],
legendTitle: 'Sales',
colorKey: 'Sales',
colorGuid: null,
connectNulls: false,
yAxis: 0,
colorValue: 'Sales',
color: '#FF3D64',
dashStyle: 'Solid',
name: 'Sales',
},
],
categories: ['Furniture', 'Office Supplies', 'Technology'],
},
config: {
precision: 2,
hideHolidaysBands: true,
enableSum: true,
hideHolidays: false,
normalizeDiv: false,
normalizeSub: false,
manageTooltipConfig: (config) => {
config.lines.forEach((line, index) => {
line.commentText = `Some comment ${index + 1}`;
});

return config;
},
unsafe: true,
},
libraryConfig: {
chart: {
type: 'line',
zoomType: 'xy',
},
legend: {
symbolWidth: 38,
},
xAxis: {
endOnTick: false,
},
yAxis: {
opposite: false,
labels: {
y: 3,
},
type: 'linear',
},
tooltip: {},
plotOptions: {
series: {
dataGrouping: {
enabled: false,
},
dataLabels: {
allowOverlap: false,
},
},
},
axesFormatting: {
xAxis: [],
yAxis: [],
},
enableSum: true,
},
};
21 changes: 16 additions & 5 deletions src/plugins/highcharts/renderer/helpers/tooltip/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import './tooltip.scss';
export const SERIES_NAME_DATA_ATTRIBUTE = 'data-series-name';
export const SERIES_IDX_DATA_ATTRIBUTE = 'data-series-idx';
export const TOOLTIP_CONTAINER_CLASS_NAME = '_tooltip';
export const TOOLTIP_ROW_NAME_CLASS_NANE = '_tooltip-rows__name-td';
export const TOOLTIP_ROW_NAME_CLASS_NAME = '_tooltip-rows__name-td';
export const TOOLTIP_ROW_CLASS_NAME = '_tooltip-row';
export const TOOLTIP_HEADER_CLASS_NAME = '_tooltip-header';
export const TOOLTIP_LIST_CLASS_NAME = '_tooltip-list';
Expand All @@ -35,10 +35,19 @@ const renderLineShapeCell = (line: TooltipLine) =>
</div>
</td>`;

const renderNameCell = (line: TooltipLine) =>
`<td class="${TOOLTIP_ROW_NAME_CLASS_NANE}">
${line.hideSeriesName ? '' : escapeHTML(line.seriesName)}
const renderNameCell = (line: TooltipLine, options?: {unsafe?: boolean}) => {
let value = '';
if (!line.hideSeriesName) {
value = line.seriesName;

if (!options?.unsafe) {
value = escapeHTML(value);
}
}
return `<td class="${TOOLTIP_ROW_NAME_CLASS_NAME}">
${value}
</td>`;
};

const renderPercentCell = (line: TooltipLine) =>
`<td class="_tooltip-rows__percent-td">
Expand Down Expand Up @@ -109,6 +118,7 @@ const renderRow = (
allowComment,
withDarkBackground,
rowIndex,
unsafe,
}: RowRenderingConfig,
) => {
const hasComment = line.commentText || line.xyCommentText;
Expand Down Expand Up @@ -179,7 +189,7 @@ const renderRow = (
? line.insertCellAt[index]
: line.insertCellAt[index](line);
} else {
return render(line);
return render(line, {unsafe});
}
})
.join('')}
Expand Down Expand Up @@ -245,6 +255,7 @@ export const formatTooltip = (
const rowRenderingConfig = {
isSingleLine: lines.length === 1,
cellsRenderers,
unsafe,
};

const rowRenderingConfigForSelectedLine = {
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/highcharts/renderer/helpers/tooltip/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,11 @@ export type TooltipLine = {
};

export type RowRenderingConfig = {
cellsRenderers: Array<(line: TooltipLine) => string>;
cellsRenderers: Array<(line: TooltipLine, options?: {unsafe?: boolean}) => string>;
isSelectedLine?: boolean;
allowComment?: boolean;
withDarkBackground?: boolean;
isSingleLine?: boolean;
rowIndex?: number;
unsafe?: boolean;
};
Loading