Scalar API Client React

Installation

npm install @scalar/api-client-react

Usage

First we need to add the provider, you should add it in the highest place you have a unique spec.

import { ApiClientModalProvider } from '@scalar/api-client-react'
import '@scalar/api-client-react/style.css'

;<ApiClientModalProvider
  configuration={{
    spec: {
      url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
    },
  }}>
  {children}
</ApiClientModalProvider>

Then you can trigger it from anywhere inside of that provider by calling the useApiClientModal()

import { useApiClientModal } from '@scalar/api-client-react'

const client = useApiClientModal()

return (
  <button
    onClick={() => client?.open({ path: '/auth/token', method: 'get' })}>
    Click me to open the Api Client
  </button>
)

Check out the playground for a working example.

Community

We are API nerds. You too? Let’s chat on Discord: https://discord.gg/scalar

License

The source code in this repository is licensed under MIT.