MDX in React-Native!?

Rate this content
Bookmark

How to use MDX in React-Native to great effect and the challenges you didn't know you signed up for.

21 min
25 Oct, 2021

AI Generated Video Summary

This Talk is about the development of MDX, a combination of Markdown and JSX, by a freelance full stack JavaScript developer. MDX is a powerful technology that allows for the creation of interactive content within blog posts and supports React components. The speaker developed RnMDX, a proper and polished MDX library for React Native, which can be dropped into any React Native app. RnMDX provides solutions for common issues with Markdown content in React Native and allows for the rendering of MDX content into native views. Bringing MDX into native apps is now easier, and it can be used for various purposes, such as serving the app layout from a CMS or creating interactive online magazines or blogs.

1. Introduction to Full Stack Development with MDX

Short description:

Hi, I'm Daniel, a freelance full stack JavaScript developer from Finland. I build web apps from scratch to production, including UI, back end, API integration, databases, and servers. I also build React Native apps. This talk is about something I developed, challenges I faced, and the solution I put on NPM. MDX is a combination of Markdown and JSX. Markdown is a simple and standardized tool for creating formatted text, while JSX takes HTML to the next level. I took the leap and tried React.

Hi, I'm Daniel, a freelance full stack JavaScript developer from Finland. My definition of full stack is that I build web apps from scratch to production, meaning the UI and the styling thereof, back end with node, API integration, databases, servers, you name it.

I also build React Native apps and I continue to be amazed at how well my existing web experience can be applied in that area. It's such a normal thing to use a JavaScript or react specific library in React Native that instances where it isn't possible stand out.

Ah, good old NPM, the holy land of JavaScript developers, where I can usually find a package for whatever I need to do. NPM provides nice reusable solutions for sole challenge so that I can focus on the business logic, you know, what the app actually needs to do, without getting into the weeds of developing custom state managers or routers or styling solutions or whatever. But what if the thing you need doesn't exist on NPM? This is a talk about something which I took for granted to exist, but 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.

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 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 formatted text anywhere that accepts keyboard input. You don't need specialized word processing software for that anymore. 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.

I probably don't need to go into why React is great, since I'm speaking at a conference called React Advanced, but I do want to touch on JSX, which React introduced and popularized. Whereas Markdown simplified text formatting and made HTML unnecessary for these use cases, JSX takes HTML to the next level. When I got into programming, mixing HTML and JavaScript was a no-no. It was taboo, since these were separate concerns. You had your HTML, which you decorated with styles and scripts. Never the twain shall meet. 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.

2. JSX and Its Benefits

Short description:

JSX enables declarative code and a composition-based architecture, making it easy to compose self-contained components. HTML is static and not enough for modern applications. JSX allows for dynamic UIs without the need for server-side rendering or manipulating static HTML with JavaScript or JQuery.

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. 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 is a user experience that smells and tastes like the 90s. And when you try to manipulate static HTML with JavaScript or JQuery, it quickly turns into a game of Jenga with way too many people moving blocks around simultaneously.

In contrast, JSX makes it easy to compose self-contained components that include the logic, styling and layout that they need to accomplish their task. The UI is a product of the state and not something the developer needs to attend to separately. UIs can be quite complex without it all falling apart.

3. MDX: A Powerful Technology for Interactive Content

Short description:

MDX is a powerful technology that combines the capabilities of CSS, JavaScript, and Markdown. It allows for the creation of interactive and engaging content, such as demos and special highlighted text, within blog posts. MDX can serve any interactive content, making it easy for writers to incorporate multimedia components. It supports React components, enabling the inclusion of videos, 3D scenes, and more. While MDX is widely used in web development, its availability for React Native is limited.

MDX is what a combination of these technologies looks like. Instead of only having bold and italic, and maybe something else, you could have any effect that you can do with CSS and JavaScript. MDX really busts the floodgates of possibilities wide open. It's great for blogposts where you can add a demo in line with the text or use special highlighted text. Josh W. Como's blog is a great example. It talks about how he built it here.

And 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. We can do a 3D scene. This is from the React 3 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? So, 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.

4. Using MDX in React Native with the MDX Runtime

Short description:

The best way to use MDX in React Native is to use the MDX runtime. It runs markdown and React components at runtime, but caution must be taken with user-provided input. For my use case, I'm only using my dad's writing and my own React components.

I did some research, and the best way to use MDX in React Native is to use the MDX runtime. Which as the 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. Unless my dad really wants to flex his hacking skills, the risk here is pretty low.

5. Challenges in Rendering MDX on React Native

Short description:

To make MDX on React Native a reality, I needed to make markdown on React Native possible. Creating components that rendered MDX correctly on both Android and iOS was a significant challenge. I used the React Native markdown renderer library as a starting point and built native components for most markdown features.

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 height, among many other issues, memories of which I have repressed. I needed the components to look the same, in addition to good, on both Android and iOS. I used the React Native markdown renderer library which includes native markdown views as a starting point, and cobbled together native components for most markdown features.

6. MDX in React Native: Introducing RnMDX

Short description:

Finally, MDX in React Native! After waiting for someone to create a solution, I now realize that someone was me this whole time. Introducing RnMDX, a proper and polished MDX library for React Native. It can be dropped into any React Native app and render interesting and interactive content composed by editors, designers, and copywriters. RnMDX allows you to focus on your custom components without worrying about the markdown part. You can either render MDX content on the fly with the MDX runtime or pre-compile MDX into JavaScript with the RnMDX command line tool. If you want to go by the book, you can precompile your MDX into JavaScript and use it in your app like any other component. The core of the RNMDX library is the collection of Markdown components that fulfill the MD part of MDX.

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 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 code break, I continued developing the app and wanted to improve the MDX features specifically. 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 DuckDuckGo. 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. And the world is ready for a proper and polished MDX library for React Native. Introducing RnMDX. 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. The goal of RnMDX is to deliver ready-to-use React Native markdown components and allow the developer to focus on their custom components, which they want to use in MDX, without needing to worry about the markdown part. Then it either renders MDX content on the fly, with the MDX runtime, or pre-compiles MDX into JavaScript with the RnMDX command line tool. Rendering MDX with the MDX runtime is the easiest way to deploy MDX in React Native, and RnMDX makes it 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 the React components within it. So you need to make sure that it is trustworthy and won't get up to any funny business. I can't in good conscience recommend using the runtime, but if you can be sure about the trustworthiness of the content and don't mind the extra overhead, it is definitely the easiest way to go.

On the other hand, if you want to go by the book, you can precompile your MDX into JavaScript and use it in your app like any other component. This is, of course, more complicated, but it works much the same way as a React-based static site generator like Gatsby. The core of the RNMDX 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. And the styles may also be overridden by the user, just like the components. The Markdown components under styling was one of the challenges with creating this library.

7. Using RnMDX for Markdown in React Native

Short description:

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. Making all Markdown components look their best on both platforms out of the box is an area that requires continuous adjustments. RnMDX provides the command line tool and facilities for precompiling MDX into React Native components. The precompilation workflow requires a config file that specifies the content location and where the compiled components should end up. RnMDX allows for the rendering of MDX content into native views, making it simple and versatile. MDX now exists on React Native, and it can be used for various purposes, such as serving the app layout from a CMS or creating interactive online magazines or blogs with MDX articles and React components.

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, require continuous adjustments.

And as stated earlier, the right way to use MDX is to precompile the MDX into React Native components and RnMDX 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 content application, after all. Since we are working with native apps, this kind of static precompile 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 config file that tells the RnMDX 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.

So, how does RnMDX 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 RnMDX. 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. There's the color text, which is an inline component that wraps text. And then, we have color box, which is a block level component. We can give them props 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. 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.

So, without further ado, let's get back to the presentation. MDX now exists on React Native. Great! Now what? 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.

8. Bringing MDX into Native Apps

Short description:

Bringing MDX into native apps is now easier. React Native compatibility is required, but after that, simply point your native apps to your CMS to display articles in a mobile app. MDX can be used outside of magazine apps, such as in chat bot-type interfaces. Anywhere there is text, there is an opportunity to add original styling. npm libraries are valuable resources, and I sincerely thank contributors. RNMDX is my most ambitious npm package. If you can't find what you need, consider contributing your solution. Thanks for watching and I hope you find RNMDX useful.

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 show the articles in all the 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. If you have a chat bot-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 RNMDX useful.

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

React Advanced Conference 2022React Advanced Conference 2022
25 min
A Guide to React Rendering Behavior
React is a library for "rendering" UI from components, but many users find themselves confused about how React rendering actually works. What do terms like "rendering", "reconciliation", "Fibers", and "committing" actually mean? When do renders happen? How does Context affect rendering, and how do libraries like Redux cause updates? In this talk, we'll clear up the confusion and provide a solid foundation for understanding when, why, and how React renders. We'll look at: - What "rendering" actually is - How React queues renders and the standard rendering behavior - How keys and component types are used in rendering - Techniques for optimizing render performance - How context usage affects rendering behavior| - How external libraries tie into React rendering
React Summit Remote Edition 2021React Summit Remote Edition 2021
33 min
Building Better Websites with Remix
Remix is a new web framework from the creators of React Router that helps you build better, faster websites through a solid understanding of web fundamentals. Remix takes care of the heavy lifting like server rendering, code splitting, prefetching, and navigation and leaves you with the fun part: building something awesome!
React Advanced Conference 2022React Advanced Conference 2022
30 min
Using useEffect Effectively
Can useEffect affect your codebase negatively? From fetching data to fighting with imperative APIs, side effects are one of the biggest sources of frustration in web app development. And let’s be honest, putting everything in useEffect hooks doesn’t help much. In this talk, we'll demystify the useEffect hook and get a better understanding of when (and when not) to use it, as well as discover how declarative effects can make effect management more maintainable in even the most complex React apps.
React Summit 2022React Summit 2022
20 min
Routing in React 18 and Beyond
Concurrent React and Server Components are changing the way we think about routing, rendering, and fetching in web applications. Next.js recently shared part of its vision to help developers adopt these new React features and take advantage of the benefits they unlock.In this talk, we’ll explore the past, present and future of routing in front-end applications and discuss how new features in React and Next.js can help us architect more performant and feature-rich applications.
React Advanced Conference 2021React Advanced Conference 2021
27 min
(Easier) Interactive Data Visualization in React
If you’re building a dashboard, analytics platform, or any web app where you need to give your users insight into their data, you need beautiful, custom, interactive data visualizations in your React app. But building visualizations hand with a low-level library like D3 can be a huge headache, involving lots of wheel-reinventing. In this talk, we’ll see how data viz development can get so much easier thanks to tools like Plot, a high-level dataviz library for quick & easy charting, and Observable, a reactive dataviz prototyping environment, both from the creator of D3. Through live coding examples we’ll explore how React refs let us delegate DOM manipulation for our data visualizations, and how Observable’s embedding functionality lets us easily repurpose community-built visualizations for our own data & use cases. By the end of this talk we’ll know how to get a beautiful, customized, interactive data visualization into our apps with a fraction of the time & effort!

Workshops on related topic

React Summit 2023React Summit 2023
170 min
React Performance Debugging Masterclass
Featured WorkshopFree
Ivan’s first attempts at performance debugging were chaotic. He would see a slow interaction, try a random optimization, see that it didn't help, and keep trying other optimizations until he found the right one (or gave up).
Back then, Ivan didn’t know how to use performance devtools well. He would do a recording in Chrome DevTools or React Profiler, poke around it, try clicking random things, and then close it in frustration a few minutes later. Now, Ivan knows exactly where and what to look for. And in this workshop, Ivan will teach you that too.
Here’s how this is going to work. We’ll take a slow app → debug it (using tools like Chrome DevTools, React Profiler, and why-did-you-render) → pinpoint the bottleneck → and then repeat, several times more. We won’t talk about the solutions (in 90% of the cases, it’s just the ol’ regular useMemo() or memo()). But we’ll talk about everything that comes before – and learn how to analyze any React performance problem, step by step.
(Note: This workshop is best suited for engineers who are already familiar with how useMemo() and memo() work – but want to get better at using the performance tools around React. Also, we’ll be covering interaction performance, not load speed, so you won’t hear a word about Lighthouse 🤐)
React Advanced Conference 2021React Advanced Conference 2021
132 min
Concurrent Rendering Adventures in React 18
Featured WorkshopFree
With the release of React 18 we finally get the long awaited concurrent rendering. But how is that going to affect your application? What are the benefits of concurrent rendering in React? What do you need to do to switch to concurrent rendering when you upgrade to React 18? And what if you don’t want or can’t use concurrent rendering yet?

There are some behavior changes you need to be aware of! In this workshop we will cover all of those subjects and more.

Join me with your laptop in this interactive workshop. You will see how easy it is to switch to concurrent rendering in your React application. You will learn all about concurrent rendering, SuspenseList, the startTransition API and more.
React Summit Remote Edition 2021React Summit Remote Edition 2021
177 min
React Hooks Tips Only the Pros Know
Featured Workshop
The addition of the hooks API to React was quite a major change. Before hooks most components had to be class based. Now, with hooks, these are often much simpler functional components. Hooks can be really simple to use. Almost deceptively simple. Because there are still plenty of ways you can mess up with hooks. And it often turns out there are many ways where you can improve your components a better understanding of how each React hook can be used.You will learn all about the pros and cons of the various hooks. You will learn when to use useState() versus useReducer(). We will look at using useContext() efficiently. You will see when to use useLayoutEffect() and when useEffect() is better.
React Advanced Conference 2021React Advanced Conference 2021
174 min
React, TypeScript, and TDD
Featured WorkshopFree
ReactJS is wildly popular and thus wildly supported. TypeScript is increasingly popular, and thus increasingly supported.

The two together? Not as much. Given that they both change quickly, it's hard to find accurate learning materials.

React+TypeScript, with JetBrains IDEs? That three-part combination is the topic of this series. We'll show a little about a lot. Meaning, the key steps to getting productive, in the IDE, for React projects using TypeScript. Along the way we'll show test-driven development and emphasize tips-and-tricks in the IDE.
React Advanced Conference 2021React Advanced Conference 2021
145 min
Web3 Workshop - Building Your First Dapp
Featured WorkshopFree
In this workshop, you'll learn how to build your first full stack dapp on the Ethereum blockchain, reading and writing data to the network, and connecting a front end application to the contract you've deployed. By the end of the workshop, you'll understand how to set up a full stack development environment, run a local node, and interact with any smart contract using React, HardHat, and Ethers.js.
React Summit 2023React Summit 2023
151 min
Designing Effective Tests With React Testing Library
Featured Workshop
React Testing Library is a great framework for React component tests because there are a lot of questions it answers for you, so you don’t need to worry about those questions. But that doesn’t mean testing is easy. There are still a lot of questions you have to figure out for yourself: How many component tests should you write vs end-to-end tests or lower-level unit tests? How can you test a certain line of code that is tricky to test? And what in the world are you supposed to do about that persistent act() warning?
In this three-hour workshop we’ll introduce React Testing Library along with a mental model for how to think about designing your component tests. This mental model will help you see how to test each bit of logic, whether or not to mock dependencies, and will help improve the design of your components. You’ll walk away with the tools, techniques, and principles you need to implement low-cost, high-value component tests.
Table of contents- The different kinds of React application tests, and where component tests fit in- A mental model for thinking about the inputs and outputs of the components you test- Options for selecting DOM elements to verify and interact with them- The value of mocks and why they shouldn’t be avoided- The challenges with asynchrony in RTL tests and how to handle them
Prerequisites- Familiarity with building applications with React- Basic experience writing automated tests with Jest or another unit testing framework- You do not need any experience with React Testing Library- Machine setup: Node LTS, Yarn