Skip to content
This repository was archived by the owner on Mar 13, 2021. It is now read-only.

Commit

Permalink
Merge pull request #59 from awibox/develop
Browse files Browse the repository at this point in the history
#57: bold font for parameters in the README.md
  • Loading branch information
Andrei Arkhipov authored Jan 19, 2020
2 parents 74fc5a2 + 471d851 commit 3f3d96b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,22 +48,22 @@ Then use the component in your application. For example:
## The settings of the component
|Parameter|Type|Description|Default|
|--------------------|--------|-----------|-------|
|background|string|Sets the color for the background in any format that supports css|``` #fff ```|
|bottomPosition|boolean|By default, the notification is displayed at the top of the page and the value of this parameter is ```false```. If set to ```true```, the notification will be displayed at the bottom|``` false ```|
|color|string|Sets the color of the text and the cross to close|``` #000 ```|
|cookiePolicyName|string|Sets the name for the cookie policy link|``` Cookie Policy ```|
|cookiePolicyText|string|Sets the text before the cookie policy link. It is recommended to set value because default text may change in future versions|``` By continuing to use the service, you agree to our use of cookies as described in the ```|
|cookiePolicyLink|string|Link to your cookie policy. If the link value is not set, the link with the name (cookiePolicyName) and the text before the link (cookiePolicyText) will not be displayed|-|
|text|string|This is the main text that will be displayed in the notification. It is recommended to set value because default text may change in future versions|``` This website uses cookies to improve service, for analytical and advertising purposes. ```|
|closeIconSize|number|Sets the size of the icon to close the notification|``` 28 ```|
|closeIconPositionTop|boolean|By default the icon for closing is displayed in the middle relative to the height of the notification and the value of this parameter is ```false```. If set to ```true```, the closing icon will be displayed on the top|``` false ```|
|padding|number|Sets padding for cookie notification|``` 20 ```|
|**background**|string|Sets the color for the background in any format that supports css|``` #fff ```|
|**bottomPosition**|boolean|By default, the notification is displayed at the top of the page and the value of this parameter is ```false```. If set to ```true```, the notification will be displayed at the bottom|``` false ```|
|**color**|string|Sets the color of the text and the cross to close|``` #000 ```|
|**cookiePolicyName**|string|Sets the name for the cookie policy link|``` Cookie Policy ```|
|**cookiePolicyText**|string|Sets the text before the cookie policy link. It is recommended to set value because default text may change in future versions|``` By continuing to use the service, you agree to our use of cookies as described in the ```|
|**cookiePolicyLink**|string|Link to your cookie policy. If the link value is not set, the link with the name (cookiePolicyName) and the text before the link (cookiePolicyText) will not be displayed|-|
|**text**|string|This is the main text that will be displayed in the notification. It is recommended to set value because default text may change in future versions|``` This website uses cookies to improve service, for analytical and advertising purposes. ```|
|**closeIconSize**|number|Sets the size of the icon to close the notification|``` 28 ```|
|**closeIconPositionTop**|boolean|By default the icon for closing is displayed in the middle relative to the height of the notification and the value of this parameter is ```false```. If set to ```true```, the closing icon will be displayed on the top|``` false ```|
|**padding**|number|Sets padding for cookie notification|``` 20 ```|

<a name="custom"></a>
## Custom content
You can place your own content in the notification. You should call the component as follows:
```typescript jsx
<CookieDisclaimer background='#0079c1' color='#fff'>Custom content <a href={yourLink}>Link</a> other text</CookieDisclaimer>
<CookieDisclaimer background='#000' color='#fff'>JSX custom content</CookieDisclaimer>
```
<a name="example"></a>
## Example
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": "react-cookie-disclaimer",
"version": "2.0.0",
"version": "2.0.1",
"description": "The package will help you to display a notification about the use of cookies on the site",
"main": "./dist/index.js",
"scripts": {
Expand Down

0 comments on commit 3f3d96b

Please sign in to comment.