Skip to content

feat(client): add onContentUpdated composition API#1620

Merged
meteorlxy merged 24 commits intovuepress:mainfrom
pengzhanbo:on-content-updated
Feb 23, 2025
Merged

feat(client): add onContentUpdated composition API#1620
meteorlxy merged 24 commits intovuepress:mainfrom
pengzhanbo:on-content-updated

Conversation

@pengzhanbo
Copy link
Copy Markdown
Member

@pengzhanbo pengzhanbo commented Dec 6, 2024 •
edited
Loading

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Provide a description in this PR that addresses what the PR is solving. If this PR is going to solve an existing issue, please reference the issue (e.g. close #123).

What is the purpose of this pull request?

  • Bug fix
  • New feature
  • Documentation update
  • Other

Description

When the markdown content changes, using the built-in Vue lifecycle hooks does not work well, so the onContentUpdated hook has been added to properly listen for changes in the content.

This applies to scenarios such as medium-zoom or photo-swipe that require reinitialization when the page content changes.

@pengzhanbo pengzhanbo mentioned this pull request Dec 6, 2024
Open
2 tasks
@coveralls
Copy link
Copy Markdown

coveralls commented Dec 6, 2024 •
edited
Loading

Pull Request Test Coverage Report for Build 13484345740

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 71.722%
Totals Coverage Status
Change from base Build 13484327275: 0.0%
Covered Lines: 648
Relevant Lines: 906
💛 - Coveralls

Mister-Hope
Mister-Hope previously approved these changes Dec 6, 2024
View reviewed changes
@Mister-Hope Mister-Hope requested a review from meteorlxy December 6, 2024 10:32
@Mister-Hope
Copy link
Copy Markdown
Member

Mister-Hope commented Dec 6, 2024

uepress/docs also needs a PR

@pengzhanbo
Copy link
Copy Markdown
Member Author

pengzhanbo commented Dec 6, 2024

uepress/docs also needs a PR

vuepress/docs#44

meteorlxy
meteorlxy requested changes Dec 11, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@meteorlxy meteorlxy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e2e tests are required

@pengzhanbo pengzhanbo changed the title feat(client): add onContentUpdated hooks feat(client): add markdown content hooks Dec 12, 2024
@pengzhanbo
Copy link
Copy Markdown
Member Author

pengzhanbo commented Dec 15, 2024

@meteorlxy @Mister-Hope
I have rewritten this PR and added relevant e2e tests referencing hmr, but it is not working properly in vite. Can you help me resolve this?

@Mister-Hope
Copy link
Copy Markdown
Member

Mister-Hope commented Feb 20, 2025 •
edited
Loading

I think the Vite behavior is expeceted.

Vite use cache header to let browser caches imported modules natively, and when you triggered a HMR, the page is reloaded with the updated module appended with a query t=currentTimeStamp, so it's expected that the root component are also being remounted.

In another word, onContentUpdate hook may never be called, and I think that's why VitePress is only providing a onContentUpdate hook.

The same behavior is observed with Vite Typescript template: https://stackblitz.com/edit/vitejs-vite-q2vxvna7?file=src%2Fcounter.ts&terminal=dev (tested locally as stackblitz perform hotload while editing), where HMR is triggered when modifying counter.ts

meteorlxy
meteorlxy reviewed Feb 21, 2025
View reviewed changes
Comment thread packages/client/src/composables/onContentUpdated.ts Outdated
meteorlxy
meteorlxy reviewed Feb 21, 2025
View reviewed changes
Comment thread packages/client/src/composables/index.ts
@pengzhanbo pengzhanbo requested a review from meteorlxy February 21, 2025 06:48
@meteorlxy meteorlxy changed the title feat(client): add markdown content hooks feat(client): add onContentUpdated composition API Feb 23, 2025
@meteorlxy meteorlxy merged commit cd7252f into vuepress:main Feb 23, 2025
@pengzhanbo pengzhanbo deleted the on-content-updated branch September 1, 2025 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@meteorlxy meteorlxy meteorlxy approved these changes

@Mister-Hope Mister-Hope Mister-Hope left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@pengzhanbo @coveralls @Mister-Hope @meteorlxy