use-focus-within

Detect if any element within has focus

Import

Source

View source code

Docs

Edit this page

Package

@mantine/hooks

Usage

use-focus-within hook detects if any element within has focus, it works the same way as :focus-within CSS selector:

One of elements has focus: false

Focus this input

import { useFocusWithin } from '@mantine/hooks';
import { TextInput, Button, Box, Text } from '@mantine/core';

function Demo() {
  const { ref, focused } = useFocusWithin();
  return (
    <div ref={ref}>
      <Box
        sx={(theme) => ({
          backgroundColor: focused
            ? theme.fn.variant({ variant: 'light' }).background
            : 'transparent',
          padding: theme.spacing.xl,
        })}
      >
        <Text size="sm">One of elements has focus: {focused.toString()}</Text>
        <TextInput label="Focus this input" placeholder="Styles will be added to parent" />
        <Button mt="md">Button</Button>
      </Box>
    </div>
  );
}

Definition

function useFocusWithin<T extends HTMLElement = any>(handlers?: {
  onFocus?(event: FocusEvent): void;
  onBlur?(event: FocusEvent): void;
}): {
  ref: React.MutableRefObject<T>;
  focused: boolean;
};

Go back

use-focus-trap – @mantine/hooks

Up next

use-fullscreen – @mantine/hooks

Build fully functional accessible web applications faster than ever

About

Contribute Media assets Changelog Releases

Community

Chat on Discord Follow on Twitter Follow on Github GitHub discussions

Project

Mantine UI Documentation Github organization npm organization

Built by Vitaly Rtishchev and these awesome people

Join Discord community

Follow Mantine on Twitter