@lvce-editor/api

Extension API for Lvce Editor extensions.

npm install @lvce-editor/api

import { activate, registerCommand } from '@lvce-editor/api'

export const main = () => {
  activate()
  registerCommand({
    id: 'example.hello',
    execute() {
      console.log('Hello from an extension')
    },
  })
}

The package is published as unbundled ESM with TypeScript declaration files, so extensions can bundle it with their own build tooling.

Electron extensions can create an off-screen web contents view. It stays hidden for the lifetime of the handle, and disposing the handle destroys its web contents.

import { createElectronWebContentsView } from '@lvce-editor/api'

const view = await createElectronWebContentsView({ url: 'https://example.com' })
const title = await view.executeJavaScript<string>('document.title')
await view.dispose()