Skip to content
This repository has been archived by the owner on Sep 5, 2024. It is now read-only.

ShaMan123/react-native-math-view

Repository files navigation

react-native-math-view (READ ONLY)

NPM

This repo will not receive anymore updates and will be archived.

Refer to #97.

V3

A react native view used to easily display and handle math. The library doesn't use WebView.

MathView Example Lists Example MathText
Runner Lists Example MathText

Installation

npm install --save react-native-math-view OR yarn add react-native-math-view

react-native > 0.59

iOS:

Install react-native-svg

$ cd ios && pod install

Expo

Expo doesn't support native modules. You can use this library with react-native-svg (performance suffers a bit), see #19.

Errors during installation:

  1. Upgrade typescript
  2. If you're getting an error regarging compileMathjax you can disregard it as long as compiled mathjax successfully was printed to the console. If you're using yarn it's probable no logging will show.
  3. To be sure everything is compiled properly run the following command from the mathjax-full node_module directory of your project:
npm run compile

typescript errors can be safely disregareded.
see also #16

Getting Started

import MathView, { MathText } from 'react-native-math-view';

  return (
    ...
    	<MathView
	   math={'x=\\frac{-b\\pm\\sqrt{b^2-4ac}}{2a}'}
	/> 
	<MathView
	   math='\cos\left(x\right)=\frac{b}{c}'
	/> 
	<MathView
	   math='\cos\left(x=\frac{b}{c}'
	   renderError={({ error }) => <Text style={[{ fontWeight: 'bold' }]}>{error}</Text>}
	/> 
	<MathText
            value={`This text includes math notations and should be wrapped correctly for \\( \\alpha \\) and $\\beta$ within the view. \nThe following formula shouldn't be inline:$$x_{1,2} = {-b \\pm \\sqrt{b^2-4ac} \\over 2a}$$However the following formula should be inline with the text: \\( a^2 + b^2 = c^2 \\)`}
            direction="ltr"
            CellRendererComponent={<TouchableOpacity />}
        />
    ...
  );

TroubleShooting

  1. Make sure to properly escape all LaTeX strings (Syntax sensitive):

This occurs because when passing math={value}, value gets evaluated as opposed to math='LaTeX'.
It is cosidered best practice to avoid using math='LaTeX'.

        <MathView
-	   math='x=\\frac{-b\\pm\\sqrt{b^2-4ac}}{2a}'
+	   math='x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}'
	/> 
	
	//	OR
	
        <MathView
-	   math={'x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}'}
+	   math={'x=\\frac{-b\\pm\\sqrt{b^2-4ac}}{2a}'}
	/> 
  1. Try your LaTeX in the MathJax sandbox.
    You can run setMode('SVG') from dev console in order to render svg.

Running example app

From the project's directory run:

yarn --production=false
cd MathExample
yarn --production=false
npm run android

Implementation:

  • iOS native MathView - POC successful, need to implement native measuring. For now fallbacking to react-native-svg

  • Android MathView - native since V2, based on Android SVGImageView. Need to implement editable state.

Looking for Web support?

Check out react-math-view!

FollowUp

iOS editable math view

Native android math view

Web Math Editors -> MathLive looks very promising!

KaTeX - Math keypad that works with <WebView>. See this

React with LaTeX - using server side rendering to speed things up.

Writing math dynamically

SSR:
\Large x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}