@scalar/api-reference-react
Advanced tools
npm install @scalar/api-reference-react
This package is compatible with React 19 and is untested on React 18. If you want guaranteed React 18 support please use
version 1.0.107 of this package.
The API Reference package is written in Vue. That shouldn’t stop you from using it in React, though. We have created a client side wrapper in React:
[!WARNING]
This is untested on SSR/SSG!
import { ApiReferenceReact } from '@scalar/api-reference-react'
import '@scalar/api-reference-react/style.css'
function App() {
return (
<ApiReferenceReact
configuration={{
spec: {
url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml',
},
}}
/>
)
}
export default App
We wrote a detailed integration guide for React, too.
You can find an example in this repo under examples/react
ApiReference only takes one prop which is the configuration object.
You can find the full configuration options under packages/api-reference.
We are API nerds. You too? Let’s chat on Discord: https://discord.gg/scalar
The source code in this repository is licensed under MIT.
FAQs
The react client only integration for api references
The npm package @scalar/api-reference-react receives a total of 6,007 weekly downloads. As such, @scalar/api-reference-react popularity was classified as popular.
We found that @scalar/api-reference-react demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.