@justeattakeaway/pie-cookie-banner 0.8.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -14,9 +14,8 @@
14
14
  2. [Installation](#installation)
15
15
  3. [Importing the component](#importing-the-component)
16
16
  4. [Peer Dependencies](#peer-dependencies)
17
- 5. [Local Development](#local-development)
18
- 6. [Props](#props)
19
- 7. [Testing](#testing)
17
+ 5. [Props](#props)
18
+ 6. [Contributing](#contributing)
20
19
 
21
20
 
22
21
  ## pie-cookie-banner
@@ -57,36 +56,11 @@ import { PieCookieBanner } from '@justeattakeaway/pie-cookie-banner/dist/react';
57
56
  > [!IMPORTANT]
58
57
  > When using `pie-cookie-banner`, you will also need to include a couple of dependencies to ensure the component renders as expected. See [the PIE Wiki](https://github.com/justeattakeaway/pie/wiki/Getting-started-with-PIE-Web-Components#expected-dependencies) for more information and how to include these in your application.
59
58
 
60
-
61
- ## Local development
62
-
63
- Install the dependencies. Note that this, and the following commands below, should be run from the **root of the monorepo**:
64
-
65
- ```bash
66
- yarn
67
- ```
68
-
69
- To build the `pie-cookie-banner` package, run the following command:
70
-
71
- ```bash
72
- yarn build --filter=pie-cookie-banner
73
- ```
74
-
75
- If you'd like to develop using the component storybook, then you should build the component in `watch` mode, and run storybook in a separate terminal tab:
76
-
77
- ```bash
78
- yarn watch --filter=pie-cookie-banner
79
-
80
- # in a separate terminal tab, run
81
- yarn dev --filter=pie-storybook
82
- ```
83
-
84
-
85
59
  ## Props
86
60
 
87
61
  | Property | Type | Default | Description |
88
62
  |---|---|---|---|
89
- | hasPrimaryActionsOnly | `Boolean` | `false` | When true, sets the "Necessary only" button variant to "primary". |
63
+ | hasPrimaryActionsOnly | `Boolean` | `false` | When true, sets the variant to "primary" for the button which accepts necessary cookies only. |
90
64
 
91
65
  In your markup or JSX, you can then use these to set the properties for the `pie-cookie-banner` component:
92
66
 
@@ -98,36 +72,6 @@ In your markup or JSX, you can then use these to set the properties for the `pie
98
72
  <PieCookieBanner></PieCookieBanner>
99
73
  ```
100
74
 
101
- ## Testing
102
-
103
- ### Browser tests
104
-
105
- To run the browser tests, run the following command from the root of the monorepo:
75
+ ## Contributing
106
76
 
107
- ```bash
108
- yarn test:browsers --filter=pie-cookie-banner
109
- ```
110
-
111
- ### Visual tests
112
-
113
- To run the visual regression tests, run the following command from the root of the monorepo:
114
-
115
- ```bash
116
- yarn test:visual --filter=pie-cookie-banner
117
- ```
118
-
119
- Note: To run these locally, you will need to ensure that any environment variables required are set up on your machine to mirror those on CI (such as Percy tokens). How you achieve this will differ between operating systems.
120
-
121
- #### Setup via bash
122
-
123
- ```bash
124
- export PERCY_TOKEN_PIE_COOKIE_BANNER=abcde
125
- ```
126
-
127
- #### Setup via package.json
128
-
129
- Under scripts `test:visual` replace the environment variable with the below:
130
-
131
- ```bash
132
- PERCY_TOKEN_PIE_COOKIE_BANNER=abcde
133
- ```
77
+ Check out our [contributing guide](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide) for more information on [local development](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide#local-development) and how to run specific [component tests](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide#testing).
package/dist/index.d.ts CHANGED
@@ -5,7 +5,7 @@ import type { TemplateResult } from 'lit';
5
5
 
6
6
  export declare interface CookieBannerProps {
7
7
  /**
8
- * When true, sets the "Necessary only" button variant to "primary".
8
+ * When true, sets the variant to "primary" for the button which accepts necessary cookies only.
9
9
  */
10
10
  hasPrimaryActionsOnly: boolean;
11
11
  }
package/dist/react.d.ts CHANGED
@@ -7,7 +7,7 @@ import type { TemplateResult } from 'lit';
7
7
 
8
8
  export declare interface CookieBannerProps {
9
9
  /**
10
- * When true, sets the "Necessary only" button variant to "primary".
10
+ * When true, sets the variant to "primary" for the button which accepts necessary cookies only.
11
11
  */
12
12
  hasPrimaryActionsOnly: boolean;
13
13
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@justeattakeaway/pie-cookie-banner",
3
3
  "description": "PIE Design System Cookie Banner built using Web Components",
4
- "version": "0.8.0",
4
+ "version": "0.9.0",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
7
7
  "module": "dist/index.js",
@@ -29,12 +29,12 @@
29
29
  "license": "Apache-2.0",
30
30
  "devDependencies": {
31
31
  "@justeat/pie-design-tokens": "5.8.2",
32
- "@justeattakeaway/pie-button": "0.34.0",
32
+ "@justeattakeaway/pie-button": "0.35.0",
33
33
  "@justeattakeaway/pie-components-config": "0.4.0",
34
- "@justeattakeaway/pie-icon-button": "0.18.0",
35
- "@justeattakeaway/pie-link": "0.10.0",
36
- "@justeattakeaway/pie-modal": "0.29.0",
37
- "@justeattakeaway/pie-toggle-switch": "0.14.0"
34
+ "@justeattakeaway/pie-icon-button": "0.19.0",
35
+ "@justeattakeaway/pie-link": "0.11.0",
36
+ "@justeattakeaway/pie-modal": "0.30.0",
37
+ "@justeattakeaway/pie-toggle-switch": "0.15.0"
38
38
  },
39
39
  "dependencies": {
40
40
  "@justeattakeaway/pie-webc-core": "0.11.0"
package/src/defs.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  export interface CookieBannerProps {
2
2
  /**
3
- * When true, sets the "Necessary only" button variant to "primary".
3
+ * When true, sets the variant to "primary" for the button which accepts necessary cookies only.
4
4
  */
5
5
  hasPrimaryActionsOnly: boolean;
6
6
  }