/**
 * 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.
 *
 */

import {
  type CanIndentPredicate,
  registerTabIndentation,
} from '@lexical/extension';
import {useLexicalComposerContext} from '@lexical/react/LexicalComposerContext';
import {useEffect} from 'react';

export {registerTabIndentation};

/**
 * This plugin adds the ability to indent content using the tab key. Generally, we don't
 * recommend using this plugin as it could negatively affect accessibility for keyboard
 * users, causing focus to become trapped within the editor.
 *
 * This is a legacy plugin. When building an editor with the extension API,
 * configure {@link TabIndentationExtension} instead.
 */
export function TabIndentationPlugin({
  maxIndent,
  $canIndent,
}: {
  maxIndent?: number;
  /**
   * By default, indents are set on all elements for which the {@link ElementNode.canIndent} returns true.
   * This option allows you to set indents for specific nodes without overriding the method for others.
   */
  $canIndent?: CanIndentPredicate;
}): null {
  const [editor] = useLexicalComposerContext();
  useEffect(() => {
    return registerTabIndentation(editor, maxIndent, $canIndent);
  }, [editor, maxIndent, $canIndent]);

  return null;
}