Add a rewrite callback to Editable.getContent()

First, I think the call to extractContent() in the Editable.getContent() function

https://github.com/livingdocsIO/editable.js/blob/58f9a24e39b21a6c501c9fb28ef837d8ca018edc/src/core.js#L270

should actually be

return content.extractContent(element, false)

to ensure that the argument keepUiElements is a boolean as defined in the function’s documentation:

https://github.com/livingdocsIO/editable.js/blob/58f9a24e39b21a6c501c9fb28ef837d8ca018edc/src/content.js#L80

Technically, undefined is a falsey value, but it’s just not clean 🤓

Request

I’d like to modify/clean up the content of the host element before it’s serialized to HTML by passing in a callback function. Without it, getContent() returns a serialized HTML which I need to parse into a DOM element, clean it up, and serialize it again… which isn’t great.

So, for example:

const content = editable.getContent(elem, function(e) { 
    // Modify and clean up `e`  where `e` is the cloned and scrubbed `elem`.
});

If you’re interested in adding a callback function parameter to getContent() then I can open a PR. (It’s not a big change, but quite useful!)

[jenstroeger]

I think working with a fragment is more in line with other code in this package (which works with fragments) and it avoids creating elements that have no other purpose than wrapping the fragment — in my use case I’d only unwrap the fragment again.

Either way, the boolean function parameter to content.extractContent() should be fixed.

[marcbachmann]

@peyerluk what do you think here? Return a div, which is easier to operate on or return a DocumentFragment, which supports easy insertion into the dom?

… Or just use the transform callback 😄