Known issues migrated from `svelte-email`

cmjoseph07 commented 4 months ago

Updated: March 23, 2024

List of known issues/request:

1. Error: Component.render(...) is no longer valid in Svelte 5 (#34)

Reason for Error: Svelte Docs: https://svelte-5-preview.vercel.app/docs/breaking-changes#components-are-no-longer-classes-server-api-changes
Problem location: https://github.com/carstenlebek/svelte-email/blob/master/src/lib/render.ts#L19

2. render and styleToString exports need file types (#28)

Reason for Error: Playwright test fails to import svelte-email.
Problem location: svelte-email/src/lib/index.ts

---------------------------------- REQUEST ----------------------------------

~~### 1. White Container background (#32)~~

Change Request: Update Container default background
Reasoning: To update bg on !important is required, no default to avoid (maybe? | needs testing)

2. Tailwind Support (#16)

Change Request: Allow ability to pass tw classes to components
Reasoning: Avoid end-users having to switch from TW to CSS in their project and cause styling confusion

~~### 3. Preview component maximum text length - RangeError: Invalid count value (#14)~~

Change Request: Error is not descriptive to users that exceed this value.
Reasoning: svelte-email/src/lib/components/Preview.svelte

socketopp commented 3 months ago

List of known issues/request:

1. Error: Component.render(...) is no longer valid in Svelte 5 (carstenlebek#34)

I just migrated to Svelte 5 in my hobby project and stumbled across error 1. If no one has already started, I wouldn't mind taking a stab at it.

alexbjorlig commented 3 months ago

Hi @cmjoseph07,

I could be interested in this project.

Could you maybe add a couple of words about your ideas for the project and what skills you would be looking for?

We could then maybe start looking for maintainers that have e-mail experience 🤔

I'm Alex, developer and founder at 21RISK. We have been using Sendgrid with their templates for a couple of years now, but I'm really looking for something like this library to insoruce emails and have them defined in version control.

cmjoseph07 commented 3 months ago

@socketopp

That would be awesome! Feel free to make a pull request if you get through this. I am going to try and knock some of these out this weekend so I will be around.

@alexbjorlig

I would say my main goal is similar to exa for ls. I want to ensure the project continues and stays up to date as svelte evolves. Additionally, I would like to turn it towards a community driven project where those involved can determine the scope.

At the current moment I am trying to catch up on all known issues from the previous project and will start implementing new features such as TypeScript support and such. I would love assistance from anyone with e-mail experience and look forward to expanding this project!

cmjoseph07 commented 3 months ago

UPDATE: March 23, 2024

Issue #14

Nothing much to note here, simply returning a more specific error message with a general tip on length recommendation as requested for the Preview component. Feel like returning better error messages is a no brainer as it also follows closer to docs description.

Issue #32

Small change of removing default bg color from Container component. As a general component email library I feel we should not enforce styles on people, instead give them building blocks and let them style as they see fit.

cmjoseph07 / svelty-email