Skip to content

docs: correct toggle function in lifecycle hooks example #15486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 10, 2025

Conversation

fuuki12
Copy link
Contributor

@fuuki12 fuuki12 commented Mar 10, 2025

This is my first contribution to the Svelte project.

Fix toggle function in lifecycle hooks example

Issue

Fix for Issue #15404 where the theme toggle callback function in the lifecycle hooks documentation was using an undefined toggleValue variable.

Changes

  • Modified the toggle() function to correctly toggle the theme state variable
  • Changed from using undefined toggleValue to properly using the existing theme variable
  • Made the implementation match the 'After' playground example code

Testing

Verified that the modified example code is now consistent with the correct implementation shown in the "After" playground link.

This PR ensures that users following the documentation won't encounter undefined variable errors when implementing dark mode toggling.

Fixes #15404

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

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.
  • If this PR changes code within packages/svelte/src, add a changeset (npx changeset).

Tests and linting

  • Run the tests with pnpm test and lint the project with pnpm lint

Copy link

changeset-bot bot commented Mar 10, 2025

⚠️ No Changeset found

Latest commit: d518274

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Rich-Harris Rich-Harris merged commit dbd4617 into sveltejs:main Mar 10, 2025
@Rich-Harris
Copy link
Member

whoops! thanks

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.

Documentation: Lifecycle hooks example is wrong
2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy