Skip to content

Commit

Permalink
Add to changelog and README details on how to use customCategories (s…
Browse files Browse the repository at this point in the history
  • Loading branch information
notfelineit authored Dec 12, 2019
1 parent 79ce264 commit 8e21a8b
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

## 4.1.0(Dec 11, 2019)

### Added

- [#60](https://github.com/segmentio/consent-manager/pull/60) Add new `customCategories` option

## 4.0.1(Oct 10, 2019)

### Fixed
Expand Down
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Options:

##### implyConsentOnInteraction

**_ Breaking Change _** (versions < 3.0.0 will default this option `true`)
**_Breaking Change_** (versions < 3.0.0 will default this option `true`)

Type: `boolean`<br>
Default: `false` (as of 3.0.0)
Expand Down Expand Up @@ -240,6 +240,24 @@ Type: `PropTypes.node`

The content of the cancel dialog.

##### customCategories

Type: `PropTypes.object`<br>
Default: `undefined`

An object representing custom consent categories - mapping custom categories to Segment integrations, i.e:

```javascript
const customCategories = {
'New Category': {
purpose: 'A new consent category to capture more granular consent groupings',
integrations: ['Google Adwords (Classic)', 'Amplitude', 'Slack']
}
}
```

The values for `integrations` should be an integration's name (`integration.name`). You can find examples of that by going to `https://cdn.segment.com/v1/projects/<writeKey>/integrations`

#### Example

```javascript
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@segment/consent-manager",
"version": "4.0.1",
"version": "4.1.0",
"description": "Drop-in consent management plugin for analytics.js",
"keywords": [
"gdpr",
Expand Down

0 comments on commit 8e21a8b

Please sign in to comment.