Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
Signed-off-by: George J Padayatti <george.padayatti@igrant.io>
  • Loading branch information
georgepadayatti committed Apr 10, 2023
0 parents commit ac5b2db
Show file tree
Hide file tree
Showing 32 changed files with 5,467 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
97 changes: 97 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<h1 align="center">
Cookie Consent Manager
</h1>

<p align="center">
<a href="/../../commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/L3-iGrant/cookie-mgmnt?style=flat"></a>
<a href="/../../issues" title="Open Issues"><img src="https://img.shields.io/github/issues/L3-iGrant/cookie-mgmnt?style=flat"></a>
<a href="./LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=flat"></a>
</p>

[![](https://data.jsdelivr.com/v1/package/gh/L3-iGrant/cookie-mgmnt/badge)](https://www.jsdelivr.com/package/gh/L3-iGrant/cookie-mgmnt)

<p align="center">
<a href="#about">About</a> •
<a href="#contributing">Contributing</a> •
<a href="#licensing">Licensing</a>
</p>

## About

**Cookie Consent Manager** is a lightweight JavaScript plugin for alerting users about the use of cookies on your website.

It is designed to help you quickly comply with IAB/GDPR transparency and consent framework. We made it fast, free, and relatively painless.

We welcome community contributions and actively review pull requests.

## Screenshots

![CookieConsentManager__Sidebar](./screenshots/sideBar.png "Cookie Consent Manager Sidebar")

![CookieConsentManager__BottomBanner](./screenshots/bottomBanner.png "Cookie Consent Manager Bottom Banner" )

## Advantages

* **Free and Open Source**
* **Easy to use**
* **Flexible and customizable**: Manage consent for all possible types of
third-party apps and easily customize the tool according to your needs.
* **Small footprint**

## Configuration

You define (and create) your own configuration as a JavaScript Object, containing as many properties as you deem necessary.

Below is an example,

```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/L3-iGrant/cookie-mgmnt@2.0.0/dist/cookie-consent-ui.css" />
<script
id="cookie-consent-ui"
data-element-id="ccui"
data-banner-title="YOUR DATA, YOUR CHOICE"
data-banner-company-name="iGrant.io"
data-banner-company-link="https://igrant.io"
data-banner-cookie-policy-link="https://igrant.io/privacy.html"
data-banner-privacy-policy-link="https://igrant.io/privacy.html#privacy"
src="https://cdn.jsdelivr.net/gh/L3-iGrant/cookie-mgmnt@2.0.0/dist/cookie-consent-ui.js"
></script>
<script>
window.CookieConsentUI([
{
consent: true,
cookieCategory: "Essential Cookies",
cookieCategoryDescription:
"are necessary for this site to function properly, authenticating logins, for instance. You can only disable essential cookies via browser settings.",
cookiesUsed: ["PrivacyPolicy"],
},
{
consent: true,
cookieCategory: "Analytical Cookies",
cookieCategoryDescription:
"provide information about how this site is being used so we can improve your experience. Data captured is aggregated and anonymized.",
cookiesUsed: ["Analytics", "_ga", "_gid", "_gat"],
},
{
consent: false,
cookieCategory: "Advertising Cookies",
cookieCategoryDescription:
"are used for contextual ads from third parties.",
cookiesUsed: ["AdSense"],
},
]);
</script>
```

## Contributing

Feel free to improve the plugin and send us a pull request. If you found any problems, please create an Issue.

## Licensing
Copyright (c) 2023 LCubed AB (iGrant.io), Sweden

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.
51 changes: 51 additions & 0 deletions demo/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Demo: iGrant.io Cookie Consent UI</title>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/L3-iGrant/cookie-mgmnt@2.0.0/dist/cookie-consent-ui.css" />
</head>
<body style="margin: 20px 0px; background-color: wheat">
<div id="ccui"></div>

<script
id="cookie-consent-ui"
data-element-id="ccui"
data-banner-title="YOUR DATA, YOUR CHOICE"
data-banner-company-name="iGrant.io"
data-banner-company-link="https://igrant.io"
data-banner-cookie-policy-link="https://igrant.io/privacy.html"
data-banner-privacy-policy-link="https://igrant.io/privacy.html#privacy"
src="https://cdn.jsdelivr.net/gh/L3-iGrant/cookie-mgmnt@2.0.0/dist/cookie-consent-ui.js"
></script>
<script>
window.CookieConsentUI([
{
consent: true,
cookieCategory: "Essential Cookies",
cookieCategoryDescription:
"are necessary for this site to function properly, authenticating logins, for instance. You can only disable essential cookies via browser settings.",
cookiesUsed: ["PrivacyPolicy"],
isMandatory: true
},
{
consent: true,
cookieCategory: "Analytical Cookies",
cookieCategoryDescription:
"provide information about how this site is being used so we can improve your experience. Data captured is aggregated and anonymized.",
cookiesUsed: ["Analytics", "_ga", "_gid", "_gat"],
isMandatory: false
},
{
consent: false,
cookieCategory: "Advertising Cookies",
cookieCategoryDescription:
"are used for contextual ads from third parties.",
cookiesUsed: ["AdSense"],
isMandatory: false
},
]);
</script>
</body>
</html>
1 change: 1 addition & 0 deletions dist/cookie-consent-ui.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit ac5b2db

Please sign in to comment.