@coopdigital/react 0.0.9 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Co-operative Group Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,17 +1,63 @@
-<img src="https://files.smartsurvey.io/3/0/DPL0KB0D/Coop_Cloverleaf_Blue_RGB.png" alt="CI pipeline status" width="100"/>
+<nav>
+<img src="https://s3.eu-west-1.amazonaws.com/assets.digital.coop.co.uk/logos/coopeng-logo.svg" alt="Co-op logo" width="100"/>
+<br />
+<br />
+</nav>
+
+
 
 # Experience Kit for React
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-15-orange.svg?style=flat-square)](#contributors-)
+[all_contributors_badge]: https://img.shields.io/badge/all_contributors-15-C08A00.svg '' 
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
+<a href="https://www.npmjs.com/package/@coopdigital/react"><img src="https://img.shields.io/npm/v/%40coopdigital%2Freact?color=E85A00" alt="npm version" /></a>
+<img alt="NPM Last Update" src="https://img.shields.io/npm/last-update/%40coopdigital%2Freact?label=published&color=6762F9">
+<img alt="NPM Downloads" src="https://img.shields.io/npm/d18m/%40coopdigital%2Freact?color=819C00">
+<a href="https://static.coop.co.uk/experience-kit-storybook-react"><img src="https://img.shields.io/badge/storybook-react-F85792" alt="storybook" /></a>
+[![All Contributors][all_contributors_badge]](#contributors)
 
 
-## Contributors ✨
 
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
+## Getting started
+
+Install the package from NPM:
+```
+npm install @coopdigital/react
+```
+
+Import the components that you need:
+```
+import { Button } from "@coopdigital/react"
+```
+
+## Developing
+
+Refer to the [root README](https://gitlab.com/coopeng/sds/oneweb/experience-kit/-/blob/main/README.md) for general development setup and usage instructions (lint, formatting, etc).
+
+
+### Package Scripts
+
+The following scripts should be run inside the react package folder.
+
+
+| Script               | Action                                   |
+| -------------------- | ---------------------------------------- |
+| `npm run test` | To run vitest |
+| `npm run test:coverage` | To run vitest test coverage |
+| `npm run test:e2e` | To run playwright in headless mode |
+| `npm run test:e2e:ui` | To run playwright with UI |
+| `npm run build` | To run build script |
+| `npm run build:storybook` | To build storybook |
+| `npm run storybook` | To run storybook |
+
+
+
+## Contributors ✨
+
+Thanks goes to these wonderful people:
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
@@ -29,9 +75,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <div><a href="#a11y-catia.costa1" title="Accessibility">️️️️♿️</a> <a href="https://gitlab.com/coopeng/sds/oneweb/experience-kit/commits/master" title="Code">💻</a> <a href="https://gitlab.com/coopeng/sds/oneweb/experience-kit/commits/master" title="Documentation">📖</a> <a href="https://gitlab.com/coopeng/sds/oneweb/experience-kit/commits/master" title="Tests">⚠️</a></div>
 </a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://gitlab.com/chris.latimer">
-<div><img src="https://s3.eu-west-1.amazonaws.com/assets.digital.coop.co.uk/oneweb/chrisl.jpg" width="200px;" alt=""/></div>
+<div><img src="https://gitlab.com/uploads/-/system/user/avatar/10570471/avatar.png" width="200px;" alt=""/></div>
 <small>Chris Latimer</small>
-<div><a href="https://gitlab.com/coopeng/sds/oneweb/experience-kit/commits/master" title="Code">💻</a> <a href="#infra-chris.latimer" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></div>
+<div><a href="#infra-chris.latimer" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://gitlab.com/coopeng/sds/oneweb/experience-kit/commits/master" title="Code">💻</a></div>
 </a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://gitlab.com/craig.mckay">
 <div><img src="https://s3.eu-west-1.amazonaws.com/assets.digital.coop.co.uk/oneweb/blank.jpg" width="200px;" alt=""/></div>
@@ -106,4 +152,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Check out the [contributing guidelines](https://gitlab.com/coopeng/sds/oneweb/experience-kit/-/blob/main/CONTRIBUTING.md) to add new people. Contributions of any kind welcome! 
+
+
+## Troubleshooting
+
+This is still a work in progress, we appreciate feedback. If you have any issues, please get in touch via [tech query channel on slack](https://co-opdigital.slack.com/archives/C0167V69R8W).

package/dist/components/Button/Button.e2e.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/Button/Button.test.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @vitest-environment jsdom
+ */
+export {};

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "@coopdigital/react",
   "type": "module",
-  "version": "0.0.9",
+  "version": "0.1.0",
   "main": "src/index.ts",
   "private": false,
   "publishConfig": {
     "access": "public"
   },
   "files": [
-    "dist/*",
-    "src/*",
-    "README.md"
+    "dist",
+    "src"
   ],
   "scripts": {
     "test": "vitest run",
@@ -24,33 +23,33 @@
     "storybook:fix-paths": "tsx scripts/storybook-fix-paths.ts"
   },
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "description": "",
   "devDependencies": {
     "@axe-core/playwright": "^4.10.1",
     "@chromatic-com/storybook": "^3.2.4",
-    "@playwright/test": "^1.50.0",
+    "@playwright/test": "^1.50.1",
     "@rollup/plugin-node-resolve": "^16.0.0",
     "@rollup/plugin-typescript": "^12.1.2",
-    "@storybook/addon-essentials": "^8.5.2",
-    "@storybook/addon-interactions": "^8.5.2",
-    "@storybook/addon-onboarding": "^8.5.2",
-    "@storybook/blocks": "^8.5.2",
-    "@storybook/manager-api": "^8.5.2",
-    "@storybook/react": "^8.5.2",
-    "@storybook/react-vite": "^8.5.2",
-    "@storybook/test": "^8.5.2",
-    "@storybook/theming": "^8.5.2",
+    "@storybook/addon-essentials": "^8.5.8",
+    "@storybook/addon-interactions": "^8.5.8",
+    "@storybook/addon-onboarding": "^8.5.8",
+    "@storybook/blocks": "^8.5.8",
+    "@storybook/manager-api": "^8.5.8",
+    "@storybook/react": "^8.5.8",
+    "@storybook/react-vite": "^8.5.8",
+    "@storybook/test": "^8.5.8",
+    "@storybook/theming": "^8.5.8",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.2.0",
-    "@types/react": "^19.0.8",
-    "@types/react-dom": "^19.0.3",
-    "rollup": "^4.32.1",
-    "storybook": "^8.5.2"
+    "@types/react": "^19.0.10",
+    "@types/react-dom": "^19.0.4",
+    "rollup": "^4.34.8",
+    "storybook": "^8.5.8"
   },
   "peerDependencies": {
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },
-  "gitHead": "12d26bdddc66ca95c7de5e6fa69f748b19b0f1b7"
+  "gitHead": "52c2b7a0bd9ddde9ee7203b6961940bafe84b61a"
 }

package/src/components/Button/Button.e2e.test.ts

@@ -0,0 +1,8 @@
+import { expect, test } from "@playwright/test"
+
+const server_url = "/iframe.html?viewMode=story&id=components-button--primary&args=&globals="
+
+test("Add to basket button visibility", async ({ page }) => {
+  await page.goto(server_url)
+  await expect(page.getByRole("button", { name: "Add to basket" })).toBeVisible()
+})

package/src/components/Button/Button.test.tsx

@@ -0,0 +1,18 @@
+/**
+ * @vitest-environment jsdom
+ */
+
+import { render } from "@testing-library/react"
+import { describe, it, afterEach } from "vitest"
+import { Button } from "."
+import { cleanup } from "@testing-library/react"
+afterEach(() => {
+  cleanup()
+})
+
+describe("Button", () => {
+  it("renders button", () => {
+    render(<Button />)
+    //screen.debug()
+  })
+})