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.

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

Expose tooltipContext to enable bind: usage for external access #394

Merged
merged 1 commit into from
Feb 11, 2025
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
5 changes: 5 additions & 0 deletions .changeset/wild-pumas-doubt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'layerchart': minor
---

feat(AreaChart|BarChart|LineChart|PieChart|ScatterChart): Expose `tooltipContext` to enable `bind:` usage for external access
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,9 @@
export let points: ComponentProps<Points> | boolean = false;
export let rule: ComponentProps<Rule> | boolean = true;

/** Expose tooltip context for external access */
export let tooltipContext: ComponentProps<Tooltip.Context>['tooltip'] = undefined;

/** Event dispatched with current tooltip data */
export let ontooltipclick: (e: MouseEvent, details: { data: any }) => void = () => {};

Expand Down Expand Up @@ -301,6 +304,7 @@
...props.tooltip?.context,
...$$props.tooltip,
}}
bind:tooltipContext
brush={brush && (brush === true || brush.mode == undefined || brush.mode === 'integrated')
? {
axis: 'x',
Expand Down
4 changes: 4 additions & 0 deletions packages/layerchart/src/lib/components/charts/BarChart.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@
/** Padding between series items within bars when using 'seriesLayout="stack"' */
export let stackPadding = 0;

/** Expose tooltip context for external access */
export let tooltipContext: ComponentProps<Tooltip.Context>['tooltip'] = undefined;

/** Event dispatched with current tooltip data */
export let ontooltipclick: (e: MouseEvent, detail: { data: any }) => void = () => {};

Expand Down Expand Up @@ -321,6 +324,7 @@
...props.tooltip?.context,
...$$props.tooltip,
}}
bind:tooltipContext
let:x
let:xScale
let:y
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@
export let points: ComponentProps<Points> | boolean = false;
export let rule: ComponentProps<Rule> | boolean = true;

/** Expose tooltip context for external access */
export let tooltipContext: ComponentProps<Tooltip.Context>['tooltip'] = undefined;

/** Event dispatched with current tooltip data */
export let ontooltipclick: (e: MouseEvent, details: { data: any }) => void = () => {};

Expand Down Expand Up @@ -232,6 +235,7 @@
...props.tooltip?.context,
...$$props.tooltip,
}}
bind:tooltipContext
brush={brush && (brush === true || brush.mode == undefined || brush.mode === 'integrated')
? {
axis: 'x',
Expand Down
4 changes: 4 additions & 0 deletions packages/layerchart/src/lib/components/charts/PieChart.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,9 @@
/** Center chart. Override and use `props.group` for more control */
export let center = placement === 'center';

/** Expose tooltip context for external access */
export let tooltipContext: ComponentProps<Tooltip.Context>['tooltip'] = undefined;

// TODO: Not usable with manual tooltip / arc path. Use `onarcclick`?
/** Event dispatched with current tooltip data */
export let ontooltipclick: (e: MouseEvent, detail: { data: any }) => void = () => {};
Expand Down Expand Up @@ -181,6 +184,7 @@
padding={{ bottom: legend === true ? 32 : 0 }}
{...$$restProps}
tooltip={props.tooltip?.context}
bind:tooltipContext
let:x
let:xScale
let:y
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@
export let legend: ComponentProps<Legend> | boolean = false;
export let rule: ComponentProps<Rule> | boolean = true;

/** Expose tooltip context for external access */
export let tooltipContext: ComponentProps<Tooltip.Context>['tooltip'] = undefined;

/** Event dispatched with current tooltip data */
export let ontooltipclick: (e: MouseEvent, detail: { data: any }) => void = () => {};

Expand Down Expand Up @@ -191,6 +194,7 @@
...props.tooltip?.context,
...$$props.tooltip,
}}
bind:tooltipContext
brush={brush && (brush === true || brush.mode == undefined || brush.mode === 'integrated')
? {
axis: 'both',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import type { DomainType } from '$lib/utils/scales.js';
import Html from 'layerchart/components/layout/Html.svelte';
import Blockquote from 'layerchart/docs/Blockquote.svelte';
import type { ComponentProps } from 'svelte';

export let data;

Expand Down Expand Up @@ -104,6 +105,7 @@
let debug = false;

let markerPoints: { date: Date; value: number }[] = [];
let tooltipContext: ComponentProps<AreaChart<any>>['tooltipContext'];
</script>

<svelte:window
Expand Down Expand Up @@ -922,6 +924,76 @@
</div>
</Preview>

<h2>Externally access tooltip data</h2>

<Preview data={{ denseDateSeriesData, denseDateSeriesData2 }}>
<div class="text-sm">
{#if $tooltipContext?.data}
date: {format($tooltipContext?.data?.date, PeriodType.Day, { variant: 'short' })}
value: {$tooltipContext?.data?.value}
{:else}
[hover chart]
{/if}
</div>
<div class="h-[300px] p-4 border rounded">
<AreaChart
data={denseDateSeriesData}
x="date"
y="value"
{xDomain}
bind:tooltipContext
props={{
area: { tweened: { duration: 200 } },
xAxis: { format: undefined, tweened: { duration: 200 } },
}}
{renderContext}
{debug}
/>
</div>
</Preview>

<!-- <Preview data={dateSeries}>
<div class="text-sm">
{#if $tooltipContext?.data}
date: {formatDate($tooltipContext?.data?.date, PeriodType.Day, { variant: 'short' })}
value: {$tooltipContext?.data?.value}
{:else}
[hover chart]
{/if}
</div>

<div class="h-[300px] p-4 border rounded">
<Chart
data={dateSeries}
x="date"
xScale={scaleTime()}
y="value"
yDomain={[0, null]}
yNice
padding={{ left: 16, bottom: 24 }}
tooltip={{ mode: 'bisect-x' }}
bind:tooltipContext
>
<Svg>
<Axis placement="left" grid rule />
<Axis
placement="bottom"
format={(d) => formatDate(d, PeriodType.Day, { variant: 'short' })}
rule
/>
<Area class="fill-primary/30" line={{ class: 'stroke-primary stroke-2' }} />
<Highlight points lines />
</Svg>
<Tooltip.Root let:data>
<Tooltip.Header>{format(data.date, 'eee, MMMM do')}</Tooltip.Header>
<Tooltip.List>
<Tooltip.Item label="value" value={data.value} />
</Tooltip.List>
</Tooltip.Root>
</Chart>
</div>
</Preview> -->

<h2>Brushing</h2>

<Preview data={dateSeriesData}>
Expand Down