MathRender
provides a Swift package interface to the guts of iosMath
for displaying beautifully rendered math equations in iOS and MacOS applications. It typesets formulae written
using LaTeX in a UILabel
equivalent class. It uses the same typesetting rules as LaTeX and
so the equations are rendered exactly as LaTeX would render them.
MathRender
prepackages everything needed for direct access via the Swift Package Manager.
No need for complicated alien pods that never seem to work quite right.
It is similar to MathJax or
KaTeX for the web but for native iOS or MacOS
applications without having to use a UIWebView
and Javascript. More
importantly, it is significantly faster than using a UIWebView
.
Here are screenshots of some formulae that were rendered with this library:
More examples are included in EXAMPLES
MathRender
works on iOS 6+ or MacOS 10.8+ and requires ARC to build. It depends
on the following Apple frameworks:
- Foundation.framework
- CoreGraphics.framework
- QuartzCore.framework
- CoreText.framework
Additionally for iOS it requires:
- UIKit.framework
Additionally for MacOS it requires:
- AppKit.framework
MathRender
is available from MathRender.
To use it in your code, just add the https://github.com/mgriebling/MathRender.git path to
XCode's package manager.
The library provides a class MTMathUILabel
which is a UIView
that
supports rendering math equations. To display an equation simply create
an MTMathUILabel
as follows:
import MathRender
let label = MTMathUILabel()
label.latex = "x = \\frac{-b \\pm \\sqrt{b^2-4ac}}{2a}"
Adding MTMathUILabel
as a sub-view of your UIView
will render the
quadratic formula example shown above.
The following code creates a SwiftUI component called MathView
encapsulating the MTMathUILabel:
import SwiftUI
import MathRender
struct MathView: UIViewRepresentable {
@Binding var equation: String
@Binding var fontSize: CGFloat
func makeUIView(context: Context) -> MTMathUILabel {
let view = MTMathUILabel()
return view
}
func updateUIView(_ uiView: MTMathUILabel, context: Context) {
uiView.latex = equation
uiView.fontSize = fontSize
uiView.font = MTFontManager().termesFont(withSize: fontSize)
uiView.textAlignment = .right
uiView.labelMode = .text
}
}
If you need code that works with SwiftUI running natively under MacOS you'll need the following:
import SwiftUI
import MathRender
struct MathView: NSViewRepresentable {
@Binding var equation: String
@Binding var fontSize: CGFloat
func makeNSView(context: Context) -> MTMathUILabel {
let view = MTMathUILabel()
return view
}
func updateNSView(_ view: MTMathUILabel, context: Context) {
view.latex = equation
view.fontSize = fontSize
view.font = MTFontManager().termesFont(withSize: fontSize)
view.textColor = .textColor
view.textAlignment = .center
view.labelMode = .display
}
}
This is a list of formula types that the library currently supports:
- Simple algebraic equations
- Fractions and continued fractions
- Exponents and subscripts
- Trigonometric formulae
- Square roots and n-th roots
- Calculus symbos - limits, derivatives, integrals
- Big operators (e.g. product, sum)
- Big delimiters (using \left and \right)
- Greek alphabet
- Combinatorics (\binom, \choose etc.)
- Geometry symbols (e.g. angle, congruence etc.)
- Ratios, proportions, percents
- Math spacing
- Overline and underline
- Math accents
- Matrices
- Equation alignment
- Change bold, roman, caligraphic and other font styles (\bf, \text, etc.)
- Most commonly used math symbols
- Colors
The MathRenderDemo is a Swift version
of the Objective-C demo included in iosMath
that uses MathRender
as a Swift package dependency.
MTMathUILabel
supports some advanced configuration options:
You can change the mode of the MTMathUILabel
between Display Mode
(equivalent to $$
or \[
in LaTeX) and Text Mode (equivalent to $
or \(
in LaTeX). The default style is Display. To switch to Text
simply:
label.labelMode = .text
The default alignment of the equations is left. This can be changed to center or right as follows:
label.textAlignment = .center
The default font-size is 25pt. You can change it as follows:
label.fontSize = 30
The default font is Latin Modern Math. This can be changed as:
label.font = MTFontManager().termesFont(withSize:20)
This project has 3 fonts bundled with it, but you can use any OTF math
font. Note: I couldn't get the iosMath
Python script to work.
The default color of the rendered equation is black. You can change it to any other color as follows:
label.textColor = .red
It is also possible to set different colors for different parts of the
equation. Just access the displayList
field and set the textColor
on the underlying displays that you want to change the color of.
You can define your own commands that are not already predefined. This is similar to macros is LaTeX. To define your own command use:
MTMathAtomFactory.addLatexSymbol("lcm", value: MTMathAtomFactory.operator(withName: "lcm", limits: false))
This creates an \lcm
command that can be used in the LaTeX.
The MTMathUILabel
has contentInsets
for finer control of placement of the
equation in relation to the view.
If you need to set it you can do as follows:
label.contentInsets = UIEdgeInsets(top: 0, left: 10, bottom: 0, right: 20)
If the LaTeX text given to MTMathUILabel
is
invalid or if it contains commands that aren't currently supported then
an error message will be displayed instead of the label.
This error can be programmatically retrieved as label.error
. If you
prefer not to display anything then set:
label.displayErrorInline = true
Note this is not a complete implementation of LaTeX math mode. There are some important pieces that are missing and will be included in future updates. This includes:
- Support for explicit big delimiters (bigl, bigr etc.)
- Addition of missing plain TeX commands
MathRender
is available under the MIT license. See the LICENSE
file for more info.
This distribution contains the following fonts. These fonts are licensed as follows:
- Latin Modern Math: GUST Font License
- Tex Gyre Termes: GUST Font License
- XITS Math: Open Font License