react-native/packages/rn-tester/js/examples/Keyboard/KeyboardExample.js

/**
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @flow strict-local
 * @format
 */

'use strict';

import type {
  RNTesterModule,
  RNTesterModuleExample,
} from '../../types/RNTesterTypes';
import type {KeyboardEvent} from 'react-native';

import RNTesterText from '../../components/RNTesterText';
import * as React from 'react';
import {useEffect, useState} from 'react';
import {Keyboard, StyleSheet, View} from 'react-native';

type KeyboardEventViewerProps = {
  showEvent: 'keyboardWillShow' | 'keyboardDidShow',
  hideEvent: 'keyboardWillHide' | 'keyboardDidHide',
};

const KeyboardEventViewer = (props: KeyboardEventViewerProps): React.Node => {
  const {showEvent, hideEvent} = props;
  const [isShown, setIsShown] = useState(false);
  const [lastEvent, setLastEvent] = useState<?KeyboardEvent>();

  useEffect(() => {
    const subscription = Keyboard.addListener(showEvent, ev => {
      setIsShown(true);
      setLastEvent(ev);
    });
    return () => subscription.remove();
  }, [showEvent]);

  useEffect(() => {
    const subscription = Keyboard.addListener(hideEvent, ev => {
      setIsShown(false);
      setLastEvent(ev);
    });
    return () => subscription.remove();
  }, [hideEvent]);

  return (
    <View>
      <RNTesterText>
        <RNTesterText>Keyboard is </RNTesterText>
        {isShown ? (
          <RNTesterText style={styles.openText}>open</RNTesterText>
        ) : (
          <RNTesterText style={styles.closeText}>closed</RNTesterText>
        )}
      </RNTesterText>
      <View style={styles.eventBox}>
        <RNTesterText>
          {lastEvent
            ? JSON.stringify(lastEvent, null, 2)
            : 'No events observed'}
        </RNTesterText>
      </View>
    </View>
  );
};

const keyboardWillShowHideExample: RNTesterModuleExample = {
  title: 'keyboardWillShow / keyboardWillHide',
  platform: 'ios',
  render: () => (
    <KeyboardEventViewer
      showEvent="keyboardWillShow"
      hideEvent="keyboardWillHide"
    />
  ),
};

const keyboardDidShowHideExample: RNTesterModuleExample = {
  title: 'keyboardDidShow / keyboardDidHide',
  render: () => (
    <KeyboardEventViewer
      showEvent="keyboardDidShow"
      hideEvent="keyboardDidHide"
    />
  ),
};

const styles = StyleSheet.create({
  closeText: {
    color: 'red',
  },
  openText: {
    color: 'green',
  },
  eventBox: {
    marginTop: 10,
    padding: 5,
    borderWidth: StyleSheet.hairlineWidth,
  },
});

const KeyboardExample: RNTesterModule = {
  title: 'Keyboard',
  description: 'Demonstrates usage of the "Keyboard" static API',
  documentationURL: 'https://reactnative.dev/docs/keyboard',
  category: 'Basic',
  examples: [keyboardWillShowHideExample, keyboardDidShowHideExample],
};

export default KeyboardExample;