@justeattakeaway/pie-notification 0.0.0 → 0.1.1

package/README.md

@@ -14,9 +14,8 @@
 2. [Installation](#installation)
 3. [Importing the component](#importing-the-component)
 4. [Peer Dependencies](#peer-dependencies)
-5. [Local Development](#local-development)
-6. [Props](#props)
-7. [Testing](#testing)
+5. [Props](#props)
+6. [Contributing](#contributing)
 
 ## pie-notification
 
@@ -42,45 +41,34 @@ For full information on using PIE components as part of an application, check ou
 
 ### Importing the component
 
+#### JavaScript
 ```js
-// default
+// Default – for Native JS Applications, Vue, Angular, Svelte, etc.
 import { PieNotification } from '@justeattakeaway/pie-notification';
 
-// react
+// If you don't need to reference the imported object, you can simply
+// import the module which registers the component as a custom element.
+import '@justeattakeaway/pie-notification';
+```
+
+#### React
+```js
+// React
+// For React, you will need to import our React-specific component build
+// which wraps the web component using @lit-labs/react
 import { PieNotification } from '@justeattakeaway/pie-notification/dist/react';
 ```
 
+> [!NOTE]
+> When using the React version of the component, please make sure to also
+> include React as a [peer dependency](#peer-dependencies) in your project.
+
 
 ## Peer Dependencies
 
 > [!IMPORTANT]
 > When using `pie-notification`, 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.
 
-
-## Local development
-
-Install the dependencies. Note that this, and the following commands below, should be run from the **root of the monorepo**:
-
-```bash
-yarn
-```
-
-To build the `pie-notification` package, run the following command:
-
-```bash
-yarn build --filter=pie-notification
-```
-
-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:
-
-```bash
-yarn watch --filter=pie-notification
-
-# in a separate terminal tab, run
-yarn dev --filter=pie-storybook
-```
-
-
 ## Props
 
 | Property | Type | Default | Description |
@@ -97,36 +85,6 @@ In your markup or JSX, you can then use these to set the properties for the `pie
 <PieNotification></PieNotification>
 ```
 
-## Testing
+## Contributing
 
-### Browser tests
-
-To run the browser tests, run the following command from the root of the monorepo:
-
-```bash
-yarn test:browsers --filter=pie-notification
-```
-
-### Visual tests
-
-To run the visual regression tests, run the following command from the root of the monorepo:
-
-```bash
-yarn test:visual --filter=pie-notification
-```
-
-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.
-
-#### Setup via bash
-
-```bash
-export PERCY_TOKEN_PIE_NOTIFICATION=abcde
-```
-
-#### Setup via package.json
-
-Under scripts `test:visual` replace the environment variable with the below:
-
-```bash
-PERCY_TOKEN_PIE_NOTIFICATION=abcde
-```
+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/react.js

@@ -1,63 +1,64 @@
 import * as g from "react";
-import { PieNotification as M } from "./index.js";
+import { PieNotification as E } from "./index.js";
 import "lit";
 /**
  * @license
  * Copyright 2018 Google LLC
  * SPDX-License-Identifier: BSD-3-Clause
  */
-const P = /* @__PURE__ */ new Set(["children", "localName", "ref", "style", "className"]), E = /* @__PURE__ */ new WeakMap(), b = (d, l, m, p, h) => {
-  const n = h == null ? void 0 : h[l];
-  n === void 0 || m === p ? m == null && l in HTMLElement.prototype ? d.removeAttribute(l) : d[l] = m : ((o, t, u) => {
-    let s = E.get(o);
-    s === void 0 && E.set(o, s = /* @__PURE__ */ new Map());
-    let a = s.get(t);
-    u !== void 0 ? a === void 0 ? (s.set(t, a = { handleEvent: u }), o.addEventListener(t, a)) : a.handleEvent = u : a !== void 0 && (s.delete(t), o.removeEventListener(t, a));
-  })(d, n, m);
+const b = /* @__PURE__ */ new Set(["children", "localName", "ref", "style", "className"]), w = /* @__PURE__ */ new WeakMap(), M = (t, i, d, m, p) => {
+  const s = p == null ? void 0 : p[i];
+  s === void 0 || d === m ? d == null && i in HTMLElement.prototype ? t.removeAttribute(i) : t[i] = d : ((a, o, h) => {
+    let r = w.get(a);
+    r === void 0 && w.set(a, r = /* @__PURE__ */ new Map());
+    let l = r.get(o);
+    h !== void 0 ? l === void 0 ? (r.set(o, l = { handleEvent: h }), a.addEventListener(o, l)) : l.handleEvent = h : l !== void 0 && (r.delete(o), a.removeEventListener(o, l));
+  })(t, s, d);
+}, P = (t, i) => {
+  typeof t == "function" ? t(i) : t.current = i;
 };
-function C(d = window.React, l, m, p, h) {
-  let n, o, t;
-  if (l === void 0) {
-    const r = d;
-    ({ tagName: o, elementClass: t, events: p, displayName: h } = r), n = r.react;
+function C(t = window.React, i, d, m, p) {
+  let s, a, o;
+  if (i === void 0) {
+    const c = t;
+    ({ tagName: a, elementClass: o, events: m, displayName: p } = c), s = c.react;
   } else
-    n = d, t = m, o = l;
-  const u = n.Component, s = n.createElement, a = new Set(Object.keys(p ?? {}));
-  class v extends u {
+    s = t, o = d, a = i;
+  const h = s.Component, r = s.createElement, l = new Set(Object.keys(m ?? {}));
+  class v extends h {
     constructor() {
       super(...arguments), this.o = null;
     }
     t(e) {
       if (this.o !== null)
-        for (const f in this.i)
-          b(this.o, f, this.props[f], e ? e[f] : void 0, p);
+        for (const u in this.i)
+          M(this.o, u, this.props[u], e ? e[u] : void 0, m);
     }
     componentDidMount() {
-      this.t();
+      var e;
+      this.t(), (e = this.o) === null || e === void 0 || e.removeAttribute("defer-hydration");
     }
     componentDidUpdate(e) {
       this.t(e);
     }
     render() {
-      const { _$Gl: e, ...f } = this.props;
-      this.h !== e && (this.u = (i) => {
-        e !== null && ((c, w) => {
-          typeof c == "function" ? c(w) : c.current = w;
-        })(e, i), this.o = i, this.h = e;
+      const { _$Gl: e, ...u } = this.props;
+      this.h !== e && (this.u = (n) => {
+        e !== null && P(e, n), this.o = n, this.h = e;
       }), this.i = {};
-      const N = { ref: this.u };
-      for (const [i, c] of Object.entries(f))
-        P.has(i) ? N[i === "className" ? "class" : i] = c : a.has(i) || i in t.prototype ? this.i[i] = c : N[i] = c;
-      return s(o, N);
+      const f = { ref: this.u };
+      for (const [n, N] of Object.entries(u))
+        b.has(n) ? f[n === "className" ? "class" : n] = N : l.has(n) || n in o.prototype ? this.i[n] = N : f[n] = N;
+      return f.suppressHydrationWarning = !0, r(a, f);
     }
   }
-  v.displayName = h ?? t.name;
-  const y = n.forwardRef((r, e) => s(v, { ...r, _$Gl: e }, r == null ? void 0 : r.children));
+  v.displayName = p ?? o.name;
+  const y = s.forwardRef((c, e) => r(v, { ...c, _$Gl: e }, c == null ? void 0 : c.children));
   return y.displayName = v.displayName, y;
 }
 const $ = C({
   displayName: "PieNotification",
-  elementClass: M,
+  elementClass: E,
   react: g,
   tagName: "pie-notification",
   events: {}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@justeattakeaway/pie-notification",
   "description": "PIE Design System Notification built using Web Components",
-  "version": "0.0.0",
+  "version": "0.1.1",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -28,10 +28,10 @@
   "author": "Just Eat Takeaway.com - Design System Team",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@justeattakeaway/pie-components-config": "workspace:*"
+    "@justeattakeaway/pie-components-config": "0.4.0"
   },
   "dependencies": {
-    "@justeattakeaway/pie-webc-core": "workspace:*"
+    "@justeattakeaway/pie-webc-core": "0.11.0"
   },
   "volta": {
     "extends": "../../../package.json"