feat(react): remove empty elements from rendering

[rpfaeffle]

This PR adds support for removing specified elements if they would be rendered empty

Maybe the naming of the property determining whether an empty element should be rendered or not could be changed, it's not as descriptive as it could be. (I did not find another name though)

[changeset-bot]

🦋 Changeset detected

Latest commit: c6be572

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@graphcms/rich-text-types	Patch
@graphcms/rich-text-react-renderer	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[jpedroschmitz]

Hey @KaterBasilisk6, thanks a lot for taking a look into this! I really appreciate your help with the project. ❤️

I've left a comment in #5 about this, but I think it would be better to remove empty headings since this will affect SEO, and we don't want this. About the other elements, I don't see any problem in rendering if empty.

Adding a prop for this may confuse new users, especially if we don't clarify what this is about and why it's important. That's why I prefer not to add a prop for this right now.

What do you think? We can keep your code and remove the prop you've added.

[rpfaeffle]

Hey @jpedroschmitz,

I see your point that a prop could confuse new users. I'm also seeing your point that checking headings would be enough.

The only enhancement to my code I would suggest would be writting a function instead of using filter or just looking into the first element to check for empty text elements, because this would decrease rendering time (worst case O(1), instead of O(n)) for styled headings (bold, italic, underlined).

Will you remove the prop or should I do it?

[jpedroschmitz]

You can remove it if you can.

I would also ask you to increase the size limit to 5kb here. This should fix the size workflow error.

[rpfaeffle]

Should I keep the list or should I remove it completly?

[jpedroschmitz]

Keep it. If we decide to add more elements to be checked, we can add them to the list.

It would be nice to add a note about this in the Readme also. Something like this:

By default, we remove empty headings from the elements list to prevent SEO issues.

[jpedroschmitz]

Thanks a lot for your help in this @KaterBasilisk6!

I'll be adding changesets and releasing it soon =D

[rpfaeffle]

You welcome @jpedroschmitz. I'm glad I was able to help.

[jpedroschmitz]

Hey @KaterBasilisk6, could you allow me to add commits?
You can do so by enabling edits from maintainers. Check this tutorial.

[rpfaeffle]

Hey @jpedroschmitz,

I thought I would have enabled it already. I reanabled it again.

[jpedroschmitz]

It worked now. No idea why, haha

Thanks again!