@lexical/react
Version:
This package provides Lexical components and hooks for React applications.
27 lines (26 loc) • 990 B
TypeScript
/**
* 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 LinkAttributes } from '@lexical/link';
type Props = {
validateUrl?: (url: string) => boolean;
attributes?: LinkAttributes;
};
/**
* Enables {@link LinkNode} support, registering the commands and transforms
* that toggle and normalize links. Pass `validateUrl` to restrict which URLs
* may be applied (which also enables automatic link creation when pasting a
* matching URL) and `attributes` to set defaults such as `target` or `rel`.
* The editor must have the {@link LinkNode} registered.
*
* This is a legacy plugin. When building an editor with the extension API,
* configure {@link LinkExtension} instead.
*
* @returns `null`, this plugin renders no DOM of its own.
*/
export declare function LinkPlugin({ validateUrl, attributes }: Props): null;
export {};