@beeq/react 1.8.0-beta.9 → 1.8.0

package/.babelrc

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    [
+      "@nx/react/babel",
+      {
+        "runtime": "automatic",
+        "useBuiltIns": "usage"
+      }
+    ]
+  ],
+  "plugins": []
+}

package/README.md

@@ -2,35 +2,90 @@
 
 A lightweight utility that wraps BEEQ custom elements ("web components") so they can be used like native React components.
 
+## Why is this necessary?
+
+React and custom elements don't play nicely together. The problem is best described by [Custom Elements Everywhere](https://custom-elements-everywhere.com/#react):
+
+> **Handling data**
+>
+> React passes all data to Custom Elements in the form of HTML attributes. For primitive data this is fine, but the system breaks down when passing rich data, like objects or arrays. In these instances you end up with stringified values like some-attr="[object Object]" which can't actually be used.
+>
+> **Handling events**
+>
+> Because React implements its own synthetic event system, it cannot listen for DOM events coming from Custom Elements without the use of a workaround. Developers will need to reference their Custom Elements using a ref and manually attach event listeners with addEventListener. This makes working with Custom Elements cumbersome.
+
+This utility solves these problems by exposing a native React component that maps properties and events to the underlying custom element. ✨
+
 ## Package installation
 
+> [!TIP]
+> Please always refer to the [official BEEQ documentation](https://www.beeq.design/3d466e231/p/359a26-for-developers/b/28e01f) for more information about the installation.
+
 - install the package
 
 ```
-npm install @beeq/react
+npm install @beeq/{core,react}
 ```
 
-- update the package
+> [!NOTE]
+> Make sure that you have installed the `@beeq/core` package.
+
+### Add BEEQ styles and assets
 
+Import BEEQ styles into your application's main style file:
+
+```css
+@import "@beeq/core/dist/beeq/beeq.css";
 ```
-npm install @beeq/react@latest
+
+> [!TIP]
+> BEEQ uses SVG icons and these assets are shipped in a separate folder. You can use the `setBasePath` method to set the path to the icons. Make sure that your project bundle the icons in a way that they are accessible from the browser.
+
+You can move the icons from the node_modules folder to your assets folder and set the path like this:
+
+```js
+// vite.config.js
+import { defineConfig } from 'vite';
+import { viteStaticCopy } from 'vite-plugin-static-copy';
+import react from '@vitejs/plugin-react';
+
+export default defineConfig({
+  plugins: [
+    react(),
+    viteStaticCopy({
+      targets: [
+        {
+          src: './node_modules/@beeq/core/dist/beeq/svg/*',
+          dest: 'icons/svg',
+        },
+        // add more targets if needed
+      ],
+    }),
+  ],
+  // other configurations
+});
 ```
 
-if `@beeq/core` package is installed you should update both
+```js
+// main.ts
+import { setBasePath } from "@beeq/core/dist/components";
 
-```
-npm install @beeq/{core,react}
+setBasePath('icons/svg');
 ```
 
-### Add BEEQ styles and assets
+> Please, notice the path 👆
 
-Make sure that BEEQ main style is imported into your application's main style file:
+But you can also use a different icons library or a CDN:
 
-```css
-@import "@beeq/core/dist/beeq/beeq";
+```js
+import { setBasePath } from "@beeq/core/dist/components";
+
+// Using heroicons library
+setBasePath('https://cdn.jsdelivr.net/npm/heroicons@2.1.5/24/outline');
 ```
 
-> ❗️The icons SVG are shipped in a separate folder. Depending on your React stack, your project will need to include `node_modules/@beeq/core/dist/beeq/svg` in the build in such a way that it respond to: `http://<domain>/svg`
+> [!CAUTION]
+> When using a different icons library, make sure you use the correct icon names provided by the library or the CDN.
 
 ## Usage
 
@@ -52,17 +107,3 @@ function App() {
 
 export default App;
 ```
-
-## Why is this necessary?
-
-React and custom elements don't play nicely together. The problem is best described by [Custom Elements Everywhere](https://custom-elements-everywhere.com/#react):
-
-> **Handling data**
->
-> React passes all data to Custom Elements in the form of HTML attributes. For primitive data this is fine, but the system breaks down when passing rich data, like objects or arrays. In these instances you end up with stringified values like some-attr="[object Object]" which can't actually be used.
->
-> **Handling events**
->
-> Because React implements its own synthetic event system, it cannot listen for DOM events coming from Custom Elements without the use of a workaround. Developers will need to reference their Custom Elements using a ref and manually attach event listeners with addEventListener. This makes working with Custom Elements cumbersome.
-
-This utility solves these problems by exposing a native React component that maps properties and events to the underlying custom element. ✨

package/eslint.config.js

@@ -0,0 +1,41 @@
+const nxESLint = require('@nx/eslint-plugin');
+const jsoncParser = require('jsonc-eslint-parser');
+const tsESLint = require('typescript-eslint');
+
+/** @type { import("eslint").Linter.Config[] } */
+module.exports = [
+  ...tsESLint.configs.recommended,
+  {
+    languageOptions: {
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+    },
+  },
+  {
+    files: ['**/package.json', '**/project.json'],
+    languageOptions: {
+      parser: jsoncParser,
+    },
+    plugins: {
+      '@nx': nxESLint,
+    },
+    rules: {
+      '@nx/dependency-checks': [
+        'error',
+        {
+          ignoredDependencies: ['@beeq/core', '@stencil/react-output-target', 'react', 'react-dom'],
+        },
+      ],
+    },
+  },
+  {
+    files: ['**/*.js'],
+    rules: {
+      '@typescript-eslint/no-require-imports': 'off',
+    },
+  },
+];

package/jest.config.ts

@@ -0,0 +1,14 @@
+export default {
+  displayName: 'beeq-react',
+  preset: '../../jest.preset.js',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    },
+  },
+  transform: {
+    '^.+\\.[tj]sx?$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+  coverageDirectory: '../../coverage/packages/beeq-react',
+};

package/package.json

@@ -1,23 +1,22 @@
 {
-    "name": "@beeq/react",
-    "version": "1.8.0-beta.9",
-    "license": "Apache-2.0",
-    "description": "React specific wrapper for BEEQ Design System components",
-    "main": "./src/index.js",
-    "module": "./src/index.js",
-    "types": "./src/index.d.ts",
-    "dependencies": {
-        "@beeq/core": "^1.8.0-beta.9",
-        "@stencil/react-output-target": "^0.7.1"
-    },
-    "peerDependencies": {
-        "react": ">=18.0.0",
-        "react-dom": ">=18.0.0",
-        "tslib": "^2.6.3"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/Endava/BEEQ"
-    },
-    "type": "module"
-}
+  "name": "@beeq/react",
+  "version": "1.8.0",
+  "license": "Apache-2.0",
+  "description": "React specific wrapper for BEEQ Design System components",
+  "main": "./src/index.js",
+  "module": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "@beeq/core": "^1.8.0",
+    "@stencil/react-output-target": "^0.7.1"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0",
+    "tslib": "^2.6.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Endava/BEEQ"
+  }
+}

package/project.json

@@ -0,0 +1,28 @@
+{
+  "name": "beeq-react",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/beeq-react/src",
+  "projectType": "library",
+  "tags": ["wrapper", "react", "publishable"],
+  "implicitDependencies": ["beeq"],
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "options": {
+        "clean": true,
+        "main": "packages/beeq-react/src/index.ts",
+        "assets": ["packages/beeq-react/README.md"],
+        "outputPath": "dist/beeq-react",
+        "project": "packages/beeq-react/package.json",
+        "tsConfig": "packages/beeq-react/tsconfig.lib.json"
+      },
+      "dependsOn": [{ "dependencies": true, "target": "build" }]
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint",
+      "options": {
+        "lintFilePatterns": ["{projectRoot}/**/*.ts", "{projectRoot}/package.json", "{projectRoot}/project.json"]
+      }
+    }
+  }
+}