@justeattakeaway/pie-link 0.0.0

package/.eslintignore

@@ -0,0 +1,6 @@
+.turbo
+dist
+node_modules
+lit-browsers-report
+lit-visual-report
+test-results

package/.turbo/turbo-build.log

@@ -0,0 +1,14 @@
+[8:54:51 PM] @custom-elements-manifest/analyzer: Created new manifest.
+react wrapper has been added!
+vite v4.3.9 building for production...
+transforming...
+✓ 12 modules transformed.
+rendering chunks...
+computing gzip size...
+dist/index.js   0.27 kB │ gzip:  0.22 kB
+dist/react.js  58.94 kB │ gzip: 15.90 kB
+
+[vite:dts] Start generate declaration files...
+✓ built in 11.55s
+[vite:dts] Declaration files built in 10712ms.
+

package/LICENSE

@@ -0,0 +1,17 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+Copyright (c) Just Eat Takeaway.com
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,106 @@
+<p align="center">
+  <img align="center" src="../../../readme_image.png" height="200" alt="">
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/@justeattakeaway/pie-link">
+    <img alt="GitHub Workflow Status" src="https://img.shields.io/npm/v/@justeattakeaway/pie-link.svg">
+  </a>
+</p>
+
+# Table of Contents
+
+1. [Introduction](#pie-link)
+2. [Local Development](#local-development)
+3. [Importing the component](#importing-the-component)
+4. [Props](#props)
+5. [Testing](#testing)
+
+# pie-link
+
+`pie-link` is a Web Component built using the Lit library.
+
+This component can be easily integrated into various frontend frameworks and customized through a set of properties.
+
+## 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-link` package, run the following command:
+
+```bash
+yarn build --filter=pie-link
+```
+
+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-link
+
+# in a separate terminal tab, run
+yarn dev --filter=pie-storybook
+```
+
+### Importing the component
+
+```js
+// default
+import { PieLink } from '@justeattakeaway/pie-link';
+
+// react
+import { PieLink } from '@justeattakeaway/pie-link/dist/react';
+```
+
+## Props
+
+| Property | Type | Default | Description |
+|---|---|---|---|
+| - | - | - | - |
+
+In your markup or JSX, you can then use these to set the properties for the `pie-link` component:
+
+```html
+<!-- Native HTML -->
+<pie-link></pie-link>
+
+<!-- JSX -->
+<PieLink></PieLink>
+```
+
+## Testing
+
+### Browser tests
+
+To run the browser tests, run the following command from the root of the monorepo:
+
+```bash
+yarn test:browsers --filter=pie-link
+```
+
+### Visual tests
+
+To run the visual regression tests, run the following command from the root of the monorepo:
+
+```bash
+yarn test:visual --filter=pie-link
+```
+
+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_LINK=abcde
+```
+
+#### Setup via package.json
+
+Under scripts `test:visual` replace the environment variable with the below:
+
+```bash
+PERCY_TOKEN_PIE_LINK=abcde
+```

package/declaration.d.ts

@@ -0,0 +1,9 @@
+declare module '*.scss' {
+    const content: Record<string, string>;
+    export default content;
+}
+
+declare module '*.scss?inline' {
+    const content: Record<string, string>;
+    export default content;
+}

package/dist/index.js

@@ -0,0 +1,12 @@
+import { unsafeCSS as t, LitElement as n, html as s } from "lit";
+const l = "", o = "pie-link";
+class e extends n {
+  render() {
+    return s`<h1 data-test-id="pie-link">Hello world!</h1>`;
+  }
+}
+e.styles = t(l);
+customElements.define(o, e);
+export {
+  e as PieLink
+};