@@ -19,6 +19,22 @@ we have a [code of
1919conduct] ( http://contributor-covenant.org/version/1/1/0/ ) that applies
2020to communication around the project.
2121
22+ ## Usage
23+
24+ ``` javascript
25+ import {EditorView , basicSetup } from " codemirror"
26+ import {sql } from " @codemirror/lang-sql"
27+
28+ const view = new EditorView ({
29+ parent: document .body ,
30+ doc: ` select * from users where age > 20` ,
31+ extensions: [basicSetup, sql ()]
32+ })
33+ ```
34+
35+ Use ` sql({dialect: PostgreSQL}) ` or similar to select a specific SQL
36+ dialect.
37+
2238## API Reference
2339
2440<dl >
@@ -60,6 +76,10 @@ completed directly at the top level.</p>
6076 <code ><strong ><a href =" #user-content-sqlconfig.uppercasekeywords " >upperCaseKeywords</a ></strong >⁠ ; ?: <a href =" https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean " >boolean</a ></code ></dt >
6177
6278<dd ><p >When set to true, keyword completions will be upper-case.</p >
79+ </dd ><dt id =" user-content-sqlconfig.keywordcompletion " >
80+ <code ><strong ><a href =" #user-content-sqlconfig.keywordcompletion " >keywordCompletion</a ></strong >⁠ ; ?: fn(<a id =" user-content-sqlconfig.keywordcompletion^label " href =" #user-content-sqlconfig.keywordcompletion^label " >label</a >: <a href =" https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String " >string</a >, <a id =" user-content-sqlconfig.keywordcompletion^type " href =" #user-content-sqlconfig.keywordcompletion^type " >type</a >: <a href =" https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String " >string</a >) → <a href =" https://codemirror.net/docs/ref#autocomplete.Completion " >Completion</a ></code ></dt >
81+
82+ <dd ><p >Can be used to customize the completions generated for keywords.</p >
6383</dd ></dl >
6484
6585</dd >
@@ -234,7 +254,7 @@ Server</a>.</p>
234254<dd ><p ><a href =" https://en.wikipedia.org/wiki/PL/SQL " >PL/SQL</a > dialect.</p >
235255</dd >
236256<dt id =" user-content-keywordcompletionsource " >
237- <code ><strong ><a href =" #user-content-keywordcompletionsource " >keywordCompletionSource</a ></strong >(<a id =" user-content-keywordcompletionsource^dialect " href =" #user-content-keywordcompletionsource^dialect " >dialect</a >: <a href =" #user-content-sqldialect " >SQLDialect</a >, <a id =" user-content-keywordcompletionsource^uppercase " href =" #user-content-keywordcompletionsource^uppercase " >upperCase</a >⁠ ; ?: <a href =" https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean " >boolean</a > = false) → <a href =" https://codemirror.net/docs/ref#autocomplete.CompletionSource " >CompletionSource</a ></code ></dt >
257+ <code><strong><a href="#user-content-keywordcompletionsource">keywordCompletionSource</a></strong>(<a id="user-content-keywordcompletionsource^dialect" href="#user-content-keywordcompletionsource^dialect">dialect</a>: <a href="#user-content-sqldialect">SQLDialect</a>, <a id="user-content-keywordcompletionsource^uppercase" href="#user-content-keywordcompletionsource^uppercase">upperCase</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a> = false, <a id="user-content-keywordcompletionsource^build" href="#user-content-keywordcompletionsource^build">build</a>⁠?: fn(<a id="user-content-keywordcompletionsource^build^label" href="#user-content-keywordcompletionsource^build^label">label</a>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, <a id="user-content-keywordcompletionsource^build^type" href="#user-content-keywordcompletionsource^build^type">type</a>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>) → <a href="https://codemirror.net/docs/ref#autocomplete.Completion">Completion</a>) → <a href="https://codemirror.net/docs/ref#autocomplete.CompletionSource">CompletionSource</a></code></dt>
238258
239259<dd ><p >Returns a completion source that provides keyword completion for
240260the given SQL dialect.</p >
0 commit comments