Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RFR] Convert RichTextInput to a functional component #3875

Merged
merged 1 commit into from
Oct 28, 2019
Merged

[RFR] Convert RichTextInput to a functional component #3875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 121 additions & 132 deletions packages/ra-input-rich-text/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,153 +1,142 @@
import debounce from 'lodash/debounce';
import React, { Component } from 'react';
import React, { useRef, useEffect, useCallback } from 'react';
import PropTypes from 'prop-types';
import Quill from 'quill';
import { addField, FieldTitle } from 'ra-core';
import { useInput, FieldTitle } from 'ra-core';
import { InputHelperText } from 'ra-ui-materialui';
import { FormHelperText, FormControl, InputLabel } from '@material-ui/core';
import { withStyles } from '@material-ui/core/styles';
import { makeStyles } from '@material-ui/core/styles';

import styles from './styles';

export class RichTextInput extends Component {
lastValueChange = null;

static propTypes = {
addLabel: PropTypes.bool.isRequired,
classes: PropTypes.object,
input: PropTypes.object,
label: PropTypes.string,
meta: PropTypes.object,
options: PropTypes.object,
source: PropTypes.string,
toolbar: PropTypes.oneOfType([
PropTypes.array,
PropTypes.bool,
PropTypes.shape({
container: PropTypes.array,
handlers: PropTypes.object,
}),
]),
fullWidth: PropTypes.bool,
configureQuill: PropTypes.func,
};

static defaultProps = {
addLabel: true,
options: {}, // Quill editor options
record: {},
toolbar: true,
fullWidth: true,
};

componentDidMount() {
const {
input: { value },
toolbar,
options,
} = this.props;

this.quill = new Quill(this.divRef, {
const useStyles = makeStyles(styles);

const RichTextInput = ({
options = {}, // Quill editor options
record = {},
toolbar = true,
fullWidth = true,
configureQuill,
helperText = false,
label,
source,
resource,
variant,
margin = 'dense',
...rest
}) => {
const classes = useStyles();
const quillInstance = useRef();
const divRef = useRef();
const editor = useRef();

const {
id,
isRequired,
input: { value, onChange },
meta: { touched, error },
} = useInput({ source, ...rest });

const lastValueChange = useRef(value);

const onTextChange = useCallback(
debounce(() => {
const value =
editor.current.innerHTML === '<p><br></p>'
? ''
: editor.current.innerHTML;
lastValueChange.current = value;
onChange(value);
}, 500),
[]
);

useEffect(() => {
quillInstance.current = new Quill(divRef.current, {
modules: { toolbar, clipboard: { matchVisual: false } },
theme: 'snow',
...options,
});

if (this.props.configureQuill) {
this.props.configureQuill(this.quill);
if (configureQuill) {
configureQuill(quillInstance.current);
}

this.quill.setContents(this.quill.clipboard.convert(value));

this.editor = this.divRef.querySelector('.ql-editor');
this.quill.on('text-change', this.onTextChange);
}
quillInstance.current.setContents(
quillInstance.current.clipboard.convert(value)
);

componentDidUpdate() {
if (this.lastValueChange !== this.props.input.value) {
const selection = this.quill.getSelection();
this.quill.setContents(
this.quill.clipboard.convert(this.props.input.value)
editor.current = divRef.current.querySelector('.ql-editor');
quillInstance.current.on('text-change', onTextChange);

return () => {
quillInstance.current.off('text-change', onTextChange);
onTextChange.cancel();
quillInstance.current = null;
};
// eslint-disable-next-line react-hooks/exhaustive-deps
}, []);

useEffect(() => {
if (lastValueChange.current !== value) {
const selection = quillInstance.current.getSelection();
quillInstance.current.setContents(
quillInstance.current.clipboard.convert(value)
);
if (selection && this.quill.hasFocus()) {
this.quill.setSelection(selection);
if (selection && quillInstance.current.hasFocus()) {
quillInstance.current.setSelection(selection);
}
}
}

componentWillUnmount() {
this.quill.off('text-change', this.onTextChange);
this.onTextChange.cancel();
this.quill = null;
}

onTextChange = debounce(() => {
const value =
this.editor.innerHTML === '<p><br></p>'
? ''
: this.editor.innerHTML;
this.lastValueChange = value;
this.props.input.onChange(value);
}, 500);

updateDivRef = ref => {
this.divRef = ref;
};

render() {
const {
label,
source,
resource,
isRequired,
id,
classes = {},
margin = 'dense',
variant,
} = this.props;
const { touched, error, helperText = false } = this.props.meta;
return (
<FormControl
error={!!(touched && error)}
fullWidth={this.props.fullWidth}
className="ra-rich-text-input"
margin={margin}
>
{label !== '' && label !== false && (
<InputLabel shrink htmlFor={id} className={classes.label}>
<FieldTitle
label={label}
source={source}
resource={resource}
isRequired={isRequired}
/>
</InputLabel>
)}
<div
data-testid="quill"
ref={this.updateDivRef}
className={variant}
/>
{helperText || (touched && error) ? (
<FormHelperText
error={!!error}
className={!!error ? 'ra-rich-text-input-error' : ''}
>
<InputHelperText
error={error}
helperText={helperText}
touched={touched}
/>
</FormHelperText>
) : null}
</FormControl>
);
}
}

const RichTextInputWithField = addField(withStyles(styles)(RichTextInput));
}, [value]);

return (
<FormControl
error={!!(touched && error)}
fullWidth={fullWidth}
className="ra-rich-text-input"
margin={margin}
>
{label !== '' && label !== false && (
<InputLabel shrink htmlFor={id} className={classes.label}>
<FieldTitle
label={label}
source={source}
resource={resource}
isRequired={isRequired}
/>
</InputLabel>
)}
<div data-testid="quill" ref={divRef} className={variant} />
{helperText || (touched && error) ? (
<FormHelperText
error={!!error}
className={!!error ? 'ra-rich-text-input-error' : ''}
>
<InputHelperText
error={error}
helperText={helperText}
touched={touched}
/>
</FormHelperText>
) : null}
</FormControl>
);
};

RichTextInputWithField.defaultProps = {
fullWidth: true,
RichTextInput.propTypes = {
label: PropTypes.string,
options: PropTypes.object,
source: PropTypes.string,
toolbar: PropTypes.oneOfType([
PropTypes.array,
PropTypes.bool,
PropTypes.shape({
container: PropTypes.array,
handlers: PropTypes.object,
}),
]),
fullWidth: PropTypes.bool,
configureQuill: PropTypes.func,
};
export default RichTextInputWithField;

export default RichTextInput;
27 changes: 14 additions & 13 deletions packages/ra-input-rich-text/src/index.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import React from 'react';
import debounce from 'lodash/debounce';
import { render, fireEvent, waitForElement } from '@testing-library/react';
import { Form } from 'react-final-form';

import { RichTextInput } from './index';
import RichTextInput from './index';

let container;

Expand Down Expand Up @@ -30,12 +31,12 @@ describe('RichTextInput', () => {
const handleChange = jest.fn();
debounce.mockImplementation(fn => fn);
const { getByTestId, rerender } = render(
<RichTextInput
input={{
value: '<p>test</p>',
onChange: handleChange,
}}
meta={{ error: null }}
<Form
initialValues={{ body: '<p>test</p>' }}
onSubmit={jest.fn()}
render={() => (
<RichTextInput source="body" onChange={handleChange} />
)}
/>
);
const quillNode = await waitForElement(() => {
Expand All @@ -50,12 +51,12 @@ describe('RichTextInput', () => {
jest.runOnlyPendingTimers();

rerender(
<RichTextInput
input={{
value: '<p>test1</p>',
onChange: handleChange,
}}
meta={{ error: null }}
<Form
initialValues={{ body: '<p>test1</p>' }}
onSubmit={jest.fn()}
render={() => (
<RichTextInput source="body" onChange={handleChange} />
)}
/>
);

Expand Down