redoc-material-ui
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

Material UI ReDoc

npm

This is a Material UI wrapper for ReDoc

The aim of this wrapper is to provide theming support for ReDoc's RedocStandalone using Material UI's Theme

Getting started

1. Install package

Install using npm:

npm i redoc-material-ui @material-ui/core react react-dom styled-components

2. Enjoy 😄

Usage as a React component

import the MuiRedocStandalone component to render the API definition

import { MuiRedocStandalone } from "redoc-material-ui";

and use it somewhere in your component:

<MuiRedocStandalone specUrl="url/to/your/spec" />

Material UI Theming

The component uses useTheme hook to get the Theme object for your components and apply it appropriately to the component

(Optional) Override your application's theme

You can also provide your own Material UI theme to the component

<MuiRedocStandalone specUrl="url/to/your/spec" theme={your_mui_theme} />

Readme

Keywords

Package Sidebar

Install

npm i redoc-material-ui

Weekly Downloads

2

Version

1.0.3

License

ISC

Unpacked Size

11.3 kB

Total Files

10

Last publish

Collaborators

  • elijah.kimani12