Hey everyone, live_monaco_editor is a new component to render the Monaco Editor in your app. Monaco is the editor that powers VSCode and is the editor we all use and love in Livebook.
It was created to be used on BeaconCMS Admin UI but it can be used in any app.
How it looks like
After installing the dep and adding its hook into live socket, you can have an editor as simple as:
<LiveMonacoEditor.code_editor value="# My Code Editor" />
It’s using monaco-loader to load assets dynamically at runtime keeping the bundle size really small. It may support importing local assets if that’s ever requested.
Is it ready for production?
It’s in the early stages but a new version to make it more stable will be released soon.
Roadmap
The top priority is delivering a great UX for editing Elixir and HEEx files with auto complete and features you’d expect from a code editor, similar to Livebook. Note that this project has no association with Livebook but that’s a source of inspiration thanks to Jonatan Kłosko.
Hey @Exadra37 that’s for Beacon and not LiveMonacoEditor but it will be replaced soon. To give you some context, earmark was failing to parse a bunch of markdown files and it won’t be fixed, which is fine since parsing markdown is complex and not all libraries supports all edge cases, so I’ve been experimenting with alternatives and the end goal is to not require an external dependency.
For my use case its working fine, but as the library author says, my approach isn’t idiomatic for the library, because its not returning an AST representation of what is being parsed, instead I am returning HTML… He says that he will think if he can address my use case in an idiomatic way for the library, thus maybe you also want to expose your use case to see what he as to say.
My project is pretty much parked since that post I made, but not because of the MD library, just because of lacking the time to work on it, thus I cannot tell if my approach will find issues/limitations as I try to do more with it.
my approach isn’t idiomatic for the library, because its not returning an AST representation of what is being parsed, instead I am returning HTML
It’s not much different than what I need so I may get into the same situation as you.
expose your use case to see what he as to say
I’m gonna reach out as soon as I get back to that We have 700+ pages written in Markdown for dockyard.com (blog posts) so that may be a good test for the library. Do you mind if I reach out to you as well when I get to implement that custom MD parser?
@leandrocp I am currently using this to build a collaborative text editor. I am running into an issue where when one user changes the text, I end up in a cascade of changes on all synced editors where the changes applied and un-applied.
I am using the #set_value/3 function to synchronise the changes as shown here
case socket.assigns.user_id == user_id do
true ->
{:noreply, socket}
_ ->
{:noreply,
socket
|> LiveMonacoEditor.set_value(new_code, to: "file_#{socket.assigns.collab_id}")}
end
I tried to use user_id to prevent this cascade but it didn’t work.
this.handleEvent("sync_editor", (payload) => {
if (this.editor.dataset.userId == payload.user_id) {
if (this.editor.getValue() != payload.code) {
this.editor.setValue(payload.code);
}
}
});
This is my sync editor function in the JS hook.
I am reading that some solutions include using a CRDT to track the changes, but before I commit to doing that I wanted to know if there are any other options