How to add options to list plugin?

[mstelz]

Reading the docs and trying a few different ways I am unsure as to how to add the options validLiChildrenTypes when invoking createListPlugin

Does anyone have an example?

Thanks!

[zbeyens]

See https://platejs.org/docs/plugin

[mstelz]

Hmm, I've read this it's not overly clear to me. Most other plugins you just add options as a parameter to the create, such as:

// works
createTablePlugin({ options: enableMerging: true });

// doesn't work
createListPlugin({ options: { validLiChildrenTypes: [ELEMENT_PARAGRAPH] }});

Are you saying that I need to redefine the plugin via the plugin factory with my own values such that this file is doing:

plate/packages/list/src/createListPlugin.ts

Line 29 in d1d028e

withOverrides: withList,

but with an options block? or supplying options to withOverrides ?

Sorry maybe I am just missing something without having my coffee yet

[zbeyens]

That's indeed tricky since the plugin is composed of two other ones. Here's how to do it:

plate/packages/list/src/transforms/toggleList.spec.tsx

Lines 72 to 80 in 8b3fc7d

	createListPlugin({
	overrideByKey: {
	[ELEMENT_UL]: {
	options: {
	validLiChildrenTypes: [ELEMENT_IMAGE],
	},
	},
	},
	}),

[mstelz]

Thank you!!! Missed the overrideByKey bit