emmet-monaco-es
v5.5.0
Published
emmet plugin for monaco-editor
Downloads
7,324
Maintainers
Readme
emmet-monaco-es
Emmet Support for Monaco Editor, based on vscode-emmet-helper
Advantage
- Almost the same as VSCode's built-in emmet, integrated with completion provider
- Various languages support
Install
$ npm install emmet-monaco-es
Usage
NOTE
The emmet
functionality was bound to language features not to a specific editor instance.
emmetHTML
works forHTML
compatible languages, likePHP
, forhtml
only by defaultemmetCSS
works forCSS
compatible languages, likeLESS
/SCSS
, forcss
only by defaultemmetJSX
works forJSX
compatible languages, likeJavaScript
/TypeScript
/MDX
, forjavascript
only by default
Follow this guide to make Monaco Editor support TSX
Initialize emmet should BEFORE all monaco editor instance creation
ESM
import { emmetHTML, emmetCSS, emmetJSX, expandAbbreviation, registerCustomSnippets } from 'emmet-monaco-es'
// `emmetHTML` , `emmetCSS` and `emmetJSX` are used the same way
const dispose = emmetHTML(
// monaco-editor it self. If not provided, will use window.monaco instead.
// This could make the plugin support both ESM and AMD loaded monaco-editor
monaco,
// languages needs to support html markup emmet, should be lower case.
['html', 'php'],
)
// run it if you want to dispose emmetHTML.
// NOTE: all languages specified will be disposed.
dispose()
// internal expand API, if you want to extend functionality with emmet
// check out the emmet repo https://github.com/emmetio/emmet for how to use it
expandAbbreviation('a', { type: 'markup', syntax: 'html' }) // <a href=""></a>
expandAbbreviation('fz14', { type: 'stylesheet', syntax: 'css' }) // font-size: 14px;
// register custom snippets
registerCustomSnippets('html', {
ull: 'ul>li[id=${1} class=${2}]*2{ Will work with html, pug, haml and slim }',
oll: '<ol><li id=${1} class=${2}> Will only work in html </ol>',
ran: '{ Wrap plain text in curly braces }',
})
Browser
<script src="https://unpkg.com/emmet-monaco-es/dist/emmet-monaco.min.js"></script>
<script>
// NOTE: monaco-editor should be loaded first
// see the above esm example for details
emmetMonaco.emmetHTML(monaco)
</script>
Limitation
Does NOT support Emmet for embed CSS inside HTML / JSX / TSX
License
MIT