@tidbcloud/tisqleditor
v0.0.6
Published
editor instance and editor cache
Downloads
15
Readme
@tidbcloud/tisqleditor
This package provides the SQLEditorInstance
and EditorCache
implementation.
SQLEditorInstance
creates EditorView instance with pre-configured extensions to make it available to edit SQL code, likes @codemirror/lang-sql
, @tidbcloud/codemirror-extension-sql-parser
, @tidbcloud/codemirror-extension-cur-sql
.
EditorCache
stores the SQLEditorInstance
in a map.
Installation
npm install @tidbcloud/tisqleditor
You need to install its peer dependencies as well.
npm install @codemirror/view @codemirror/state @codemirror/lang-sql
Usage
import { EditorCache, createSQLEditorInstance } from '@tidbcloud/tisqleditor'
const cache = new EditorCache()
const editorId = '1'
const editorInst = createSQLEditorInstance({
editorId,
doc: 'select * from test;'
})
cache.addEditor(editorId, editorInst)
The package pre-installs the sql-parser
and cur-sql
extensions default internally, you can use the following methods:
const curSql = editorInst.getCurStatements()
const allSqls = editorInst.getAllStatements()
const nearbySql = editorInst.getNearbyStatement()
API
createSQLEditorInstance
type CreateSQLEditorOptions = {
editorId: string
doc: string
basicSetupOptions?: BasicSetupOptions
sqlConfig?: SQLConfig
theme?: Extension
extraExts?: Extension
extraData?: {}
}
const createSQLEditorInstance: (
options: CreateSQLEditorOptions
) => SQLEditorInstance
SQLEditorInstance
class SQLEditorInstance {
editorId: string
editorView: EditorView
themeCompartment: Compartment
sqlCompartment: Compartment
extraData: {}
constructor(
editorId: string,
editorView: EditorView,
themeCompartment: Compartment,
sqlCompartment: Compartment,
extraData: {}
)
changeTheme(theme: Extension): void
changeSQLConfig(sqlConfig: SQLConfig): void
/* get all statements */
getAllStatements(): SqlStatement[]
/* get selected statements */
getCurStatements(): SqlStatement[]
/* get the nearest statement before the cursor */
getNearbyStatement(): SqlStatement | undefined
}
EditorCache
class EditorCache {
addEditor: (editorId: string, editor: SQLEditorInstance) => void
getEditor: (editorId: string) => SQLEditorInstance | undefined
deleteEditor: (editorId: string) => void
clearEditors: () => void
}