README

React component wrapper for Mathquill

The original version of library is here! viktorstrate/react-mathquill

Example

Link to an example

/**
 * Editable component
 */
import React from 'react'
import EditableMathQuill, { addStyles as addMathquillStyles } from 'react-mathquill'

// inserts the required css to the <head> block.
// You can skip this, if you want to do that by your self.
addMathquillStyles()

export default class App extends React.Component {
  constructor() {
    this.state = {
      latex: '\\frac{1}{\\sqrt{2}}\\cdot 2',
    }
  }

  render() {
    return (
      <EditableMathQuill
        latex={this.state.latex} // Initial latex value for the input field
        onChange={mathField => {
          // Called everytime the input changes
          this.setState({ mathField.latex() })
        }}
      />
    )
  }
}

/**
 * Static component
 */
import React from 'react'
import StaticMathQuill, {
  addStyles as addMathquillStyles,
} from 'react-mathquill'

addMathquillStyles()

export default class App extends React.Component {
  constructor() {
    this.state = {
      latex: '\\frac{1}{\\sqrt{2}}\\cdot 2',
    }
  }

  render() {
    return (
      <StaticMathQuill
        latex={this.state.latex} // Initial latex value for the input field
      />
    )
  }
}

Documentation

MathQuillComponent (React Element)

Props

latex: String - Initial latex value for the input field
config: Object - A mathquill config object
onChange(mathField) - A function that is called on change events.
mathquillDidMount(mathField) - A function that is called when the Mathquill element is initalized.

Other props will be passed to the wrapping element, this can be useful for custom classNames or styles

addStyles (function)

This function, when called, will append a <style id="react-mathquill-styles"> tag to the <head> of the document. The style tag includes all the required styles for Mathquill to work.

This function is not necessary, provided you include the styles in another way. See Mathquill Docs - Download and Load

react-mathquill2

Usage no npm install needed!