Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,27 @@ const chartWithSelect: TopLevelSpec = {
...chart,
params: [
{
name: "points",
select: { type: "point", fields: ["x", "a"], on: "click" },
name: "sel_point",
select: "point",
},
{
name: "sel_interval",
select: "interval",
},
{
name: "sel_point_a",
select: { on: "click", type: "point", fields: ["x", "a"] },
},
// Event not supported yet
{
name: "sel_interval_b",
select: { on: "wheel", type: "interval", fields: ["x", "b"] },
},
],
};

describe("useSignalListeners", () => {
it("should return a stable record", () => {
it("should return a stable record wo signals", () => {
const { result, rerender } = renderHook(() =>
useSignalListeners(chart, "VegaChart", "my_chart", () => {}),
);
Expand All @@ -43,23 +56,36 @@ describe("useSignalListeners", () => {
expect(signalHandlers1).toBe(signalHandlers1);
});

it("should support different signal types", () => {
const { result } = renderHook(() =>
useSignalListeners(chartWithSelect, "VegaChart", "my_chart", () => {}),
);
const signalHandlers = result.current;
expect(signalHandlers).toBeDefined();
expect(signalHandlers["sel_point"]).toBeTypeOf("function");
expect(signalHandlers["sel_interval"]).toBeTypeOf("function");
expect(signalHandlers["sel_point_a"]).toBeTypeOf("function");
// "wheel" not supported
expect(signalHandlers["sel_point_b"]).toBeUndefined();
});

it("should call onChange", () => {
const { recordedEvents, onChange } = createChangeHandler();
const { result } = renderHook(() =>
useSignalListeners(chartWithSelect, "VegaChart", "my_chart", onChange),
);
const signalHandlers = result.current;
expect(signalHandlers).toBeDefined();
const signalHandler = signalHandlers["points"];
const signalHandler = signalHandlers["sel_point_a"];
expect(signalHandler).toBeTypeOf("function");
act(() => {
signalHandler("points", [1, 2, 3]);
signalHandler("sel_point_a", [1, 2, 3]);
});
expect(recordedEvents.length).toBe(1);
expect(recordedEvents[0]).toEqual({
componentType: "VegaChart",
id: "my_chart",
property: "points",
property: "sel_point_a",
value: [1, 2, 3],
});
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,18 @@ type SignalHandler = (signalName: string, signalValue: unknown) => void;
* only interested in extracting the handlers, the following
* properties are required.
*/
type SelectionParameter = { name: string; select: { on: string } };
type SelectionParameter = {
name: string;
select: "point" | "interval" | { type: "point" | "interval"; on: string };
};

const isSelectionParameter = (param: unknown): param is SelectionParameter =>
isObject(param) &&
"name" in param &&
"select" in param &&
isObject(param.select) &&
param.select?.on !== null &&
isString(param.select.on);
(param.select === "point" ||
param.select === "interval" ||
(isObject(param.select) &&
(param.select.type === "point" || param.select.type === "interval") &&
isString(param.select.on)));

export function useSignalListeners(
chart: TopLevelSpec | null | undefined,
Expand All @@ -36,16 +39,23 @@ export function useSignalListeners(
* have so that we can create those listeners with the `name` specified in
* the event-listener object.
*/
const signalNames = useMemo((): Record<string, string> => {
const signalNames: Record<string, string> = {};
const signalNames = useMemo(() => {
const signalNames: [string, string][] = [];
if (!chart || !chart.params) {
return signalNames;
}
return chart.params
.filter(isSelectionParameter)
.reduce((paramNames, param) => {
paramNames[param.select.on] = param.name;
return paramNames;
.reduce((signalNames, param) => {
// https://vega.github.io/vega-lite/docs/parameter.html#select
if (param.select === "point") {
signalNames.push(["click", param.name]);
} else if (param.select === "interval") {
signalNames.push(["drag", param.name]);
} else {
signalNames.push([param.select.on, param.name]);
}
return signalNames;
}, signalNames);
}, [chart]);

Expand Down Expand Up @@ -74,10 +84,11 @@ export function useSignalListeners(
*/
const signalHandlers: Record<string, SignalHandler> = {
click: handleClickSignal,
drag: handleClickSignal,
};

const signalListeners: Record<string, SignalHandler> = {};
Object.entries(signalNames).forEach(([event, signalName]) => {
signalNames.forEach(([event, signalName]) => {
if (signalHandlers[event]) {
signalListeners[signalName] = signalHandlers[event];
} else {
Expand Down
Loading