58 lines
2.6 KiB
Markdown
58 lines
2.6 KiB
Markdown
<!-- NOTE: README.md is generated from src/README.md -->
|
||
|
||
# @codemirror/lang-angular [](https://www.npmjs.org/package/@codemirror/lang-angular)
|
||
|
||
[ [**WEBSITE**](https://codemirror.net/) | [**ISSUES**](https://github.com/codemirror/dev/issues) | [**FORUM**](https://discuss.codemirror.net/c/next/) | [**CHANGELOG**](https://github.com/codemirror/lang-angular/blob/main/CHANGELOG.md) ]
|
||
|
||
This package implements Angular Template language support for the
|
||
[CodeMirror](https://codemirror.net/) code editor.
|
||
|
||
The [project page](https://codemirror.net/) has more information, a
|
||
number of [examples](https://codemirror.net/examples/) and the
|
||
[documentation](https://codemirror.net/docs/).
|
||
|
||
This code is released under an
|
||
[MIT license](https://github.com/codemirror/lang-json/tree/main/LICENSE).
|
||
|
||
We aim to be an inclusive, welcoming community. To make that explicit,
|
||
we have a [code of
|
||
conduct](http://contributor-covenant.org/version/1/1/0/) that applies
|
||
to communication around the project.
|
||
|
||
## Usage
|
||
|
||
```javascript
|
||
import {EditorView, basicSetup} from "codemirror"
|
||
import {angular} from "@codemirror/lang-angular"
|
||
|
||
const view = new EditorView({
|
||
parent: document.body,
|
||
doc: `<p ng-init="name='Iris'">Hi {{ name }}</p>`,
|
||
extensions: [basicSetup, angular()]
|
||
})
|
||
```
|
||
|
||
## API Reference
|
||
|
||
<dl>
|
||
<dt id="user-content-angular">
|
||
<code><strong><a href="#user-content-angular">angular</a></strong>(<a id="user-content-angular^config" href="#user-content-angular^config">config</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a> = {}) → <a href="https://codemirror.net/docs/ref#language.LanguageSupport">LanguageSupport</a></code></dt>
|
||
|
||
<dd><p>Angular Template language support.</p>
|
||
<dl><dt id="user-content-angular^config">
|
||
<code><strong><a href="#user-content-angular^config">config</a></strong></code></dt>
|
||
|
||
<dd><dl><dt id="user-content-angular^config.base">
|
||
<code><strong><a href="#user-content-angular^config.base">base</a></strong>⁠?: <a href="https://codemirror.net/docs/ref#language.LanguageSupport">LanguageSupport</a></code></dt>
|
||
|
||
<dd><p>Provide an HTML language configuration to use as a base. <em>Must</em>
|
||
be the result of calling <code>html()</code> from <code>@codemirror/lang-html</code>,
|
||
not just any <code>LanguageSupport</code> object.</p>
|
||
</dd></dl></dd></dl></dd>
|
||
<dt id="user-content-angularlanguage">
|
||
<code><strong><a href="#user-content-angularlanguage">angularLanguage</a></strong>: <a href="https://codemirror.net/docs/ref#language.LRLanguage">LRLanguage</a></code></dt>
|
||
|
||
<dd><p>A language provider for Angular Templates.</p>
|
||
</dd>
|
||
</dl>
|