@seamapi/react 1.38.0 → 1.40.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
@@ -78,7 +78,7 @@ export function App() {
78
78
  <seam-device-table publishable-key="your_publishable_key"></seam-device-table>
79
79
  <script
80
80
  type="module"
81
- src="https://react.seam.co/v/1.38.0/dist/elements.js"
81
+ src="https://react.seam.co/v/1.40.0/dist/elements.js"
82
82
  ></script>
83
83
  </body>
84
84
  ```
@@ -303,14 +303,14 @@ $ npm install
303
303
 
304
304
  Develop components with [Storybook].
305
305
 
306
- Run Storybook in development mode with
306
+ Run the full storybook in development mode with
307
307
 
308
308
  ```
309
309
  $ npm start
310
310
  ```
311
311
 
312
- The Storybook is deployed in docs mode.
313
- Develop the Storybook in docs mode with
312
+ The deployed storybook runs in docs mode which does not contain the full storybook.
313
+ Develop the storybook in docs mode with
314
314
 
315
315
  ```
316
316
  $ npm run docs:start
@@ -318,25 +318,40 @@ $ npm run docs:start
318
318
 
319
319
  [Storybook]: https://storybook.js.org/
320
320
 
321
- ### Fake Seam Connect
321
+ #### Chromatic
322
322
 
323
- This project uses a [fake version of Seam Connect](https://github.com/seamapi/fake-seam-connect)
324
- to have deterministic responses for rendering views and running tests.
323
+ [Chromatic] automates visual and interaction tests for Storybook.
325
324
 
326
- Edit the seed data for the fake or find relevant ids for testing components here:
325
+ On each commit, the full storybook is published to Chromatic for review.
326
+ On pull requests, Chromatic will run UI regressions tests on each commit.
327
+ Chromatic reports results as status checks that link directly to the storybook.
327
328
 
328
- - [Storybook fake seed](./.storybook/seed-fake.js).
329
- - [Jest test fake seed](./test/jest/global-setup.cjs).
329
+ If changes are detected, follow the link in the status checks to approve the changes.
330
+ _Contributors must be granted access to approve changes on Chromatic;
331
+ request access from another maintainer of this project._
332
+
333
+ [Chromatic]: https://www.chromatic.com/
330
334
 
331
335
  ### Previews
332
336
 
333
- Every pull request deploys the Storybook with the examples
337
+ Every pull request deploys the storybook in docs mode with the examples
334
338
  in a [Vercel Preview Deployment]
335
339
  where you may [comment directly on the preview][Vercel Comments].
340
+ This is the same storybook published on [react.seam.co](https://react.seam.co).
336
341
 
337
342
  [Vercel Preview Deployment]: https://vercel.com/docs/concepts/deployments/preview-deployments
338
343
  [Vercel Comments]: https://vercel.com/docs/concepts/deployments/comments
339
344
 
345
+ ### Fake Seam Connect
346
+
347
+ This project uses a [fake version of Seam Connect](https://github.com/seamapi/fake-seam-connect)
348
+ to have deterministic responses for rendering views and running tests.
349
+
350
+ Edit the seed data for the fake or find relevant ids for testing components here:
351
+
352
+ - [Storybook fake seed](./.storybook/seed-fake.js).
353
+ - [Jest test fake seed](./test/jest/global-setup.cjs).
354
+
340
355
  ### Tests
341
356
 
342
357
  Write tests with [Jest].