Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Specifying onClick event type with Typescript and React.Konva

I'm trying to get rid of my tslint error Type declaration of 'any' loses type-safety. but I'm struggling to figure out what the correct type would be for the Event.

I'm working through the Lynda "Building and Deploying a Full-Stack React Application" while trying to convert it to Typescript.

Here are the specific lines that are causing the issue:

onClick={(event: any) => {  makeMove(ownMark, event.target.index) }} 

I have tried to declare the event as a few different types, like React.MouseEvent<HTMLElement>, plus a few other subtypes on HTMLElement, with no success as the target.index is not a property on any type I can come up with. I can see from the inspector that the currentTarget is Konva.Text and the index is set to 0 but not sure that helps me as I can't set the type to Konva.Text, which would make sense to me, but that doesn't work either.

React Konva Event target Index

Here is my full React functional component:

export const Squares = ({units, coordinates, gameState, win, gameOver, yourTurn, ownMark, move}: SquaresProps) => {   let squares = coordinates.map( (position: number, index: number) => {      let makeMove = move     let mark = gameState[index] !== 'z' ? gameState[index] : false     let fill = 'black'      // when someone wins you want the square to turn green     if (win && win.includes(index)) {       fill = 'lightGreen'     }      if (gameOver || !yourTurn || mark) {       makeMove = () => console.log('nope!')     }      return (       <Text         key={index}         x={position[0]}         y={position[1]}         fontSize={units}         width={units}         text={mark}         fill={fill}         fontFamily={'Helvetica'}         aligh={'center'}         onClick={(event: any) => {           makeMove(ownMark, event.target.index)         }}       />     )   })    return (     <Layer>       {squares}     </Layer>   ) } 

Here are my package.json dependencies:

  "dependencies": {     "konva": "^1.6.3",     "material-ui": "^0.18.4",     "react": "^15.6.1",     "react-dom": "^15.6.1",     "react-konva": "^1.1.3",     "react-router": "~3.0.0",     "react-tap-event-plugin": "^2.0.1",     "styled-components": "^2.1.0"   }, 

I think the index is being added by the Konva Layer class but I'm pretty new to the whole react ecosystem so still trying to wrap my brain around it all.

UPDATE:

I was able use declaration merging suggestion by Tyler Sebastion to define the index on the target which silenced tslint. I'm not sure this is the best approach though as it feels a bit fragile to me.

Here is the additional interface code and updated onclick event:

interface KonvaTextEventTarget extends EventTarget {   index: number }  interface KonvaMouseEvent extends React.MouseEvent<HTMLElement> {   target: KonvaTextEventTarget }  ...  return (   <Text     key={index}     x={position[0]}     y={position[1]}     fontSize={units}     width={units}     text={mark}     fill={fill}     fontFamily={'Helvetica'}     aligh={'center'}     onClick={(event: KonvaMouseEvent) => {       makeMove(ownMark, event.target.index)     }}   /> ) 
like image 217
Justin Levi Winter Avatar asked Jul 13 '17 19:07

Justin Levi Winter


People also ask

How do you write onClick function in React TypeScript?

To type the onClick event of an element in React, set its type to React. MouseEvent<HTMLElement> . The MouseEvent interface is used to type onClick events in React.

What is the type of onClick event in TypeScript?

The onClick event occurs when an element is clicked. This element can be a button, a div element, an image, etc.


1 Answers

You're probably out of luck without some hack-y workarounds

You could try

onClick={(event: React.MouseEvent<HTMLElement>) => {  makeMove(ownMark, (event.target as any).index) }} 

I'm not sure how strict your linter is - that might shut it up just a little bit

I played around with it for a bit, and couldn't figure it out, but you can also look into writing your own augmented definitions: https://www.typescriptlang.org/docs/handbook/declaration-merging.html

edit: please use the implementation in this reply it is the proper way to solve this issue (and also upvote him, while you're at it).

like image 169
Tyler Sebastian Avatar answered Sep 23 '22 13:09

Tyler Sebastian