@scalar/api-reference-editor
Advanced tools
Readme
Scalar API references with an integrated editor. The editor can be used in two ways:
You (optionally) provide an initial value and the editor will manage any changes internally.
<!doctype html>
<html>
<head>
<title>API Reference Editor</title>
<meta charset="utf-8" />
<meta
name="viewport"
content="width=device-width, initial-scale=1" />
<!-- TODO: Update import script -->
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference-editor"></script>
</head>
<body>
<div id="scalar-api-reference" />
<script>
import { mountApiReferenceEditable } from '@scalar/api-reference-editor'
mountApiReferenceEditable('#scalar-api-reference')
</script>
</body>
</html>
To have additional control over when the references are updated you can provide a configuration.spec.content value and then handle the custom event that is emitted from the Editor component. A handler can be passed directly to the mountApiReferenceEditable function or you can attach an event listener for scalar-update to the mounted div.
If you wish to have external UI that updates the spec then updateSpecValue can be used to force update the content.
<!doctype html>
<html>
<head>
<title>API Reference Editor</title>
<meta charset="utf-8" />
<meta
name="viewport"
content="width=device-width, initial-scale=1" />
<!-- TODO: Update import script -->
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference-editor"></script>
</head>
<body>
<div id="scalar-api-reference" />
<script>
import { mountApiReferenceEditable } from '@scalar/api-reference-editor'
const externalState = {
value: ''
}
const { updateSpecValue} = mountApiReferenceEditable(
'#scalar-api-reference',
{ spec: {content: ''}},
(v: string) => {
console.log('The value is updated!')
updateSpecValue(v) // Updates the rendered spec
externalState.value = v
}
)
</script>
</body>
</html>
FAQs
Editer interface for OpenAPI specs
The npm package @scalar/api-reference-editor receives a total of 323 weekly downloads. As such, @scalar/api-reference-editor popularity was classified as not popular.
We found that @scalar/api-reference-editor demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 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.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.