[Bug]: TextStyleOptions type error

[craig-bowers]

Which packages did you experience the bug in?

extension-text-style

What Tiptap version are you using?

2.0.2

What’s the bug you are facing?

https://tiptap.dev/examples/default

After converting the default example linked above to a .tsx file I got this typescript error:

I was able to get rid of the error in two ways so far:

1. Adding the 'types' property to the TextStyleOptions interface in the text-style.d.ts file

For reference, here is the color.d.ts file

2. Extending TextStyleOptions and then using the "as" keyword

...

I also looked at this page https://tiptap.dev/guide/typescript but I thought it might be for more custom extensions.

Should I stick with my #2 implementation, or should the types property get added directly to the TextStyleOptions type in the text-style.d.ts file?

What browser are you using?

Chrome

Code example

No response

What did you expect to happen?

This is only a typescript issue. It works fine in vanilla jsx.

Anything to add? (optional)

No response

Did you update your dependencies?

• Yes, I’ve updated my dependencies to use the latest version of all packages.

Are you sponsoring us?

• Yes, I’m a sponsor. 💖

[svenadlung]

@craig-bowers thx for reporting. You are right. Something seems to be messed up here since #3541. I'll talk with @bdbch in the next days how to address the issue and come back to you after.

[craig-bowers]

No problem. Thanks for looking into it!

[nk11dev]

Hi. I just started using TipTap in my project to see how it works, used code from demo examples and facing this type error too.

Are you planning to fix this? I think, the basic use of the plugin should not give such errors at the start, especially from examples code. It's the little things like that that make a great first impression.

[towfiqi]

Any update?

[towfiqi]

Ok, just checked the definition of TextStyleOptions and it looks like the types property has been renamed to HTMLAttributes.

Here is the definition:

 export interface TextStyleOptions {
    HTMLAttributes: Record<string, any>;
}

So, my understanding is it's not actually a bug. You just need to updated documentation.