@lark-project/ui-kit-plugin
Version:
Lark Project UI Kit Plugin
41 lines (40 loc) • 1.79 kB
TypeScript
/**
* Copyright (c) 2024 Lark Technologies Pte. Ltd.
*
* Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,provided that the above copyright notice and this permission notice appear in all copies.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
* DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
* ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
import { ForwardedRef } from 'react';
import type { RichTextEditorContent, RichTextEditorOptions } from '@lark-project/js-sdk';
import { IEditor, IRichTextEditorPopoverProps } from './RichTextEditorPopover';
export interface IRichTextEditorProps extends Pick<RichTextEditorOptions, 'imageUpload'> {
/**
* 空间 id，用于url、图片、mention等功能
*/
spaceId: string;
/**
* 富文本内容
*/
defaultValue?: Pick<RichTextEditorContent, 'doc'>;
/**
* 默认值 true ，如果想预览富文本请主动给组件加上editable={false}
*/
editable?: boolean;
/**
* 编辑类型，默认inline，popover为弹出式编辑
*/
editType?: 'inline' | 'popover';
/**
* editType 为 popover 时，对 popover 生效的 props
*/
editPopoverProps?: Omit<IRichTextEditorPopoverProps, 'defaultValue' | 'spaceId'> & {
ref?: ForwardedRef<IEditor | undefined>;
};
}