CookieScript

https://help.cookie-script.com
Admin
CookieScript is a cookie consent management platform that helps websites create compliant cookie...
Tokens:121,430
Snippets:1,375
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install use-cookiescript-hook with yarn

Source: https://help.cookie-script.com/en/articles/33028-cookiescript-integration-for-react

Installs the use-cookiescript-hook package using yarn.

```bash
yarn add use-cookiescript-hook
```

--------------------------------

### Install use-cookiescript-hook with npm

Source: https://help.cookie-script.com/en/articles/33028-cookiescript-integration-for-react

Installs the use-cookiescript-hook package using npm.

```bash
npm install use-cookiescript-hook
```

--------------------------------

### Get available cookie categories with CookieScript.instance.categories()

Source: https://help.cookie-script.com/en/articles/30246-custom-functions

Returns an array of category keys currently available for the user to choose from. The example shows assigning the result to a variable and a comment illustrating the output.

```javascript
CookieScript.instance.categories()
```

```javascript
let categories = CookieScript.instance.categories();
// the variable categories is going to look
// somewhat like this:
// ['performance', 'targeting', 'functionality']
```

--------------------------------

### React component with CookieScript integration

Source: https://help.cookie-script.com/en/articles/33028-cookiescript-integration-for-react

Example React component that integrates CookieScript by calling useCookieScript with the installation banner URL and position option. Replace the placeholder with the actual URL from your CookieScript account.

```javascript
import useCookieScript from "use-cookiescript-hook";

const App = () => {
```

```javascript
  useCookieScript("{your installation banner URL from the account}", {
```

```javascript
    position: "head-top",
```

```javascript
  });
```

```javascript
  return (
    // Your React component JSX code here
  );
}
```

--------------------------------

### CookieScript.instance.show()

Source: https://help.cookie-script.com/en/articles/30246-custom-functions

Forces the Cookie Banner to appear.

```APIDOC
## CookieScript.instance.show()

### Description
Forces the Cookie Banner to appear. This is equivalent to clicking on the cookie badge.

### Method
Function call

### Endpoint
`CookieScript.instance.show()`

### Parameters
None

### Request Example
```javascript
CookieScript.instance.show()
```

### Response
No return value.
```

--------------------------------

### Listen to AcceptAll event

Source: https://help.cookie-script.com/en/articles/30242-custom-events

Listen for the global CookieScriptAcceptAll event or use the CookieScript.instance.onAcceptAll callback to run code when the user accepts all cookies.

```javascript
window.addEventListener('CookieScriptAcceptAll', function() {
    // your code here
});
```

```javascript
window.addEventListener('DOMContentLoaded', function(event) {
    CookieScript.instance.onAcceptAll = function() {
        // some code
    }
});
```

--------------------------------

### URL with language code example

Source: https://help.cookie-script.com/en/getting-started/cookie-consent-on-multi-language-website

Example URL containing '/it/' which triggers Italian translation when using the 'Website URL only' detection method.

```text
https://example.com/it/somepage.html
```

--------------------------------

### Listen to a CookieScript.Instance Accept event

Source: https://help.cookie-script.com/en/javascript-code-documentation/custom-events

Use the CookieScript.instance.onAcceptAll callback to receive category data when a user accepts cookies.

```javascript
window.addEventListener('DOMContentLoaded', function(event) {
    CookieScript.instance.onAcceptAll = function(data) {
        // data will include this object:
        // { categories: ['strict', 'functionality'] }
        
        // some code
    }
});
```

--------------------------------

### Example of multiple cookie categories

Source: https://help.cookie-script.com/en/common-issues/blocking-third-party-cookies-set-with-javascript

A script tag configured to require consent for both targeting and functionality categories.

```html
<script type="text/plain" data-cookiescript="accepted" data-cookiecategory="targeting functionality">
```

--------------------------------

### Listen to a CookieScript.Instance AcceptAll event

Source: https://help.cookie-script.com/en/javascript-code-documentation/custom-events

Use the CookieScript.instance.onAcceptAll callback within the DOMContentLoaded event to handle acceptance via the instance.

```javascript
window.addEventListener('DOMContentLoaded', function(event) {
    CookieScript.instance.onAcceptAll = function() {
        // some code
    }
});
```

--------------------------------

### Call useCookieScript hook

Source: https://help.cookie-script.com/en/articles/33028-cookiescript-integration-for-react

Calls the useCookieScript hook with the installation banner URL and optional configuration options.

```javascript
useCookieScript(url, options);
```
Tokens:
Raw