Interface: ClickHandlerBoxProps

Hierarchy

• SharedComponentProps

  ↳ ClickHandlerBoxProps

Properties

ariaLabel

• Optional ariaLabel: string

Deprecated

• Use kebab-case aria-label instead Label to be used for accessibility purposes.

Inherited from

SharedComponentProps.ariaLabel

Defined in

packages/ida-framework/src/types.ts:46

---

boxPosition

• Optional boxPosition: Object

Optionally transform the dimensions and position of the underlying div

Type declaration

Name	Type
height?	number
left?	number
rotate?	number
top?	number
width?	number

Defined in

packages/ida-framework/src/features/clickHandlerBox/ClickHandlerBox.tsx:31

---

children

• Optional children: ReactNode | ReactNode[]

Defined in

packages/ida-framework/src/features/clickHandlerBox/ClickHandlerBox.tsx:38

---

className

• Optional className: string

Inherited from

SharedComponentProps.className

Defined in

packages/ida-framework/src/types.ts:48

---

id

• id: string

Defined in

packages/ida-framework/src/features/clickHandlerBox/ClickHandlerBox.tsx:27

---

onClick

• Optional onClick: (eventValues: PointerEventValues) => void

Type declaration

▸ (eventValues): void

Callback fired if interaction begins and ends without any mouse movement.

Parameters

Name	Type
eventValues	PointerEventValues

Returns

void

Defined in

packages/ida-framework/src/features/clickHandlerBox/ClickHandlerBox.tsx:54

---

onDragEnd

• Optional onDragEnd: (eventValues: PointerEventValues) => void

Type declaration

▸ (eventValues): void

Callback fired if interaction beings and ends after mouse movement has occurred.

Parameters

Name	Type
eventValues	PointerEventValues

Returns

void

Defined in

packages/ida-framework/src/features/clickHandlerBox/ClickHandlerBox.tsx:62

---

onDragMove

• Optional onDragMove: (eventValues: PointerEventValues) => void

Type declaration

▸ (eventValues): void

Callback fired when the user drags after beginning interaction.

Parameters

Name	Type
eventValues	PointerEventValues

Returns

void

Defined in

packages/ida-framework/src/features/clickHandlerBox/ClickHandlerBox.tsx:42

---

onDragStart

• Optional onDragStart: (eventValues: PointerEventValues) => void

Type declaration

▸ (eventValues): void

Callback fired only once when dragging begins.

Parameters

Name	Type
eventValues	PointerEventValues

Returns

void

Defined in

packages/ida-framework/src/features/clickHandlerBox/ClickHandlerBox.tsx:58

---

onInteractEnd

• Optional onInteractEnd: (eventValues: PointerEventValues) => void

Type declaration

▸ (eventValues): void

Callback fired when the user does a mouseup/touchend/pointerup after interaction began.

Parameters

Name	Type
eventValues	PointerEventValues

Returns

void

Defined in

packages/ida-framework/src/features/clickHandlerBox/ClickHandlerBox.tsx:50

---

onInteractStart

• Optional onInteractStart: (eventValues: PointerEventValues) => void

Type declaration

▸ (eventValues): void

Callback fired when the user does a mousedown/touchstart/pointerdown within the box.

Parameters

Name	Type
eventValues	PointerEventValues

Returns

void

Defined in

packages/ida-framework/src/features/clickHandlerBox/ClickHandlerBox.tsx:46

---

onPointerEnter

• Optional onPointerEnter: (eventValues: PointerEvent<Element>) => void

Type declaration

▸ (eventValues): void

Callback fired when the pointer enters this element.

Parameters

Name	Type
eventValues	PointerEvent<Element>

Returns

void

Defined in

packages/ida-framework/src/features/clickHandlerBox/ClickHandlerBox.tsx:70

---

onPointerLeave

• Optional onPointerLeave: (eventValues: PointerEvent<Element>) => void

Type declaration

▸ (eventValues): void

Callback fired when the pointer leaves this element.

Parameters

Name	Type
eventValues	PointerEvent<Element>

Returns

void

Defined in

packages/ida-framework/src/features/clickHandlerBox/ClickHandlerBox.tsx:74

---

onPointerMove

• Optional onPointerMove: (eventValues: PointerEvent<Element>) => void

Type declaration

▸ (eventValues): void

Callback fired when the pointer moves inside this element.

Parameters

Name	Type
eventValues	PointerEvent<Element>

Returns

void

Defined in

packages/ida-framework/src/features/clickHandlerBox/ClickHandlerBox.tsx:66

---

role

• Optional role: AriaRole

Inherited from

SharedComponentProps.role

Defined in

packages/ida-framework/src/types.ts:49

---

style

• Optional style: CSSProperties

Inherited from

SharedComponentProps.style

Defined in

packages/ida-framework/src/types.ts:47