Skip to content

Commit

Permalink
Merge pull request #21 from sandstorm/update-readme-contextual-consen…
Browse files Browse the repository at this point in the history
…t-only

TASK: Update Readme with new consent mode
  • Loading branch information
JamesAlias authored Mar 13, 2023
2 parents 5a52ce8 + ee524dc commit 8fbf31b
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ after the user consented.
- eel helpers to block elements (scripts and iframes) before the markup is sent to the client
- eel helper to place contextual consents for any part of the markup
- a easy way to configure blocking via yaml config supporting patterns to target elements in markup
- a contextual consent mode that does not show an initial banner/modal
- localization support via Yaml and/or Fusion
- data source providing all services e.g. as a dropdown in the inspector
- **an awesome cookie-consent provided by [Klaro](https://heyklaro.com/docs/)** :heart: directly bundled with this package
Expand Down Expand Up @@ -472,6 +473,17 @@ prototype(Sandstorm.CookiePunch:Consent) {
}
```

### Contextual Consent Only Mode
If you don't want to initially show the cookie banner or modal you can use the global `contextualConsentOnly` mode introduced with [version 4.4.0](https://github.com/sandstorm/Sandstorm.CookiePunch/releases/tag/4.4.0).

```yaml
Sandstorm:
CookiePunch:
consent:
contextualConsentOnly: true
mustConsent: false
```
## Troubleshooting
### iframes work after unblocking but are the wrong size or in the wrong place
Expand Down

0 comments on commit 8fbf31b

Please sign in to comment.