Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
By Sarah Gooding - Sep 30, 2024
@scalar/api-reference-editor
Advanced tools
API Reference Editor
Scalar API references with an integrated editor. The editor can be used in two ways:
Internal State Management
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>
External State Management
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 505 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.
Package last updated on 25 Sep 2024
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.
Related posts
Security News
Malicious “express-dompurify” npm Package Steals Browser and Cryptocurrency Wallet Data
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
By Socket Research Team - Sep 27, 2024
Security News
ENISA 2024 Threat Landscape Report Warns of Increasing State-Sponsored Supply Chain Attacks on Open Source Software
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.
By Sarah Gooding - Sep 27, 2024