mdx-deck/docs/advanced.md

Advanced Usage

Custom MDX components

MDX Deck includes default components for MDX, but to provide custom components to the MDXProvider, add a components object to the theme.

// example theme
import Heading from './Heading'

export default {
  components: {
    h1: Heading,
  },
}

See the MDX docs for more or take a look at the default set of components as a reference.

Custom Provider component

A custom Provider component is useful for adding custom context providers in React or adding persistent UI elements to the entire deck.

To define a custom Provider component, you'll need to import it into your custom theme and set it using the key Provider like shown below:

// example theme.js
import Provider from './Provider'

export default {
  font: 'Georgia, serif',
  Provider,
}

A custom Provider component will receive the application's state as props, which can be used to show custom page numbers or add other elements to the UI.

Props

• slides: (array) the components for each slide
• index: (number) the current slide index
• mode: (string) the current mode (one of 'normal', 'presenter', or 'overview')
• step: (number) the current visible step in an Appear or Step component
• Each slide includes a meta object with a notes field when the Notes component is used within a slide

Example

The example below will display the current slide out of the total amount of slides.

// Example Provider.js
import React from 'react'

function AtTheBottomCenter ({ children }) {
  const css = {
    position: 'absolute',
    left: 0,
    right: 0,
    bottom: 0,
    color: #ffffff;
    textAlign: 'center',
  }

  return <div css={css}>
    {children}
  </div>
}

export function Provider ({ children, ...props }) {
  return <>
    {children}
    <AtTheBottomCenter>{props.index}/{props.slides.length}</AtTheBottomCenter>
  </>
}

Combining multiple mdx files

Unlike the official @mdx-js/loader, the @mdx-deck/loader exports an additional slides array of components instead of just the entire document. Multiple MDX files can be combined into a single presentation if the filesize is getting difficult to manage.

First create a couple .mdx files like any other MDX Deck file, with --- to separate the different slides.

# one.mdx

---

This is the first file

# two.mdx

---

This is the second file

Next, create a .js file to import and combine the two .mdx files.

// deck.js
// if you want to include a theme, you would export here:
// export { dark as theme } from 'mdx-deck/themes';

import { slides as one } from './one.mdx'
import { slides as two } from './two.mdx'

export const slides = [...one, ...two]

Then, point the MDX Deck CLI comment in your package.json to the deck.js file.

"scripts": {
  "start": "mdx-deck deck.js"
}

Custom webpack config

Webpack configuration files named webpack.config.js will automatically be merged with the built-in configuration, using webpack-merge. To use a custom filename, pass the file path to the --webpack flag.

// webpack.config.js example
module.exports = {
  module: {
    rules: [
      {
        test: /\.svg$/,
        use: [{ loader: 'babel-loader' }, { loader: 'react-svg-loader' }],
      },
    ],
  },
}

Careful: When overwriting the loader for mdx files, make sure to include the default loader from @mdx-deck/loader.

Custom Components

To build custom components that hook into internal MDX Deck state, you might want to use the following APIs:

• useSteps
• useDeck