mirror of
https://github.com/Mastermindzh/react-cookie-consent.git
synced 2024-10-22 16:48:15 +02:00
added customButtonWrapperAttributes prop (#167)
* added customButtonWrapperAttributes prop * escape characters in README
This commit is contained in:
Oskar Filipowicz
GitHub
parent
a7ce2de923
commit
d05509bf04
@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
|
|||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [next]
|
||||||
|
|
||||||
|
- Added `customButtonWrapperAttributes` prop which allows to add custom attributes to the button wrapper div
|
||||||
|
|
||||||
## [[7.5.0]](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.5.0)
|
## [[7.5.0]](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.5.0)
|
||||||
|
|
||||||
- Added `customDeclineButtonProps` to add custom properties to the decline button
|
- Added `customDeclineButtonProps` to add custom properties to the decline button
|
||||||
|
|||||||
97
README.md
97
README.md
@ -137,54 +137,55 @@ That option would be interesting if you want to allow user to change their conse
|
|||||||
|
|
||||||
## Props
|
## Props
|
||||||
|
|
||||||
| Prop | Type | Default value | Description |
|
| Prop | Type | Default value | Description |
|
||||||
| ------------------------- | :-----------------------------------------: | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------- | :-----------------------------------------: | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| location | string, "top", "bottom" or "none" | "bottom" | Syntactic sugar to easily enable you to place the bar at the top or the bottom of the browser window. Use "none" to disable. |
|
| location | string, "top", "bottom" or "none" | "bottom" | Syntactic sugar to easily enable you to place the bar at the top or the bottom of the browser window. Use "none" to disable. |
|
||||||
| visible | string, "show", "hidden" or "byCookieValue" | "byCookieValue" | Force the consent bar visibility. If "byCookieValue", visibility are defined by cookie consent existence. |
|
| visible | string, "show", "hidden" or "byCookieValue" | "byCookieValue" | Force the consent bar visibility. If "byCookieValue", visibility are defined by cookie consent existence. |
|
||||||
| children | string or React component | | Content to appear inside the bar |
|
| children | string or React component | | Content to appear inside the bar |
|
||||||
| disableStyles | boolean | false | If enabled the component will have no default style. (you can still supply style through props) |
|
| disableStyles | boolean | false | If enabled the component will have no default style. (you can still supply style through props) |
|
||||||
| hideOnAccept | boolean | true | If disabled the component will not hide it self after the accept button has been clicked. You will need to hide yourself (see onAccept) |
|
| hideOnAccept | boolean | true | If disabled the component will not hide it self after the accept button has been clicked. You will need to hide yourself (see onAccept) |
|
||||||
| buttonText | string or React component | "I understand" | Text to appear on the button |
|
| buttonText | string or React component | "I understand" | Text to appear on the button |
|
||||||
| declineButtonText | string or React component | "I decline" | Text to appear on the decline button |
|
| declineButtonText | string or React component | "I decline" | Text to appear on the decline button |
|
||||||
| cookieName | string | "CookieConsent" | Name of the cookie used to track whether the user has agreed. |
|
| cookieName | string | "CookieConsent" | Name of the cookie used to track whether the user has agreed. |
|
||||||
| cookieValue | string or boolean or number | true | Value to be saved under the cookieName. |
|
| cookieValue | string or boolean or number | true | Value to be saved under the cookieName. |
|
||||||
| declineCookieValue | string or boolean or number | false | Value to be saved under the cookieName when declined. |
|
| declineCookieValue | string or boolean or number | false | Value to be saved under the cookieName when declined. |
|
||||||
| setDeclineCookie | boolean | true | Whether to set a cookie when the user clicks "decline" |
|
| setDeclineCookie | boolean | true | Whether to set a cookie when the user clicks "decline" |
|
||||||
| onAccept | function | `() => {}` | Function to be called after the accept button has been clicked. |
|
| onAccept | function | `() => {}` | Function to be called after the accept button has been clicked. |
|
||||||
| onDecline | function | `() => {}` | Function to be called after the decline button has been clicked. |
|
| onDecline | function | `() => {}` | Function to be called after the decline button has been clicked. |
|
||||||
| debug | boolean | undefined | Bar will be drawn regardless of cookie for debugging purposes. |
|
| debug | boolean | undefined | Bar will be drawn regardless of cookie for debugging purposes. |
|
||||||
| expires | number | 365 | Number of days before the cookie expires. |
|
| expires | number | 365 | Number of days before the cookie expires. |
|
||||||
| extraCookieOptions | object | `{}` | Extra info (apart from expiry date) to add to the cookie |
|
| extraCookieOptions | object | `{}` | Extra info (apart from expiry date) to add to the cookie |
|
||||||
| overlay | boolean | false | Whether to show a page obscuring overlay or not. |
|
| overlay | boolean | false | Whether to show a page obscuring overlay or not. |
|
||||||
| containerClasses | string | "" | CSS classes to apply to the surrounding container |
|
| containerClasses | string | "" | CSS classes to apply to the surrounding container |
|
||||||
| buttonClasses | string | "" | CSS classes to apply to the button |
|
| buttonClasses | string | "" | CSS classes to apply to the button |
|
||||||
| buttonWrapperClasses | string | "" | CSS classes to apply to the div wrapping the buttons |
|
| buttonWrapperClasses | string | "" | CSS classes to apply to the div wrapping the buttons |
|
||||||
| declineButtonClasses | string | "" | CSS classes to apply to the decline button |
|
| customButtonWrapperAttributes | `React.HTMLAttributes<HTMLDivElement>` | `{}` | Allows you to set custom (data) attributes on the button wrapper div |
|
||||||
| buttonId | string | "" | Id to apply to the button |
|
| declineButtonClasses | string | "" | CSS classes to apply to the decline button |
|
||||||
| declineButtonId | string | "" | Id to apply to the decline button |
|
| buttonId | string | "" | Id to apply to the button |
|
||||||
| contentClasses | string | "" | CSS classes to apply to the content |
|
| declineButtonId | string | "" | Id to apply to the decline button |
|
||||||
| overlayClasses | string | "" | CSS classes to apply to the surrounding overlay |
|
| contentClasses | string | "" | CSS classes to apply to the content |
|
||||||
| style | object | [look at source][style] | React styling object for the bar. |
|
| overlayClasses | string | "" | CSS classes to apply to the surrounding overlay |
|
||||||
| buttonStyle | object | [look at source][buttonstyle] | React styling object for the button. |
|
| style | object | [look at source][style] | React styling object for the bar. |
|
||||||
| declineButtonStyle | object | [look at source][declinebuttonstyle] | React styling object for the decline button. |
|
| buttonStyle | object | [look at source][buttonstyle] | React styling object for the button. |
|
||||||
| contentStyle | object | [look at source][contentstyle] | React styling object for the content. |
|
| declineButtonStyle | object | [look at source][declinebuttonstyle] | React styling object for the decline button. |
|
||||||
| overlayStyle | object | [look at source][overlaystyle] | React styling object for the overlay. |
|
| contentStyle | object | [look at source][contentstyle] | React styling object for the content. |
|
||||||
| disableButtonStyles | boolean | false | If enabled the button will have no default style. (you can still supply style through props) |
|
| overlayStyle | object | [look at source][overlaystyle] | React styling object for the overlay. |
|
||||||
| enableDeclineButton | boolean | false | If enabled the decline button will be rendered |
|
| disableButtonStyles | boolean | false | If enabled the button will have no default style. (you can still supply style through props) |
|
||||||
| flipButtons | boolean | false | If enabled the accept and decline buttons will be flipped |
|
| enableDeclineButton | boolean | false | If enabled the decline button will be rendered |
|
||||||
| ButtonComponent | React component | button | React Component to render as a button. |
|
| flipButtons | boolean | false | If enabled the accept and decline buttons will be flipped |
|
||||||
| sameSite | string, "strict", "lax" or "none" | none | Cookies sameSite attribute value |
|
| ButtonComponent | React component | button | React Component to render as a button. |
|
||||||
| cookieSecurity | boolean ¡ | undefined | Cookie security level. Defaults to true unless running on http. |
|
| sameSite | string, "strict", "lax" or "none" | none | Cookies sameSite attribute value |
|
||||||
| ariaAcceptLabel | string | Accept cookies | Aria label to set on the accept button |
|
| cookieSecurity | boolean | undefined | Cookie security level. Defaults to true unless running on http. |
|
||||||
| ariaDeclineLabel | string | Decline cookies | Aria label to set on the decline button |
|
| ariaAcceptLabel | string | Accept cookies | Aria label to set on the accept button |
|
||||||
| acceptOnScroll | boolean | false | Defines whether "accept" should be fired after the user scrolls a certain distance (see acceptOnScrollPercentage) |
|
| ariaDeclineLabel | string | Decline cookies | Aria label to set on the decline button |
|
||||||
| acceptOnScrollPercentage | number | 25 | Percentage of the page height the user has to scroll to trigger the accept function if acceptOnScroll is enabled |
|
| acceptOnScroll | boolean | false | Defines whether "accept" should be fired after the user scrolls a certain distance (see acceptOnScrollPercentage) |
|
||||||
| customContentAttributes | object | `{}` | Allows you to set custom (data) attributes on the content div |
|
| acceptOnScrollPercentage | number | 25 | Percentage of the page height the user has to scroll to trigger the accept function if acceptOnScroll is enabled |
|
||||||
| customContainerAttributes | object | `{}` | Allows you to set custom (data) attributes on the container div |
|
| customContentAttributes | object | `{}` | Allows you to set custom (data) attributes on the content div |
|
||||||
| onOverlayClick | function | `() => {}` | allows you to react to a click on the overlay |
|
| customContainerAttributes | object | `{}` | Allows you to set custom (data) attributes on the container div |
|
||||||
| acceptOnOverlayClick | boolean | false | Determines whether the cookies should be accepted after clicking on the overlay |
|
| onOverlayClick | function | `() => {}` | allows you to react to a click on the overlay |
|
||||||
| customButtonProps | object | `{}` | Allows you to set custom props on the button component |
|
| acceptOnOverlayClick | boolean | false | Determines whether the cookies should be accepted after clicking on the overlay |
|
||||||
| customDeclineButtonProps | object | `{}` | Allows you to set custom props on the decline button component |
|
| customButtonProps | object | `{}` | Allows you to set custom props on the button component |
|
||||||
|
| customDeclineButtonProps | object | `{}` | Allows you to set custom props on the decline button component |
|
||||||
|
|
||||||
## Debugging it
|
## Debugging it
|
||||||
|
|
||||||
|
|||||||
1
src/index.d.ts
vendored
1
src/index.d.ts
vendored
@ -49,6 +49,7 @@ export interface CookieConsentProps {
|
|||||||
customContainerAttributes?: object;
|
customContainerAttributes?: object;
|
||||||
customButtonProps?: object;
|
customButtonProps?: object;
|
||||||
customDeclineButtonProps?: object;
|
customDeclineButtonProps?: object;
|
||||||
|
customButtonWrapperAttributes?: React.HTMLAttributes<HTMLDivElement>;
|
||||||
}
|
}
|
||||||
|
|
||||||
export default class CookieConsent extends React.Component<CookieConsentProps, {}> {}
|
export default class CookieConsent extends React.Component<CookieConsentProps, {}> {}
|
||||||
|
|||||||
@ -294,6 +294,7 @@ class CookieConsent extends Component {
|
|||||||
customContentAttributes,
|
customContentAttributes,
|
||||||
customButtonProps,
|
customButtonProps,
|
||||||
customDeclineButtonProps,
|
customDeclineButtonProps,
|
||||||
|
customButtonWrapperAttributes,
|
||||||
} = this.props;
|
} = this.props;
|
||||||
|
|
||||||
let myStyle = {};
|
let myStyle = {};
|
||||||
@ -399,7 +400,7 @@ class CookieConsent extends Component {
|
|||||||
<div style={myContentStyle} className={contentClasses} {...customContentAttributes}>
|
<div style={myContentStyle} className={contentClasses} {...customContentAttributes}>
|
||||||
{this.props.children}
|
{this.props.children}
|
||||||
</div>
|
</div>
|
||||||
<div className={`${buttonWrapperClasses}`}>
|
<div className={`${buttonWrapperClasses}`} {...customButtonWrapperAttributes}>
|
||||||
{buttonsToRender.map((button) => {
|
{buttonsToRender.map((button) => {
|
||||||
return button;
|
return button;
|
||||||
})}
|
})}
|
||||||
@ -458,6 +459,7 @@ CookieConsent.propTypes = {
|
|||||||
customContainerAttributes: PropTypes.object,
|
customContainerAttributes: PropTypes.object,
|
||||||
customButtonProps: PropTypes.object,
|
customButtonProps: PropTypes.object,
|
||||||
customDeclineButtonProps: PropTypes.object,
|
customDeclineButtonProps: PropTypes.object,
|
||||||
|
customButtonWrapperAttributes: PropTypes.object,
|
||||||
};
|
};
|
||||||
|
|
||||||
CookieConsent.defaultProps = {
|
CookieConsent.defaultProps = {
|
||||||
@ -501,6 +503,7 @@ CookieConsent.defaultProps = {
|
|||||||
customContainerAttributes: {},
|
customContainerAttributes: {},
|
||||||
customButtonProps: {},
|
customButtonProps: {},
|
||||||
customDeclineButtonProps: {},
|
customDeclineButtonProps: {},
|
||||||
|
customButtonWrapperAttributes: {},
|
||||||
};
|
};
|
||||||
|
|
||||||
export default CookieConsent;
|
export default CookieConsent;
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user