Docs: Add UPGRADE guide for version 3 #402
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for cookie-consent-manager ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
OndraM
force-pushed
the
docs/upgrade-guide-v3
branch
3 times, most recently
from
8053b5b to
0151d80
Compare
OndraM
force-pushed
the
docs/upgrade-guide-v3
branch
from
0151d80 to
94c2dca
Compare
OndraM
force-pushed
the
docs/upgrade-guide-v3
branch
from
94c2dca to
c1af73c
Compare
literat
reviewed
Jan 10, 2025
| Release 3.0 includes backward-incompatible changes, including changes in the underlying vanilla-cookieconsent library, | ||
| which has also been upgraded from version 2 to 3. | ||
|
|
||
| This guide summarizes relevant changes in both `almacareer/cookie-consent` and `(vanilla-cookieconsent)[https://github.com/orestbida/cookieconsent]` |
There was a problem hiding this comment.
suggestion:
Suggested change
| This guide summarizes relevant changes in both `almacareer/cookie-consent` and `(vanilla-cookieconsent)[https://github.com/orestbida/cookieconsent]` | |
| This guide summarizes relevant changes in both `@almacareer/cookie-consent` and `(vanilla-cookieconsent)[https://github.com/orestbida/cookieconsent]` |
literat
reviewed
Jan 10, 2025
| This guide summarizes relevant changes in both `almacareer/cookie-consent` and `(vanilla-cookieconsent)[https://github.com/orestbida/cookieconsent]` | ||
| library to help you upgrade your codebase. | ||
|
|
||
| ## Library npm namespace changed to `@almacareer` |
There was a problem hiding this comment.
suggestion:
Suggested change
| ## Library npm namespace changed to `@almacareer` | |
| ## Library npm scope changed to `@almacareer` |
Technically, it is a scope - https://docs.npmjs.com/cli/v9/using-npm/scope
literat
reviewed
Jan 10, 2025
| +"@almacareer/cookie-consent": "^3.0.0" | ||
| ``` | ||
|
|
||
| If you use the library via CDN, update URL to styles and script: |
There was a problem hiding this comment.
suggestion:
Suggested change
| If you use the library via CDN, update URL to styles and script: | |
| If you use the library via CDN, update the URL to styles and script: |
literat
reviewed
Jan 10, 2025
|
|
||
| Also, the typescript type has been renamed from `LmcCookieConsentManager` to `CookieConsentManager`. | ||
|
|
||
| ## Data attribute to open the cookie preference window changed |
There was a problem hiding this comment.
suggestion:
Suggested change
| ## Data attribute to open the cookie preference window changed | |
| ## The data attribute to open the cookie preference window has changed |
literat
reviewed
Jan 10, 2025
|
|
||
| ## Data attribute to open the cookie preference window changed | ||
|
|
||
| The `data-cc` attribute used to open the cookie settings window has been changed from `c-settings` to `show-preferencesModal`. |
There was a problem hiding this comment.
suggestion:
Suggested change
| The `data-cc` attribute used to open the cookie settings window has been changed from `c-settings` to `show-preferencesModal`. | |
| The `data-cc` attribute that opened the cookie settings window has been changed from `c-settings` to `show-preferencesModal`. |
literat
reviewed
Jan 10, 2025
| ``` | ||
|
|
||
| > [!NOTE] | ||
| > It is legally required to provide the user a link to change cookie preferences even after the consent was given for the first time. |
There was a problem hiding this comment.
suggestion:
Suggested change
| > It is legally required to provide the user a link to change cookie preferences even after the consent was given for the first time. | |
| > It is legally required to provide the user with a link to change cookie preferences even after the first consent is given |
literat
reviewed
Jan 10, 2025
| ## Cookie has been renamed | ||
|
|
||
| The cookie storing the consent data has been changed from `lmc_ccm` to `almacareer_ccm`. If you directly read the cookie value | ||
| (either on backend or on frontend), you need to update the cookie name. |
There was a problem hiding this comment.
suggestion:
Suggested change
| (either on backend or on frontend), you need to update the cookie name. | |
| (either on the backend or on the frontend), you need to update the cookie name. |
literat
reviewed
Jan 10, 2025
| > This is expected and inevitable behavior with this change, as there is no legal way to migrate the old cookie to the | ||
| > new one, as we technically can't transfer the validity period of the old consent to the new cookie. | ||
|
|
||
| ## Cookie content structure changed |
There was a problem hiding this comment.
suggestion:
Suggested change
| ## Cookie content structure changed | |
| ## The cookie content structure has changed |
literat
reviewed
Jan 10, 2025
| } | ||
| ``` | ||
|
|
||
| ## Data atribute to run third party scripts changed |
There was a problem hiding this comment.
suggestion:
Suggested change
| ## Data atribute to run third party scripts changed | |
| ## Data attribute to run third-party scripts has changed |
literat
reviewed
Jan 10, 2025
| To be in line with the `vanilla-cookieconsent` library terminology, the term "preferences" is used instead of "settings". | ||
| If you used `translationOverrides` configuration, the key `settingsModalMoreInfo` has been renamed to `preferencesModalMoreInfo`. | ||
|
|
||
| ## Secondary button mode config removed |
There was a problem hiding this comment.
suggestion:
Suggested change
| ## Secondary button mode config removed | |
| ## The secondary button mode config was removed |
literat
reviewed
Jan 10, 2025
|
|
||
| Configuration option `secondaryButtonMode` has been removed. | ||
|
|
||
| The consent dialog now always has primary button "Accept all" and secondary button "Accept necessary" |
There was a problem hiding this comment.
suggestion:
Suggested change
| The consent dialog now always has primary button "Accept all" and secondary button "Accept necessary" | |
| The consent dialog now always has a primary button "Accept all" and a secondary button "Accept necessary" |
literat
reviewed
Jan 10, 2025
| ## Other notable changes | ||
|
|
||
| - Legacy CommonJS support (CJS) has been removed. Use ESM import syntax instead. | ||
| - `cookieTable` configuration does not affect in any way any cookies. Cookie table is used only for listing the cookies in preferences modal. |
There was a problem hiding this comment.
suggestion:
Suggested change
| - `cookieTable` configuration does not affect in any way any cookies. Cookie table is used only for listing the cookies in preferences modal. | |
| - `cookieTable` configuration does not affect in any way any cookies. The cookie table is used only for listing the cookies in the preferences modal. |
|
I have run your docs through the Grammarly app and added some suggestions. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WIP, but should contain almost everything notable.