Blazor component for Microsoft's Monaco Editor which powers Visual Studio Code.
Some less-frequently used Monaco Editor features are currently missing, but a good amount of the basic feature set is supported. The package is updated regularly to cover more features and use cases. Any contributions, comments or suggestions are greatly welcome. Please feel free to contact me at twitter/serdarciplak or via GitHub.
Current version of BlazorMonaco :
- Uses
Monaco Editor v0.46.0 - Supports
netstandard2.0,net5.0,net6.0,net7.0andnet8.0
You can see a working sample WebAssembly app here.
- Add the NuGet package to your Blazor project.
dotnet add package BlazorMonaco
// or
Install-Package BlazorMonaco
- Add the below script tags to your
index.htmlfile. Please note that these script tags must be placed before the script tag for theblazor.webassembly.jsfile.
<script src="_content/BlazorMonaco/jsInterop.js"></script>
<script src="_content/BlazorMonaco/lib/monaco-editor/min/vs/loader.js"></script>
<script src="_content/BlazorMonaco/lib/monaco-editor/min/vs/editor/editor.main.js"></script>- Everything resides in three namespaces. You can add the following using directives to your root
_Imports.razorfile, or any other place you may need them.
@using BlazorMonaco
@using BlazorMonaco.Editor
@using BlazorMonaco.Languages
- To add a new editor instance, you just need to add a
StandaloneCodeEditorcomponent in your razor file.
<StandaloneCodeEditor Id="my-editor-instance-id" />- To customize your editor instance's initial options, set the
ConstructionOptionsparameter of the instance, and provide a method that returns aStandaloneEditorConstructionOptionsinstance.
<StandaloneCodeEditor Id="my-editor-instance-id" ConstructionOptions="EditorConstructionOptions" />- Then, add that method to your razor file's
@codeblock and return aStandaloneEditorConstructionOptionsinstance with the values you need.
private StandaloneEditorConstructionOptions EditorConstructionOptions(StandaloneCodeEditor editor)
{
return new StandaloneEditorConstructionOptions
{
AutomaticLayout = true,
Language = "javascript",
Value = "function xyz() {\n" +
" console.log(\"Hello world!\");\n" +
"}"
};
}- You can subscribe to editor events (e.g.
OnDidKeyUporOnDidPaste) using the editor's event parameters.
<StandaloneCodeEditor Id="my-editor-instance-id" OnDidChangeCursorPosition="EditorDidChangeCursorPosition" />- Then, add your event listener method to your razor file's
@codeblock.
private void EditorDidChangeCursorPosition(CursorPositionChangedEvent eventArgs)
{
Console.WriteLine("EditorDidChangeCursorPosition");
}- To add a new diff editor instance, you just need to add a
StandaloneDiffEditorcomponent in your razor file.
<StandaloneDiffEditor Id="my-editor-instance-id" />-
StandaloneDiffEditorclass provides two properties namedOriginalEditorandModifiedEditorfor accessing the inner editor instances. You can use them like any otherStandaloneCodeEditorinstances. -
You can register to inner editors' events using the helper event parameters of the main
StandaloneDiffEditorinstance.
<StandaloneDiffEditor Id="my-editor-instance-id" OnKeyUpOriginal="OnKeyUpOriginal" OnKeyUpModified="OnKeyUpModified" />- There are 3 css selectors you can use to add/edit css styles for your editors.
- The main html element of all editor instances contains the
monaco-editor-containercss class. - The
Idvalue you set for your razor component is also set as the id of its html element. - You can provide a string in the
CssClassproperty of an editor instance. That value will be added to the class attribute of its html element.
- The main html element of all editor instances contains the
<StandaloneCodeEditor Id="my-editor-id" CssClass="my-editor-class" />.monaco-editor-container { /* for all editor instances */
height: 100px;
}
/* or */
#my-editor-id { /* for a specific editor instance */
height: 100px;
}
/* or */
.my-editor-class { /* for a specific editor instance */
height: 100px;
}
⚠️ Note :As an html element cannot set its height disregarding where it's placed in, BlazorMonaco cannot manage editor instance heights. So, if you don't do that yourself, editor instances may have a height of0pxand be invisible. Please don't forget to set your editor instance heights as you need.
Monaco Editor JavaScript library defines some methods in the global scope. As C# does not allow global methods, BlazorMonaco groups those methods in two static classes named BlazorMonaco.Editor.Global and BlazorMonaco.Language.Global. If you need to use a Monaco Editor method in the global scope, check where in the JavaScript library that method is, and search for it in the corresponding Global class. They're defined as static methods.
For example, you can use the SetTheme method as below.
await BlazorMonaco.Editor.Global.SetTheme(jsRuntime, "my-custom-theme");- If you've made changes to Monaco Editor, and need to use this edited version instead of the unmodified version packed with BlazorMonaco, just change the paths to monaco editor resources in your
index.htmlfile.
<script src="_content/BlazorMonaco/jsInterop.js"></script>
<script>var require = { paths: { vs: 'my-path/monaco-editor/min/vs' } };</script>
<script src="my-path/monaco-editor/min/vs/loader.js"></script>
<script src="my-path/monaco-editor/min/vs/editor/editor.main.js"></script>As BlazorMonaco is just a bridge between JavaScript and Blazor, you can use Monaco Editor's documentation.
After a major version update (like from v2.x.x to v3.x.x), you may need to make some changes in your integration. Please see the MIGRATE.md for details.
You can view the history and the changes in the CHANGELOG.md
MIT, see the LICENSE file for detail.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent