feat(jsx-email): add `bgImage` and `bgColor` props to `<Column>` - Githubissues

shellscape / jsx-email

Build emails with a delightful DX

https://jsx.email

MIT License

895 stars 28 forks source link

feat(jsx-email): add `bgImage` and `bgColor` props to `<Column>` #188

Closed lordelogos closed 2 months ago

lordelogos commented 2 months ago

Component / Package Name:

Column

This PR contains:

[ ] bugfix
[x] feature
[ ] refactor
[x] documentation
[ ] other

Are tests included?

[x] yes (bugfixes and features will not be merged without tests)
[ ] no

Breaking Changes?

[ ] yes (breaking changes will not be merged unless absolutely necessary)
[x] no

If yes, please include "BREAKING CHANGES:" in the first commit message body, followed by a description of what is breaking.

List any relevant issue numbers:

Description

For maximum client compatibility, it is advised to add the background image and color to the <td> tag

in HTML email, bgcolor is used to set the background color and background is used to set background images on the td tag.

Read more here

The bgColor and bgImage props are just wrappers around bgcolor and background respectively and it shifts the error handling within the library rather than to the end users (@ts-expect-error)