Skip to content

elijahkimani/redoc-material-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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} />

About

A material-ui wrapper for ReDoc

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published