How to use MDX in React-Native to great effect and the challenges you didn't know you signed up for.
This is a talk about something which I took for granted to exist, what was rude enough to not exist, the solution I developed, and the challenges I ran into along the way. And of course, I put it on NPM.
What is MDX?
[01:46] MDX is in the title of this talk, so what is MDX? It is a combination of two technologies: Markdown and JSX. I realize these two may be very familiar to this audience, but let's take a look at the strengths they each bring to the table and imagine what a team up might look like.
Content is king, and the ability to create and display content is hugely important for any application. If your content is text based, Markdown is a great tool to use as it provides everything you need while being very simple and easy to pick up for anyone. With Markdown, you can write formative text anywhere that accepts keyboard input. You don't need specialized word processing software for that anymore.
[02:35] Markdown is readable for humans as it is, but to actualize that formatting, you just need a Markdown renderer. Markdown is standardized and has been around for a while, so there are lots of libraries available for probably all programming languages and platforms. Markdown is almost as easy to render, at least to write due to again, being just plain text. Nowadays, we expect Markdown to be supported, and it feels as if that just happened overnight. One day, we had as many formatting languages as there were apps with text areas, and the next day Markdown was everywhere. Of course, people have worked hard on this, but it shows how important it was to unify and standardize these simple formatting features and how badly it was needed.
[04:13] When I first saw JSX, it was horrifying since it went against everything I had learned until that point, but I took the leap and tried React and I haven't looked back since. JSX enables declarative code and a composition-based architecture, where the structure of the application is involved in the business logic as a first-class citizen, rather than something separate and disconnected, which you need to surgically modify in order for it to reflect the current state of your app.
HTML is static and is, by itself, not enough for modern applications. Attempts have been made to make it more dynamic, some more successful than others. The server-side HTML rendering does work quite nicely, but once the markup arrives in the browser, it is still static and asking the server to do updates, which the client could do much easier and faster. It's a user experience that smells and tastes like the '90s.
[06:30] Josh W Comeau's blog is a great example. He talks about how he built it here. In fact, this very presentation is made with MDX. I borrowed a sparkly text effect from Josh's blog, dropped it right in, and it just works, but that's only scratching the surface. MDX makes it possible to serve any interactive content through, for example, a CMS as easily as serving text, making it possible for any writer to compose engaging multimedia content using components that the dev team produces.
It looks like this. It's mostly just Markdown, but what's that? A React component in the Markdown? Yes. This example is kind of simple. We can, of course, do any React component, like this video player. Here's Jay Foreman explaining the boroughs of London. It's a great video, but let's watch this later.
[07:34] We can do a 3D scene. This is from the react-three-fiber examples. Again, I dropped it right in and it just works. The possibilities are endless, at least for the web realm. But what about React Native?
I'm developing an app with my dad, who's a writer, and MDX is the perfect technology for bringing his content to life and making it interactive for users by weaving in engaging widgets and special formatting. I went forth to install the MDX library for React Native from NPM into our React Native app. MDX is React, React Native is React, so surely it exists, right? It didn't. I did some research and the best way to use MDX in React Native is to use the MDX Runtime, which as name implies, runs whatever you give it, like the Markdown and React components at Runtime. This is theoretically platform agnostic, as it needs to be fed the Markdown components that it should use. It comes with a huge, flashing caveat that it runs whatever you give it at Runtime. This thing should not be anywhere near user-provided input unless you enjoy getting hacked. For my use case, I'm only going to feed it my dad's writing and my own React components, and unless my dad really wants to flex his hacking skills, the risk here is pretty low.
[09:16] So, to make MDX on React Native a reality, I first needed to make Markdown on React Native a reality. MDX is primarily designed for web use and renders the Markdown into whatever a P, strong, or H1 tag is. React Native has no clue what to do with that. Creating these components was probably the biggest challenge I ran into during this endeavor, since MDX can be tricky with spacing and React Native styling can be tricky overall. I had to battle with cases where the line of text got cut off vertically and an inline component affected the line heights, among many other issues, memories of which I have repressed. I needed the components to look the same, in addition to being good on both Android and iOS.
I used the React Native Markdown renderer library, which includes Native Markdown views as a starting point, and coupled together Native components for most Markdown features. Finally, MDX in React Native. As we've established, there were no ready-to-go packages, so I put my first solution up as a gist. We did finish the first version of the app with an MDX solution largely based on what I published in the gist, but we still have much more ambitious plans for it. After a lengthy COVID break, I continued developing the app and wanted to improve the MDX feature specifically.
[10:52] Surely after all this time, someone else had also needed MDX in React Native and made a more polished library? Nope. After a few years, the search results for React Native MDX looks like this on Google. On Duck Duck Go. On Brave, and I even went to Bing. My quickly thrown together gist is still the best way to use MDX in React Native. After waiting for someone to create a solution, I now realize that someone was me this whole time. The world is ready for a proper and polished MDX library for React Native.
[11:40] Introducing RN-MDX. Some elbow grease later, and it is indeed real. It can be dropped into any React Native app, including Expo apps, and render interesting and interactive content composed by editors, designers, and copywriters.
[12:24] Rendering MDX with the MDX Runtime is the easiest way to deploy MDX in React Native, and RN-MDX makes even easier by providing working and sensible Markdown components integrated with MDX. You don't need anything else, just get the MDX content as a string from somewhere and throw it into the Runtime. Of course, this carries additional overhead and it is very insecure. The Runtime will execute the string that you give it, mounting and running direct components within it. So, you need to make sure that it is trustworthy and won't get up to any funny business.
[13:40] The core of the RN-MDX library is the collection of Markdown components that you need to fulfill the MD part of MDX. Continuing from the components I published in the gist and used in the app that started it all, I spent more time on them to make sure that all Markdown features are covered and that they make solid building blocks for any use case. It's also possible to override any of the Markdown components by providing your own implementation and assigning it to the key of the MDX feature that needs some special care in your particular application.
As for styling, the Markdown components can be styled with good old React Native stylesheet objects, or any library that extends them. The styles may also be overridden by the user, just like the components.
[14:42] The Markdown components and their styling was one of the challenges with creating this library. React Native can be finicky at times, so there are some common issues with Markdown content that I want this library to provide solutions to out of the box.
Spacing, line height, and font size, where the pixel size looks different between Android and iOS are just some of the challenges. Now, I'm pretty good with CSS, but this is what it felt like. Making all Markdown components look their best on both platforms out of the box is an area that has, and probably will, continue to require continuous adjustments.
[15:32] I stated earlier the right way to use MDX is to precompile the MDX into React Native components and RN-MDX provides the command line tool and all other facilities that you need for this workflow. Precompilation of remote CMS content is, of course, also possible. It is crucial for any kind of core application, after all. Since we are working with Native apps, this kind of static, precompiled workflow isn't as smooth as it is in the web world with, for example, Netlify, but it is viable using CodePush or Expo.
So, what you need for the precompilation workflow is a conflict file that tells the RN-MDX command line tool where the content can be found and where the compile components should end up. I'm still working on this workflow and all input on the subject is welcome.
How does RN-MDX look in practice?
[16:28] So, how does RN-MDX look in practice? I'm glad I asked. Here is a simple app using the Runtime method. Let's look at the demo.
Here, we have a very simple app. It's an Expo app, and I have imported RN-MDX. The render MDX component here takes the custom components that you want to use in your MDX and the MDX content as a string, then it just renders them into Native views. On the right, we have the MDX content that we are rendering. So, there's the color text, which is an inline component that wraps text, and then we have a color box, which is a block-level component. We can give them props like normal, like normal React components, and the result is here. Ta-da. Very simple. The red text, according to the prop value, which is red, and then different-colored boxes according to their prop types.
[17:43] So, it's very simple, it's versatile, and you can use it for pretty much anything. It doesn't impose a lot of restrictions that MDX or React Native doesn't impose. Without further ado, let's get back to the presentation.
[18:02] MDX now exists on React Native. Great. Now, what should you actually use this thing for? The short answer is whatever you want. It's another tool in your toolbox. You could serve the whole app layout from a CMS as MDX files if you want, but the first sensible use case that comes to mind is an interactive online magazine or blog, where the web version runs on Next or Gatsby and you already have a bunch of MDX articles with cool React components.
If you want to bring them into your Native app, that is now much easier. You would, of course, need to make the components React Native compatible, but after that it is just a matter of pointing your Native apps towards your CMS and showing the articles in all their glory in a mobile app. Mobile apps aren't really the best medium for long-form text, though. But that doesn't mean there are no opportunities to use MDX outside of magazine apps.
[19:09] If you have a chatbot type interface, the discussion can now involve any React component you implement. Anywhere there is text, there is at least an opportunity to add some original styling.
It's easy to take NPM libraries for granted. How often have you not found something you needed? It is a truly remarkable resource, and I want to sincerely thank everyone who contributes code, and more importantly time for the good of the whole extremely large community. This is not my first NPM package, but it is my most ambitious one yet. I'm actually quite surprised that it didn't exist. So, the next time you don't find something you need, consider contributing your solution. Turns out you were the one meant to do it all along. That's it for me. Thanks for watching, and I hope you find RN-MDX useful. I know I will.