Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

useHotKeys inside Iframe

See original GitHub issue

Hi there!

version: react-hotkeys-hook@4.0.2

I’m trying to use useHotKeys inside react-frame-component Iframe, but when i’m focusing on iframe and pressing some hotkeys, events doesn’t work, nothing happens, example:

import React, { memo, useRef, useEffect, useCallback } from 'react'

import Frame, { FrameContextConsumer, useFrame } from 'react-frame-component'

import {useHotkeys} from 'react-hotkeys-hook'

const InnerComponent = () => {

	const { document, window } = useFrame();

	useHotkeys('s', (event) => {
		console.log('s pressed');
	})

	return null;
};

const Editor = () => {
	return (
		<>
		 	<Frame>
				<InnerComponent/>
			</Frame>
		</>
	)
}
export default memo(Editor)

what i’m doing wrong, or maybe i need to pass some arguments to useHotkeys function?

thanks!

Issue Analytics

State:
Created 10 months ago
Comments:7 (3 by maintainers)

Top GitHub Comments

2reactions

mbrevdacommented, Dec 6, 2022

Had similar issues with other libs when using React Portals (like react-helmet and many css-in-js libs that want to access <head> and all assume that <head> is located at document.getElementsByTagName('head')[0]).

It boils down to listening on the wrong document (i.e. the parent document, where react lives, instead of listening on the iframe’s document). It’s likely that being able to pass document to the hook will resolve the issue

1reaction

JohannesKlausscommented, Dec 25, 2022

Starting with 4.3.0 you can set a different document to bind to in the useHotkey hook like so:

import FrameComponent from 'react-frame-component'

const InsideFrameComponent = () => {
  const { document } = useFrame()

  useHotkeys("s", () => console.log("I am triggered inside an iframe"), { document })

  return <div>....</div>
}

function App() {
  return (
    <FrameComponent>
      <InsideFrameComponent/>
    </FrameComponent>
  )
}

Thanks to @mbrevda for the pointer to the solution!