@justeattakeaway/pie-assistive-text 0.1.0

package/README.md

@@ -0,0 +1,91 @@
+<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-assistive-text">
+    <img alt="GitHub Workflow Status" src="https://img.shields.io/npm/v/@justeattakeaway/pie-assistive-text.svg">
+  </a>
+</p>
+
+# Table of Contents
+
+1. [Introduction](#pie-assistive-text)
+2. [Installation](#installation)
+3. [Importing the component](#importing-the-component)
+4. [Peer Dependencies](#peer-dependencies)
+5. [Props](#props)
+6. [Contributing](#contributing)
+
+## pie-assistive-text
+
+`pie-assistive-text` 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.
+
+
+## Installation
+
+To install `pie-assistive-text` in your application, run the following on your command line:
+
+```bash
+# npm
+$ npm i @justeattakeaway/pie-assistive-text
+
+# yarn
+$ yarn add @justeattakeaway/pie-assistive-text
+```
+
+For full information on using PIE components as part of an application, check out the [Getting Started Guide](https://github.com/justeattakeaway/pie/wiki/Getting-started-with-PIE-Web-Components).
+
+
+### Importing the component
+
+#### JavaScript
+```js
+// Default – for Native JS Applications, Vue, Angular, Svelte, etc.
+import { PieAssistiveText } from '@justeattakeaway/pie-assistive-text';
+
+// 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-assistive-text';
+```
+
+#### React
+```js
+// React
+// For React, you will need to import our React-specific component build
+// which wraps the web component using ​@lit/react
+import { PieAssistiveText } from '@justeattakeaway/pie-assistive-text/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-assistive-text`, 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.
+
+
+## Props
+
+| Property | Type | Default | Description |
+|---|---|---|---|
+| - | - | - | - |
+
+In your markup or JSX, you can then use these to set the properties for the `pie-assistive-text` component:
+
+```html
+<!-- Native HTML -->
+<pie-assistive-text></pie-assistive-text>
+
+<!-- JSX -->
+<PieAssistiveText></PieAssistiveText>
+```
+
+## Contributing
+
+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/custom-elements.json

@@ -0,0 +1,54 @@
+{
+  "schemaVersion": "1.0.0",
+  "readme": "",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "src/defs-react.js",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/defs.js",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/index.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "PieAssistiveText",
+          "members": [],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "pie-assistive-text",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./defs"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PieAssistiveText",
+          "declaration": {
+            "name": "PieAssistiveText",
+            "module": "src/index.js"
+          }
+        }
+      ]
+    }
+  ]
+}

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.d.ts

@@ -0,0 +1,16 @@
+import type { CSSResult } from 'lit';
+import type { LitElement } from 'lit';
+import type { TemplateResult } from 'lit-html';
+
+export declare interface AssistiveTextProps {
+}
+
+/**
+ * @tagname pie-assistive-text
+ */
+export declare class PieAssistiveText extends LitElement implements AssistiveTextProps {
+    render(): TemplateResult<1>;
+    static styles: CSSResult;
+}
+
+export { }

package/dist/index.js

@@ -0,0 +1,13 @@
+import { unsafeCSS as t, LitElement as s, html as i } from "lit";
+import { defineCustomElement as o } from "@justeattakeaway/pie-webc-core";
+const n = "", r = "pie-assistive-text";
+class e extends s {
+  render() {
+    return i`<h1 data-test-id="pie-assistive-text">Hello world!</h1>`;
+  }
+}
+e.styles = t(n);
+o(r, e);
+export {
+  e as PieAssistiveText
+};

package/dist/react.d.ts

@@ -0,0 +1,21 @@
+import type { CSSResult } from 'lit';
+import type { LitElement } from 'lit';
+import * as React_2 from 'react';
+import type { TemplateResult } from 'lit-html';
+
+export declare interface AssistiveTextProps {
+}
+
+export declare const PieAssistiveText: React_2.ForwardRefExoticComponent<AssistiveTextProps & React_2.RefAttributes<PieAssistiveText_2> & ReactBaseType>;
+
+/**
+ * @tagname pie-assistive-text
+ */
+declare class PieAssistiveText_2 extends LitElement implements AssistiveTextProps {
+    render(): TemplateResult<1>;
+    static styles: CSSResult;
+}
+
+declare type ReactBaseType = React_2.HTMLAttributes<HTMLElement>;
+
+export { }

package/dist/react.js

@@ -0,0 +1,15 @@
+import * as e from "react";
+import { createComponent as t } from "@lit/react";
+import { PieAssistiveText as s } from "./index.js";
+import "lit";
+import "@justeattakeaway/pie-webc-core";
+const i = t({
+  displayName: "PieAssistiveText",
+  elementClass: s,
+  react: e,
+  tagName: "pie-assistive-text",
+  events: {}
+}), p = i;
+export {
+  p as PieAssistiveText
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@justeattakeaway/pie-assistive-text",
+  "description": "PIE Design System Assistive Text built using Web Components",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "custom-elements.json",
+    "src",
+    "dist",
+    "**/*.d.ts"
+  ],
+  "scripts": {
+    "build": "npx build-react-wrapper && run -T vite build",
+    "create:manifest": "yarn cem analyze --litelement",
+    "lint:scripts": "run -T eslint .",
+    "lint:scripts:fix": "yarn lint:scripts --fix",
+    "lint:style": "run -T stylelint ./src/**/*.{css,scss}",
+    "lint:style:fix": "yarn lint:style --fix",
+    "watch": "run -T vite build --watch",
+    "test": "echo \"Error: no test specified\" && exit 0",
+    "test:ci": "yarn test",
+    "test:browsers": "npx playwright test -c ./playwright-lit.config.ts",
+    "test:browsers:ci": "yarn test:browsers",
+    "test:visual": "run -T cross-env-shell PERCY_TOKEN=${PERCY_TOKEN_PIE_ASSISTIVE_TEXT} percy exec --allowed-hostname cloudfront.net -- npx playwright test -c ./playwright-lit-visual.config.ts",
+    "test:visual:ci": "yarn test:visual"
+  },
+  "author": "Just Eat Takeaway.com - Design System Team",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@custom-elements-manifest/analyzer": "0.9.0",
+    "@justeattakeaway/pie-components-config": "workspace:*",
+    "cem-plugin-module-file-extensions": "0.0.5"
+  },
+  "dependencies": {
+    "@justeattakeaway/pie-webc-core": "workspace:*"
+  },
+  "volta": {
+    "extends": "../../../package.json"
+  },
+  "customElements": "custom-elements.json",
+  "sideEffects": [
+    "dist/*.js"
+  ]
+}

package/src/assistive-text.scss

@@ -0,0 +1 @@
+@use '@justeattakeaway/pie-css/scss' as p;

package/src/defs-react.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+/**
+ * TODO: Verify if ReactBaseType can be set as a more specific React interface
+ * Use the React IntrinsicElements interface to find how to map standard HTML elements to existing React Interfaces
+ * Example: an HTML button maps to `React.ButtonHTMLAttributes<HTMLButtonElement>`
+ * https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0bb210867d16170c4a08d9ce5d132817651a0f80/types/react/index.d.ts#L2829
+ */
+export type ReactBaseType = React.HTMLAttributes<HTMLElement>

package/src/defs.ts

@@ -0,0 +1,3 @@
+// TODO - please remove the eslint disable comment below when you add props to this interface
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface AssistiveTextProps {}

package/src/index.ts

@@ -0,0 +1,30 @@
+import { LitElement, html, unsafeCSS } from 'lit';
+
+import { defineCustomElement } from '@justeattakeaway/pie-webc-core';
+import styles from './assistive-text.scss?inline';
+import { AssistiveTextProps } from './defs';
+
+// Valid values available to consumers
+export * from './defs';
+
+const componentSelector = 'pie-assistive-text';
+
+/**
+ * @tagname pie-assistive-text
+ */
+export class PieAssistiveText extends LitElement implements AssistiveTextProps {
+    render () {
+        return html`<h1 data-test-id="pie-assistive-text">Hello world!</h1>`;
+    }
+
+    // Renders a `CSSResult` generated from SCSS by Vite
+    static styles = unsafeCSS(styles);
+}
+
+defineCustomElement(componentSelector, PieAssistiveText);
+
+declare global {
+    interface HTMLElementTagNameMap {
+        [componentSelector]: PieAssistiveText;
+    }
+}