C# definitions of ProseMirror's content model, the data structures used to represent and work with documents.
Install-Package ProseMirror.Model
Nuget package: https://www.nuget.org/packages/ProseMirror.Model/
This library contains only definition files, with no other dependencies. See ProseMirror.Serializer below for an example of deserialization.
Tools for serialize or deserialize ProseMirror's content model in C#.
Install-Package ProseMirror.Serializer
Nuget package: https://www.nuget.org/packages/ProseMirror.Serializer/
var json = "{ \"type\": \"doc\", \"content\": [ { \"type\": \"paragraph\", \"content\": " +
"[ { \"type\": \"text\", \"text\": \"Hello my first test \" }, ] } ] }";
var proseMirrorNode = Serializer.JSon.JSonSerializer.Deserialize<Node>(json);
var result = Serializer.JSon.JSonSerializer.Serialize(proseMirrorNode);ProseMirror allow to expand his model with custom nodes. For example, the reference node bellow is not native to ProseMirror:
{
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Hello my first test "
},
{
"type": "reference",
"attrs": {
"decorationChar": "@",
"referenceDocUid": "m71yUUjgsGKSaob90rp-2",
"text": "@Human.ArthurDent",
"assignmentId": 1
}
}]
}]
}This kind of nodes can be deserialized by adding one (or more) CustomNodeSelector:
public class ReferenceAttributes
{
public string DecorationChar { get; set; }
public string ReferenceDocUid { get; set; }
public string Text { get; set; }
public int? AssignmentId { get; set; }
}
public class ReferenceNode : CustomNode
{
public ReferenceAttributes Attrs { get; set; }
}
// ...
var proseMirrorNode = ProseMirrorSerializer.Deserialize<Node>(json,
new CustomNodeSelector<ReferenceNode>("reference"));If your custom node implementation need a constructor or need an initialization, you can use the CustomNodeSelector overload:
public class ReferenceNode
{
public ReferenceNode(int myParam)
{
// ...
}
}
// ...
var proseMirrorNode = ProseMirrorSerializer.Deserialize<Node>(json,
new CustomNodeSelector("reference", () => new ReferenceNode(42)));// MVC Core:
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers(opt =>
{
// ...
})
.AddNewtonsoftJson(o =>
{
o.SerializerSettings.UseProseMirror();
})
.AddControllersAsServices();
}
// SignalR:
public void ConfigureServices(IServiceCollection services)
{
services.AddSignalR(options =>
{
// ...
})
.AddHubOptions<MyHub>(options =>
{
// ...
})
.AddNewtonsoftJsonProtocol(opt =>
{
opt.PayloadSerializerSettings.UseProseMirror();
});
}Node node = /*...*/;
var resultHtml = ProseMirror.Serializer.Html.HtmlSerializer.Serialize(node);To serialize ProseMirror custom nodes or change the default behavior, it is possible to override the HtmlSerializer:
Node node = /*...*/;
var resultHtml = new CustomHtmlSerializer().ToHtml(node);Where CustomHtmlSerializer can be something like:
public class CustomHtmlSerializer : HtmlSerializer
{
protected override Html MapCustom<TNode>(CustomNode custom, TNode rootNode)
{
if (custom is ReferenceNode referenceNode)
return MapReferenceNode(referenceNode);
return base.MapCustom(custom, rootNode);
}
private static Html MapReferenceNode(ReferenceNode referenceNode)
{
var tag = Html.TextBlock(referenceNode?.Attrs?.Text, new InlineTag("strong", KeyValuePair.Create("class", "reference")));
return tag;
}
}Website: https://prosemirror.net/
If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are welcome. Please respect existing style in code.
