diff --git a/packages/cookie-consent-banner-react/README.md b/packages/cookie-consent-banner-react/README.md index 2150d59..7cf1be6 100644 --- a/packages/cookie-consent-banner-react/README.md +++ b/packages/cookie-consent-banner-react/README.md @@ -38,21 +38,21 @@ npm i @porscheofficial/cookie-consent-banner-react --S ### Properties -| Property (React) | Default | Type | Description | -| :------------------------------------------ | :------------------------------ | :--------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `availableCategories` | `[]` | `CategoryItem[]` | Provide the available Categories. See Real World example | -| `cookieDomain` | `document.location.hostname` | `string` | | -| `cookieName` | `"cookies_accepted_categories"` | `string` | | -| `disableResetSiteCookiesOnConsentWithdrawn` | `false` | `boolean` | Prevent cookies from being deleted automatically if consent of the user changed. | -| `disableSlideInAnimation` | `false` | `boolean` | Disable slide-in animation of banner (See #7) | -| `headline` | `undefined` | `string` | | -| `btnLabelAcceptAndContinue` | `undefined` | `string` | | -| `btnLabelAllAndContinue` | `undefined` | `string` | | -| `btnLabelOnlyEssentialAndContinue` | `undefined` | `string` | | -| `btnLabelPersistSelectionAndContinue` | `undefined` | `string` | | -| `contentSettingsDescription` | `undefined` | `string` | | -| `handlePreferencesRestored` | `undefined` | `({ acceptedCategories, }: { acceptedCategories: string[]; }) => void` | -| `handlePreferencesUpdated` | `undefined` | `({ acceptedCategories, }: { acceptedCategories: string[]; }) => void` | | +| Property (React) | Default | Type | Description | +| :------------------------------------------ | :---------------------------------------------------------- | :--------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `availableCategories` | `[]` | `CategoryItem[]` | Provide the available Categories. See Real World example | +| `cookieAttributes` | `{path: "/",expires: 7,domain: document.location.hostname}` | [`CookieAttributes`](./src/components/cookie-consent-banner/types.ts) | Customization of the cookie attributes for the consent cookie (`expires` can either be a number of days or a `Date` object). | +| `cookieName` | `"cookies_accepted_categories"` | `string` | | +| `disableResetSiteCookiesOnConsentWithdrawn` | `false` | `boolean` | Prevent cookies from being deleted automatically if consent of the user changed. | +| `disableSlideInAnimation` | `false` | `boolean` | Disable slide-in animation of banner (See #7) | +| `headline` | `undefined` | `string` | | +| `btnLabelAcceptAndContinue` | `undefined` | `string` | | +| `btnLabelAllAndContinue` | `undefined` | `string` | | +| `btnLabelOnlyEssentialAndContinue` | `undefined` | `string` | | +| `btnLabelPersistSelectionAndContinue` | `undefined` | `string` | | +| `contentSettingsDescription` | `undefined` | `string` | | +| `handlePreferencesRestored` | `undefined` | `({ acceptedCategories, }: { acceptedCategories: string[]; }) => void` | +| `handlePreferencesUpdated` | `undefined` | `({ acceptedCategories, }: { acceptedCategories: string[]; }) => void` | | ### Events Dispatched by the Component diff --git a/packages/cookie-consent-banner/README.md b/packages/cookie-consent-banner/README.md index 1fd2bac..facd72f 100644 --- a/packages/cookie-consent-banner/README.md +++ b/packages/cookie-consent-banner/README.md @@ -49,19 +49,19 @@ npm i @porscheofficial/cookie-consent-banner --S ### Attributes -| Attribute (Web Component) | Default | Type | Description | -| :------------------------------------------------ | :------------------------------ | :--------------- | :------------------------------------------------------------------------------- | -| `available-categories` | `[]` | `CategoryItem[]` | Provide the available Categories. See Real World example | -| `cookie-domain` | `document.location.hostname` | `string` | | -| `cookie-name` | `"cookies_accepted_categories"` | `string` | | -| `disable-reset-site-cookies-on-consent-withdrawn` | `false` | `boolean` | Prevent cookies from being deleted automatically if consent of the user changed. | -| `disable-slide-in-animation` | `false` | `boolean` | Disable slide-in animation of banner (See #7) | -| `headline` | `undefined` | `string` | | -| `btn-label-accept-and-continue` | `undefined` | `string` | | -| `btn-label-select-all-and-continue` | `undefined` | `string` | | -| `btn-label-only-essential-and-continue` | `undefined` | `string` | | -| `btn-label-persist-selection-and-continue` | `undefined` | `string` | -| `content-settings-description` | `undefined` | `string` | | +| Attribute (Web Component) | Default | Type | Description | +| :------------------------------------------------ | :---------------------------------------------------------- | :-------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------- | +| `available-categories` | `[]` | `CategoryItem[]` | Provide the available Categories. See Real World example | +| `cookie-attributes` | `{path: "/",expires: 7,domain: document.location.hostname}` | [`CookieAttributes`](./src/components/cookie-consent-banner/types.ts) | Customization of the cookie attributes for the consent cookie (`expires` can either be a number of days or a `Date` object). | +| `cookie-name` | `"cookies_accepted_categories"` | `string` | | +| `disable-reset-site-cookies-on-consent-withdrawn` | `false` | `boolean` | Prevent cookies from being deleted automatically if consent of the user changed. | +| `disable-slide-in-animation` | `false` | `boolean` | Disable slide-in animation of banner (See #7) | +| `headline` | `undefined` | `string` | | +| `btn-label-accept-and-continue` | `undefined` | `string` | | +| `btn-label-select-all-and-continue` | `undefined` | `string` | | +| `btn-label-only-essential-and-continue` | `undefined` | `string` | | +| `btn-label-persist-selection-and-continue` | `undefined` | `string` | +| `content-settings-description` | `undefined` | `string` | | ### Events Dispatched by the Component