visgl / visgl/deck.gl

[Bug] Type TooltipContent is not exported by module @deck.gl/core

Open
#9,013 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
TypeScript
Stars
14.6k
Forks
2.3k
Avg merge
2d 9h
Merged PRs (30d)
42

Description

Description

If you want to add your own tooltip provider via attribute getTooltip to a Deck, you need to import the types PickingInfo and TooltipContent because getTooltip has the following signature:

getTooltip?: ((info: PickingInfo) => TooltipContent) | null;

While PickingInfo is properly exported by module @deck.gl/core, the type TooltipContent is not exported. The workaround is to import it from the declaring file like this:

import { TooltipContent } from '@deck.gl/core/lib/tooltip';

Although this import works, it actually breaks the module idea of Typescript.

Flavors
  • Script tag
  • React
  • Python/Jupyter notebook
  • MapboxOverlay
  • GoogleMapsOverlay
  • CartoLayer
  • ArcGIS
Expected Behavior

Type TooltipContent is exported by https://github.com/visgl/deck.gl/blob/master/modules/core/src/index.ts

Steps to Reproduce

See my question https://github.com/visgl/deck.gl/discussions/8999 in discussions.

Environment
  • Framework version: 9.0.21
  • Browser: Chrome
  • OS: Windows 10
Logs

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The public entry point is modules/core/src/index.ts, while TooltipContent is declared in modules/core/src/tooltip. Start by comparing the core exports with the existing import workaround. Done means TooltipContent can be imported from @deck.gl/core and remains usable in the getTooltip signature.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
data-visualization, frontend
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.