element-web/src/components/views/elements/Field.js

/*
Copyright 2019 New Vector Ltd

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import React from 'react';
import PropTypes from 'prop-types';
import classNames from 'classnames';
import sdk from '../../../index';

export default class Field extends React.PureComponent {
    static propTypes = {
        // The field's ID, which binds the input and label together.
        id: PropTypes.string.isRequired,
        // The element to create. Defaults to "input".
        // To define options for a select, use <Field><option ... /></Field>
        element: PropTypes.oneOf(["input", "select", "textarea"]),
        // The field's type (when used as an <input>). Defaults to "text".
        type: PropTypes.string,
        // The field's label string.
        label: PropTypes.string,
        // The field's placeholder string. Defaults to the label.
        placeholder: PropTypes.string,
        // Optional component to include inside the field before the input.
        prefix: PropTypes.node,
        // The callback called whenever the contents of the field
        // changes.  Returns an object with `valid` boolean field
        // and a `feedback` react component field to provide feedback
        // to the user.
        onValidate: PropTypes.func,
        // All other props pass through to the <input>.
    };

    constructor() {
        super();
        this.state = {
            valid: undefined,
            feedback: undefined,
        };
    }

    get value() {
        if (!this.refs.fieldInput) return null;
        return this.refs.fieldInput.value;
    }

    set value(newValue) {
        if (!this.refs.fieldInput) {
            throw new Error("No field input reference");
        }
        this.refs.fieldInput.value = newValue;
    }

    onChange = (ev) => {
        if (this.props.onValidate) {
            const result = this.props.onValidate(this.value);
            this.setState({
                valid: result.valid,
                feedback: result.feedback,
            });
        }
        // Parent component may have supplied its own `onChange` as well
        if (this.props.onChange) {
            this.props.onChange(ev);
        }
    };

    render() {
        const { element, prefix, onValidate, children, ...inputProps } = this.props;

        const inputElement = element || "input";

        // Set some defaults for the <input> element
        inputProps.type = inputProps.type || "text";
        inputProps.ref = "fieldInput";
        inputProps.placeholder = inputProps.placeholder || inputProps.label;

        inputProps.onChange = this.onChange;
        // make sure we use the current `value` for the field and not the original one
        if (this.value != undefined) {
            inputProps.value = this.value;
        }

        const fieldInput = React.createElement(inputElement, inputProps, children);

        let prefixContainer = null;
        if (prefix) {
            prefixContainer = <span className="mx_Field_prefix">{prefix}</span>;
        }

        let validClass;
        if (onValidate) {
            validClass = classNames({
                mx_Field_valid: this.state.valid === true,
                mx_Field_invalid: this.state.valid === false,
            });
        }

        const fieldClasses = classNames("mx_Field", `mx_Field_${inputElement}`, {
            // If we have a prefix element, leave the label always at the top left and
            // don't animate it, as it looks a bit clunky and would add complexity to do
            // properly.
            mx_Field_labelAlwaysTopLeft: prefix,
            [validClass]: true,
        });

        // handle displaying feedback on validity
        const Tooltip = sdk.getComponent("elements.Tooltip");
        let feedback;
        if (this.state.feedback) {
            feedback = <Tooltip
                tooltipClassName="mx_Field_tooltip"
                label={this.state.feedback}
            />;
        }

        return <div className={fieldClasses}>
            {prefixContainer}
            {fieldInput}
            <label htmlFor={this.props.id}>{this.props.label}</label>
            {feedback}
        </div>;
    }
}