内容丰富的SDK,React功能组件,打字稿和react-羽毛笔-无法访问羽毛笔历史记录?

时间:2020-11-12 13:54:23

标签: typescript react-hooks contentful react-quill

当我作为对Contentful SDK的Field修改实现时,我正在尝试更改react-quill的撤消/重做行为。该实现由https://github.com/contentful/create-contentful-app/tree/master/template上的模板描述。

天真地实现后,Ctrl-Z键盘快捷键会完全清除反应毛刺编辑器。在历史记录模块中实现userOnly: true可以解决此问题,但是我想使用工具栏中的按钮通过直接访问react-quill的增量和历史记录功能来控制撤消/重做行为。

我对https://github.com/contentful/create-contentful-app/blob/master/template/src/components/Field.tsx进行了如下修改:

import React, {useState, useEffect, useRef, createRef} from 'react';
import { Paragraph } from '@contentful/forma-36-react-components';
import { FieldExtensionSDK } from 'contentful-ui-extensions-sdk';
import ReactQuill from 'react-quill';
import 'react-quill/dist/quill.snow.css';

const formats = ['header','bold', 'italic', 'underline', 'strike', 'blockquote','list', 'bullet', 'indent','link', 'image', 'undo', 'redo'];

let icons = ReactQuill.Quill.import("ui/icons");

interface FieldProps { sdk: FieldExtensionSDK; }

let mainRef = React.createRef<ReactQuill>();

const Field = (props: FieldProps) => {
  const [value, setValue] = useState('');

  useEffect (()=> {
    // CMS update code here - removed for clarity
  }, [])

  const modules = {
    toolbar: {
      container: [
        [
          { 'header': [1, 2, false] }
        ],
        ['bold', 'italic'],
        [
          {'list': 'ordered'},
          {'list': 'bullet'}
        ],
        ['link'],
        ['image'],
        ['undo'],
        ['redo']
      ],
      handlers: {
        'undo': function () {
          console.log(mainRef.current)
        },
        'redo': function () {
          console.log(mainRef.current)
        }
      }
    },
    history: {
      delay: 200,
      maxStack: 500,
      userOnly: true
    }
  };

  return <div>
        <ReactQuill id='quillmain' modules={modules} formats={formats} theme="snow" value={value} onChange={setValue} ref={mainRef}/>
    </div>
  ;
};

export default Field;

上面定义的撤消和重做处理程序将成功触发-单击撤消或重做图标时,按照我创建的参考,我将获得ReactQuill实例当前状态的控制台输出:

console output

我想访问在https://quilljs.com/docs/modules/history/定义的历史记录模块控件,以便可以有效地调用诸如mainRef.current.history.undo()和redo()之类的东西。但是,如果我尝试在我的模块const声明中调用它们,就会遇到ReactQuill实例状态的麻烦:

console.log(mainRef.current.history)
>>
Object is possibly 'null'.  TS2531

试图强行解决问题没有帮助:

console.log(mainRef.current!.history)
>>
Property 'history' does not exist on type 'ReactQuill'.  TS2339

但是根据上面的屏幕截图,打印当前实例显示了history属性可用,我假设在声明const模块时还没有。将声明移至const模块之外无济于事-遇到相同的TS错误。

按照以下答案,How to create undo/redo buttons in Quill JS (react-quill)?似乎应该是可能的,但是我觉得受限于功能组件,打字稿和钩子的组合都是合谋阻止我使用react -用我需要的方式羽毛笔。

任何人都可以建议我如何访问ReactQuill实例,以便可以根据需要调用undo()和redo()函数,或者在这些限制下如何实现react-quill以便撤消功能按预期工作?

1 个答案:

答案 0 :(得分:0)

答案是useCallback。令人怀疑的是,内联函数导致组件的状态出现问题,但是useCallback允许声明内联函数,同时保持所需的反应羽毛行为。以下代码允许触发内联函数,同时保持所需的撤消/重做行为:

const modules = {
  toolbar: {
    container: [
      [
        { 'header': [1, 2, false] }
      ],
      ['bold', 'italic'],
      [
        {'list': 'ordered'},
        {'list': 'bullet'}
      ],
      ['link'],
      ['image'],
      ['undo'],
      ['redo']
    ],
    handlers: {
      'undo': React.useCallback(undoFunc => {
        console.log(mainRef.current) // DOES NOT BREAK QUILL STATE!
      }, [])
      'redo': function () {
        console.log(mainRef.current) // BREAKS QUILL STATE!
      }
    }
  },
  history: {
    delay: 200,
    maxStack: 500,
    userOnly: true
  }
};

使用useCallback而不是内联函数声明模块const可实现所需的行为。