Skip to content

docs: docs for persisted prop of transition built-in component - #3483

Open
Laupetin wants to merge 1 commit into
vuejs:mainfrom
Laupetin:docs-for-transition-persisted-attribute
Open

Laupetin wants to merge 1 commit into
vuejs:mainfrom
Laupetin:docs-for-transition-persisted-attribute

Conversation

@Laupetin

@Laupetin Laupetin commented Oct 22, 2026 •

Copy link
Copy Markdown

Description of Problem

The Transition and TransitionGroup built-in components expose a persisted prop that is not included in the documentation, but in the shipped typescript types.
Therefore various code editors or IDEs suggest this prop but neither the shipped types nor the documentation explain what it does.

Proposed Solution

This PR adds documentation for the persisted prop of the Transition and TransitionGroup built-in components.
The text is taken from the corresponding comment in code (line breaks were adjusted to be readable and not overflow in rendered documentation):

https://github.com/vuejs/core/blob/0ff253bfba3ee8d3d65448bd44ad890fd01b0ecd/packages/runtime-core/src/components/BaseTransition.ts#L37-L42

Additional Information

I am not sure whether this prop is actually intended to be part of the public API.
If not, this PR can just be closed again.
However it may be a problem then that the typescript types for the props make editors suggest parts of an internal API then?

@netlify

netlify Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for vuejs ready!

Name Link
🔨 Latest commit 899b237
🔍 Latest deploy log https://app.netlify.com/projects/vuejs/deploys/6ad9e9daadb95afea5c7c4e6
😎 Deploy Preview https://deploy-preview-3483--vuejs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant