@d3-maps/core / interaction

interaction

Table of contents

• Functions
  • getInteractionStateUpdate()
  • resolveInteractionStyle()
  • useInteractionEvents()
• Variables
  • interactionState
• Interfaces
  • InteractionController
  • InteractionProps
• Type Aliases
  • ElementMouseDownSource
  • GlobalMouseupListener
  • GlobalMouseupSubscription
  • InteractionEventType
  • InteractionState
  • InteractionStyles
  • MouseDownSource

Functions

getInteractionStateUpdate()

function getInteractionStateUpdate(event: InteractionEventType): "default" | "hover" | "active" | "focus";

Parameters

Parameter	Type
event	InteractionEventType

Returns

"default" | "hover" | "active" | "focus"

---

resolveInteractionStyle()

function resolveInteractionStyle<TStyle>(state: "default" | "hover" | "active" | "focus", styles?: Partial<Record<"default" | "hover" | "active" | "focus", TStyle>>): TStyle | undefined;

Type Parameters

Type Parameter
TStyle

Parameters

Parameter	Type
state	"default"
styles?	Partial<Record<"default"

Returns

TStyle | undefined

---

useInteractionEvents()

function useInteractionEvents<TTarget>(onStateChange?: (state: "default" | "hover" | "active" | "focus") => void, recoverOnGlobalMouseup?: boolean): InteractionController<TTarget>;

Type Parameters

Type Parameter	Default type
TTarget	unknown

Parameters

Parameter	Type	Default value
onStateChange?	(state: "default"	"hover"
recoverOnGlobalMouseup?	boolean	false

Returns

InteractionController<TTarget>

Variables

interactionState

const interactionState: readonly ["default", "hover", "active", "focus"];

Interfaces

InteractionController

Type Parameters

Type Parameter	Default type
TTarget	unknown

Properties

Property	Type
dispose	() => void
onBlur	() => "default"
onFocus	() => "default"
onMousedown	(source?: MouseDownSource<TTarget>) => "default"
onMouseenter	() => "default"
onMouseleave	() => "default"
onMouseup	() => "default"

---

InteractionProps

Extended by

• MapElementProps

Type Parameters

Type Parameter	Default type
TStyle	unknown

Properties

Property	Type
styles?	Partial<Record<"default"

Type Aliases

ElementMouseDownSource

type ElementMouseDownSource = 
  | Element
  | {
  currentTarget: EventTarget | null;
}
  | null
  | undefined;

---

GlobalMouseupListener

type GlobalMouseupListener = () => void;

Returns

void

---

GlobalMouseupSubscription

type GlobalMouseupSubscription = (listener: GlobalMouseupListener) => () => void;

Parameters

Parameter	Type
listener	GlobalMouseupListener

Returns

() => void

---

InteractionEventType

type InteractionEventType = "mouseenter" | "mouseleave" | "mousedown" | "mouseup" | "focus" | "blur";

---

InteractionState

type InteractionState = typeof interactionState[number];

---

InteractionStyles

type InteractionStyles<TStyle> = Partial<Record<InteractionState, TStyle>>;

Type Parameters

Type Parameter	Default type
TStyle	unknown

---

MouseDownSource

type MouseDownSource<TTarget> = TTarget | ElementMouseDownSource;

Type Parameters

Type Parameter	Default type
TTarget	unknown