@tidbcloud/codemirror-extension-basic-setup

Default basic configuration for codemirror.

This package depends on most of the codemirror core library packages and exports extension bundles to help set up a simple editor in a few lines of code.

Installation

``shell
npm install @tidbcloud/codemirror-extension-basic-setup
`

⚠️ You need to install its peer dependencies as well:

`shell
npm install @codemirror/state @codemirror/view @codemirror/autocomplete @codemirror/commands @codemirror/language @codemirror/lint @codemirror/search
`

Usage

`ts
import { EditorView } from '@codemirror/view'
import { EditorState } from '@codemirror/state'
import { basicSetup } from '@tidbcloud/codemirror-extension-basic-setup'

const editorView = new EditorView({
state: EditorState.create({
doc,
extensions: [
basicSetup({
foldGutter: false,
foldKeymap: false,
searchKeymap: true,
autocompletion: false
})
]
})
})
`

If you have used @tidbcloud/tisqleditor component, as it used basic-setup internally and has some default config values. To override the default values, you can use basicSetupOptions, it has a higher priority, and can config it like this:

`ts
import { EditorView } from '@codemirror/view'
import { EditorState } from '@codemirror/state'
import { createSQLEditorInstance } from '@tidbcloud/tisqleditor'

const editorInst = createSQLEditorInstance({
editorId,
doc,
basicSetupOptions: {
foldGutter: false,
foldKeymap: false,
searchKeymap: true,
autocompletion: false,
history: false
}
})
`

API

`ts
interface MinimalSetupOptions {
highlightSpecialChars?: boolean
history?: boolean
drawSelection?: boolean
syntaxHighlighting?: boolean

defaultKeymap?: boolean
historyKeymap?: boolean
}

interface BasicSetupOptions extends MinimalSetupOptions {
lineNumbers?: boolean
highlightActiveLineGutter?: boolean
foldGutter?: boolean
dropCursor?: boolean
allowMultipleSelections?: boolean
indentOnInput?: boolean
bracketMatching?: boolean
closeBrackets?: boolean
autocompletion?: boolean
rectangularSelection?: boolean
crosshairCursor?: boolean
highlightActiveLine?: boolean
highlightSelectionMatches?: boolean

closeBracketsKeymap?: boolean
searchKeymap?: boolean
foldKeymap?: boolean
completionKeymap?: boolean
lintKeymap?: boolean
}

const basicSetup: (options?: BasicSetupOptions) => Extension[]
const minimalSetup: (options?: MinimalSetupOptions) => Extension[]
``