Skip to content

root tracking for macro components#3882

Merged
SteffenDE merged 3 commits intomainfrom
sd-macro-component-root
Jul 7, 2025
Merged

root tracking for macro components#3882
SteffenDE merged 3 commits intomainfrom
sd-macro-component-root

Conversation

@SteffenDE
Copy link
Collaborator

@SteffenDE SteffenDE commented Jul 7, 2025

Closes #3877.

I'm not sure though if we want this, since it would still fail if you do

# inside LiveComponent
def render(assigns) do
  ~H"""
  <script :type={ColocatedHook} ...>...</script>

  <div>
    ...
  </div>
  """
end

because the extra whitespace between the colocated hook and the div counts as text that sets root to false.

So in practice, this may not help much.

@josevalim
Copy link
Member

josevalim commented Jul 7, 2025

I thought we ignored whitespace?

Perhaps what we should do for now is simply to improve the error message. If we fail because of macro component being at root, we tell people to move it inside the root element.

@SteffenDE
Copy link
Collaborator Author

SteffenDE commented Jul 7, 2025

Maybe, but I don't see a straightforward way to differentiate between a macro component and any other reason for root being false. It would be easier to special case the code to prune whitespace if the macro component returned an empty string.

We pass trim: true to EEx, so I think by default any leading whitespace is ignored, but if the macro component is first and happens to return an empty string (removing itself) the whitespace afterwards is considered to be just regular whitespace in the template. We only ignore empty strings:

phoenix_live_view/lib/phoenix_live_view/tag_engine.ex

Lines 484 to 486 in eb161bb

defp handle_token([{:text, text, %{line_end: line, column_end: column}} | tokens], state) do
if text == "" do
continue(state, tokens)

@josevalim
Copy link
Member

josevalim commented Jul 7, 2025

Maybe we trim white space after a macro component that returns nothing at the root?

@SteffenDE
Copy link
Collaborator Author

SteffenDE commented Jul 7, 2025

Yep, that's what bfe39a7 does. Let me know if you're happy with that.

josevalim
josevalim reviewed Jul 7, 2025
View reviewed changes
@SteffenDE SteffenDE merged commit 26bb662 into main Jul 7, 2025
12 of 14 checks passed
@SteffenDE SteffenDE deleted the sd-macro-component-root branch July 7, 2025 20:22
zachdaniel pushed a commit to zachdaniel/phoenix_live_view that referenced this pull request Jul 9, 2025
@SteffenDE @zachdaniel
root tracking for macro components (phoenixframework#3882)
5eae5c5 
* root tracking for macro components

Closes phoenixframework#3877.

* prune text after empty macro component

* remove prune_text_after_slot
SteffenDE added a commit that referenced this pull request Jul 14, 2025
@SteffenDE
root tracking for macro components (#3882)
e0d08c6 
* root tracking for macro components

Closes #3877.

* prune text after empty macro component

* remove prune_text_after_slot
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@josevalim josevalim josevalim approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Collocated hooks triggering single root element protection on stateful components

2 participants

@SteffenDE @josevalim

Comments