Add blockSeparator option to clipboardTextSerializer core extension

[hivokas]

Please describe your changes

This PR adds blockSeparator option to clipboardTextSerializer core extension.

It will allow to override block separator (without copy pasting the entire extension from core) and add it to my editor.

import { extensions } from '@tiptap/core';

const editor = new Editor({
  extensions: [
    extensions.ClipboardTextSerializer.configure({
      blockSeparator: '\n',
    }),
  ],
});

How did you accomplish your changes

By making it possible to provide blockSeparator option to clipboardTextSerializer core extension.

How have you tested your changes

I've copied the implementation from this PR to my project and tested it with and without blockSeparator parameter.

How can we verify your changes

By doing this:

import { extensions } from '@tiptap/core';

const editor = new Editor({
  extensions: [
    extensions.ClipboardTextSerializer.configure({
      blockSeparator: '\n',
    }),
  ],
});

Remarks

If there is a better way to implement it, I'm open to it.

Checklist

• The changes are not breaking the editor
• Added tests where possible
• Followed the guidelines
• Fixed linting issues

Related issues

N/A

[netlify]

✅ Deploy Preview for tiptap-embed ready!

Name	Link
🔨 Latest commit	9c40720
🔍 Latest deploy log	https://app.netlify.com/sites/tiptap-embed/deploys/6613c340f68ec40008b28e22
😎 Deploy Preview	https://deploy-preview-5019--tiptap-embed.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[bdbch]

Nice idea!

const editor = new Editor({
  extensions: [
    extensions.ClipboardTextSerializer.configure({
      blockSeparator: '\n',
    }),
  ],
});

The extensions.ClipboardTextSerializer.configure approach looks weird though - since this is a core extension, maybe we should add the option to the editors EditorOptions object?

tiptap/packages/core/src/Editor.ts

Lines 56 to 78 in 6f6e49e

	public options: EditorOptions = {
	element: document.createElement('div'),
	content: '',
	injectCSS: true,
	injectNonce: undefined,
	extensions: [],
	autofocus: false,
	editable: true,
	editorProps: {},
	parseOptions: {},
	enableInputRules: true,
	enablePasteRules: true,
	enableCoreExtensions: true,
	onBeforeCreate: () => null,
	onCreate: () => null,
	onUpdate: () => null,
	onSelectionUpdate: () => null,
	onTransaction: () => null,
	onFocus: () => null,
	onBlur: () => null,
	onDestroy: () => null,
	}

That way users would not need to do some weird extension-merging-shenanigans to get the option down to the core extensions.

clipboardBlockSeparator: '\n' would be the option to set the option for the extension then?

[hivokas]

clipboardBlockSeparator: '\n' would be the option to set the option for the extension then?

Yes, this approach looks good to me. Will you implement this change?

[bdbch]

Since we only have less than 10 core extensions I'd think it's okay to just load them manually here – that way we can pass configurations down to them.

[bdbch]

@hivokas I added a commit that adds coreExtension options to the editor options props.

[bdbch]

@svenadlung since I also made changes here it would be best if you could also just review again :)

[hivokas]

Thanks @bdbch!