@justeattakeaway/pie-icon-button 0.18.0 → 0.19.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.
Files changed (2) hide show
  1. package/README.md +5 -65
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -14,15 +14,12 @@
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. [Events](#events)
17
+ 5. [Props](#props)
18
+ 6. [Events](#events)
20
19
  - [HTML example](#html)
21
20
  - [Vue example (using Nuxt 3)](#vue-templates-using-nuxt-3)
22
21
  - [React example (using Next 13)](#react-templates-using-next-13)
23
- 8. [Testing](#testing)
24
- - [Browser Tests](#browser-tests)
25
- - [Visual Tests](#visual-tests)
22
+ 7. [Contributing](#contributing)
26
23
 
27
24
 
28
25
  ## `pie-icon-button`
@@ -65,32 +62,6 @@ import { PieIconButton } from '@justeattakeaway/pie-icon-button/dist/react';
65
62
  > [!IMPORTANT]
66
63
  > When using `pie-icon-button`, 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.
67
64
 
68
-
69
- ## Local development
70
-
71
- Install the dependencies. Note that this, and the following commands below, should be run from the **root of the monorepo**:
72
-
73
- ```bash
74
- yarn
75
- ```
76
-
77
- To build the `pie-icon-button` package, run the following command:
78
-
79
- ```bash
80
- yarn build --filter=pie-icon-button
81
- ```
82
-
83
- 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:
84
-
85
-
86
- ```bash
87
- yarn watch --filter=pie-icon-button
88
-
89
- # in a separate terminal tab, run
90
- yarn dev --filter=pie-storybook
91
- ```
92
-
93
-
94
65
  ## Importing Icons
95
66
 
96
67
  We recommend using the `pie-icon-button` component alongside the `pie-icons-webc` package. This package contains all of the PIE iconset as importable web components and are built to work alongside our other PIE components.
@@ -164,37 +135,6 @@ For example, to add a click handler in various templates:
164
135
 
165
136
  ```
166
137
 
138
+ ## Contributing
167
139
 
168
- ## Testing
169
-
170
- ### Browser tests
171
-
172
- To run the browser tests, run the following command from the root of the monorepo:
173
-
174
- ```bash
175
- yarn test:browsers --filter=pie-icon-button
176
- ```
177
-
178
- ### Visual tests
179
-
180
- To run the visual regression tests, run the following command from the root of the monorepo:
181
-
182
- ```bash
183
- yarn test:visual --filter=pie-icon-button
184
- ```
185
-
186
- 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.
187
-
188
- #### Setup via bash
189
-
190
- ```bash
191
- export PERCY_TOKEN_PIE_ICON_BUTTON=abcde
192
- ```
193
-
194
- #### Setup via package.json
195
-
196
- Under scripts `test:visual` replace the environment variable with the below:
197
-
198
- ```bash
199
- PERCY_TOKEN_PIE_ICON_BUTTON=abcde
200
- ```
140
+ 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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@justeattakeaway/pie-icon-button",
3
- "version": "0.18.0",
3
+ "version": "0.19.0",
4
4
  "description": "PIE Design System Icon Button built using Web Components",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -26,7 +26,7 @@
26
26
  "author": "Just Eat Takeaway.com - Design System Team",
27
27
  "license": "Apache-2.0",
28
28
  "devDependencies": {
29
- "@justeattakeaway/pie-icons-webc": "0.11.0",
29
+ "@justeattakeaway/pie-icons-webc": "0.11.1",
30
30
  "@justeattakeaway/pie-webc-core": "0.11.0"
31
31
  },
32
32
  "peerDependencies": {