Document View Transition events fields about docs HOT 7 OPEN

ASIDE: @martrapp I see that this PR was released but with no changeset or docs, so I never saw it before merging. Is this also something we need to factor in to new view transitions docs? withastro/astro#10908

from docs.

Seems like a job for @martrapp to weigh in on? Martin, can you provide clarity/guidance here for whatever might be missing from docs perspective, and confirm that we have an exhaustive list here?

Then, would be happy to receive a PR to docs to document these properties!

from docs.

Hi @sarah11918, thank you for pinging!

As @Fryuni said, it would be good to have the event's properties and there purpose defined in the docs. Especially because they are already partly used in the examples. As discussed on discord, it might make sense to have the description in the reference section.

As nobody knows the view transition events better than @Fryuni, I can of course confirm that the list was exhaustive when the issue was opened. A new signal property was just added last week.

• signal: AbortSignal was added for both before-* events.
  Loaders can hook on this property to abort long running asynchronous work like fetch()
  Swaps can also observe the signal. A new navigation should always have precedence over the current one

What I also can add, as it may be less obvious:

• Astro's built-in animations support forward and back as value for directions. Other values are possible, but require some additional way to generate the necessary CSS.

• The info property has been added to mimic the NavigateEvent property of the same name in the Navigation API.

I would be happy to help with a PR, but I won't open one myself on this topic, as there are certainly better technical writers than me ;-)

from docs.

I would be happy to help with a PR, but I won't open one myself on this topic, as there are certainly better technical writers than me ;-)

Me as well! I'm happy to help, but there are better writers.

from docs.

Well, I can try writing something and then an actual good writer can make it readable 😆

from docs.

Go for it!! I have faith in you! (And, I have a red pen if that faith is misplaced...)

from docs.

Is this also something we need to factor in to new view transitions docs?

Once we make that "official" it would fit well to the description of the swap function in the astro:before-swap event

from docs.