Skip to content

CHANGELOG.md

Latest commit

 

History

History
250 lines (146 loc) · 9.18 KB

CHANGELOG.md

File metadata and controls

250 lines (146 loc) · 9.18 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[10.0.1]

  • fixes #207
    • Vite's jsx-runtime is now set to "classic"

[10.0.0]

Major infrastructure modernization and migration to Vite:

Breaking Changes

  • BREAKING: Updated minimum Node.js requirement from >=10 to >=20.16
  • BREAKING: Updated React peer dependencies from >=16 to >=18
  • BREAKING: Migrated build system from TSDX to Vite
  • BREAKING: Changed output bundle names from cjs.production.min.js/esm.js to umd.js/es.js
  • BREAKING: Updated cookieValue and declineCookieValue props to only accept string values (removed object support)

New Features

  • Added accessibility improvements: keyboard navigation, ARIA labels, and proper focus management for overlay
  • Improved browser compatibility by replacing window references with globalThis
  • Enhanced TypeScript support with updated type definitions

Dependencies

  • Major: Upgraded React from 18.x to 19.x
  • Major: Upgraded js-cookie from 2.2.1 to 3.0.5
  • Major: Upgraded Storybook from 6.x to 8.6.15 with new story format (CSF 3.0)
  • Major: Upgraded TypeScript from 3.9.10 to 5.9.3
  • Updated @mui/material from 5.9.2 to 7.3.6 (dev dependency only)
  • Updated numerous dev dependencies to latest versions

Infrastructure

  • Migration: Complete migration from TSDX to Vite for faster builds and modern tooling
  • CI/CD: Updated GitHub Actions workflows to use Node.js 20/22 instead of 10/12/14
  • CI/CD: Improved workflow efficiency with proper npm caching and npm ci
  • Security: Fixed GitHub Actions to use full commit SHA hashes instead of tag references
  • Build: Added proper Vite configuration for library builds with TypeScript declarations
  • Storybook: Migrated to modern Storybook 8.x with Vite integration and updated story format

Code Quality

  • Modernized all Storybook stories to use CSF 3.0 format with proper TypeScript types
  • Improved code consistency with readonly static props and better formatting
  • Enhanced accessibility with proper event handling and ARIA attributes

[[9.0.0]((https://github.com/Mastermindzh/react-cookie-consent/releases/tag/9.0.0)]

Made all props optional and fixed documentation. Fixes #191 and #193

[[8.0.1]((https://github.com/Mastermindzh/react-cookie-consent/releases/tag/8.0.1)]

Second try of np... Removed postinstall np is not my thing.. reverted to old release strategy

[[8.0.0]((https://github.com/Mastermindzh/react-cookie-consent/releases/tag/8.0.0)]

  • Switched to tsdx and Typescript
  • Added storybook with examples from readme

[[7.6.0]](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.6.0]

  • Added customButtonWrapperAttributes prop which allows to add custom attributes to the button wrapper div

[7.5.0]

  • Added customDeclineButtonProps to add custom properties to the decline button

[7.4.1]

  • Small version error in package.json that actually didn't make it work with React 18

[7.4.0]

  • Added support for React 18
  • Updated example and codebase to use React 18

[7.3.1]

  • Added type annotations on public functions

[7.3.0]

  • added customButtonProps that allows to use custom props with the button component. Specifically useful for library buttons components, for e.g. MUI Button.

[7.2.1]

  • hideOnDecline added to typescript files
  • Added .prettieringore

[7.2.0]

  • Added onOverlayClick which allows you to react to a click on the overlay
  • Added acceptOnOverlayClick which accepts the cookies when the overlay is clicked and runs onOverlayClick

[7.1.1]

  • customContentAttributes and customContainerAttributes are now optional in the typing file as they should be

[7.1.0]

  • Added custom attribute props for content and container

[7.0.1]

  • Configured webpack to remove self from build artefact. Should now work in Nextjs and Gatsby (only tested those..)

[7.0.0]

  • Switched from CommonJS to UMD module

[6.4.1)]

  • Added missing typing

[6.4.0)]

  • Added visible prop

[6.3.0)]

  • Added the (optional) scrolling effect back in as it is declared legal in some countries now.

[6.2.4]

  • version bumps :)

[6.2.3]

  • Added support for IE11, the webpack generated runtime-code should not use arrow functions

[6.2.2]

  • Fixed the return type of getCookieConsentValue in the dts file.

[6.2.1]

Added the getCookieConsentValue to the dts file.

[6.2.0]

Added the exported function getCookieConsentValue to get the cookie value from custom code

[6.1.0]

Added support for React 17

[6.0.0]

removed

Accepting by scrolling is no longer allowed and has thus been removed from the package. For details see issue 88

[5.2.0]

added

Added aria labels for both the decline and accept button

[5.1.4]

changed

  • set default SameSite attribute to "lax" because browsers are already implementing the cookie policy changes.

[5.1.3]

changed

  • Fix missing buttonWrapperClasses prop in type definition

[5.1.2]

changed

  • Set cookie value before handling side-effects.
  • The overlay is now conditional. Meaning that the component behaves exactly as it did prior to 5.1.0 when you do not use the overlay

[5.1.0]

A new feature! This time it's an "overlay" on the entire website to block access whilst the cookiebar is displayed. This is all opt-in of course and the README covers it nicely (just add overlay to the props and see what happens).

We got an update picture, with a cute cat... unfortunately the cat won't be included by default:

overlay example image

[5.0.1]

  • Fixed Issue 69 by removing location from the proptypes to avoid build-time issues

[5.0.0]

added

  • CookieSecurity prop - allows securing the cookie
  • sameSite prop - allows you to set sameSite properties so browser won't warn about non-secure cookies :)

[4.1.0]

changed

  • Added CookieConsent back in as the default for the containerClasses property.

[4.0.0]

I decided to update react-cookie-consent to version 4 because this version has a buttonWrapper which will break appearance. I consider appearance a major feature.

Added

  • Changelog :D
  • A wrapper around the buttons so they always stay together. (still possible to change with css using buttonWrapperClasses)

Changed

  • Default ids for the buttons (rcc stands for react-cookie-consent, cookie-consent is blocked by some adblockers nowadays so I abbreviated it)

Updated

dependencies

  • js-cookie updated from 2.2.0 to 2.2.1

peer dependencies

  • react updated from 16.4.0 to 16.13.1

development dependencies

  • @types/js-cookie updated from 2.2.2 to 2.2.6
  • babel-cli updated from 6.24.1 to 6.26.0
  • babel-preset-env updated from 1.5.1 to 1.7.0
  • react updated from 16.8.6 to 16.13.1