mirror of
https://github.com/overleaf/overleaf.git
synced 2024-09-16 02:52:31 -04:00
e025088065
Add documentation for CodeMirror extensions GitOrigin-RevId: e5f07084173f201919272f9d46dcdaef4b817874
46 lines
1.3 KiB
TypeScript
46 lines
1.3 KiB
TypeScript
import type { Extension } from '@codemirror/state'
|
|
import CodeMirror, { CodeMirrorVim } from './bundle'
|
|
|
|
/**
|
|
* A custom extension that allows additional CodeMirror extensions to be provided by external code,
|
|
* e.g. browser extensions.
|
|
*/
|
|
export const thirdPartyExtensions = (): Extension => {
|
|
const extensions: Extension[] = []
|
|
|
|
window.dispatchEvent(
|
|
new CustomEvent('UNSTABLE_editor:extensions', {
|
|
detail: { CodeMirror, CodeMirrorVim, extensions },
|
|
})
|
|
)
|
|
|
|
Object.defineProperty(window, 'UNSTABLE_editorHelp', {
|
|
writable: false,
|
|
enumerable: true,
|
|
value: `
|
|
Listen for the UNSTABLE_editor:extensions event to add your CodeMirror 6
|
|
extension(s) to the extensions array. Use the exported objects to avoid
|
|
instanceof comparison errors.
|
|
|
|
Open an issue on http://github.com/overleaf/overleaf if you think more
|
|
should be exported.
|
|
|
|
This API is **unsupported** and subject to change without warning.
|
|
|
|
Example:
|
|
|
|
window.addEventListener("UNSTABLE_editor:extensions", function(evt) {
|
|
const { CodeMirror, extensions } = evt.detail;
|
|
|
|
// CodeMirror contains exported objects from the CodeMirror instance
|
|
const { EditorSelection, ViewPlugin } = CodeMirror;
|
|
|
|
// ...
|
|
|
|
// Any custom extensions should be pushed to the \`extensions\` array
|
|
extensions.push(myCustomExtension)
|
|
});`,
|
|
})
|
|
|
|
return extensions
|
|
}
|