@talxis/base-controls 1.2408.16 → 1.2408.18

package/README.md

@@ -1,18 +1,32 @@
-# Building the components locally
+# Running the controls in local PCF harness
 
 1. Run `npm install` inside the root directory.
-1. Run `npm run sandbox`. This will run the sandbox environment located in `src/sandbox`,
-where you can import and test all of the components (the source code for all components is located in `src/components`).
-1. Optionally, you can run `npm run documentation` to view the current documentation for existing components and use it for testing purposes.
+1. Navigate to `examples` folder which contains a PCF wrapper for each Base Control.
+1. Navigate to the desired control folder and run `npm install` again.
+1. Run `npm start watch`. This will open the local PCF harness. If you make any changes in the Base Control being used by the wrapper, it will automatically re-build the PCF and show your changes.
 
-# Testing the components locally in Portal
+# Running the controls in Portal
 
-1. Run `npm i yalc -g` (only needed once)
-1. Navigate to the shared components root directory.
+1. Navigate to the root directory.
+1. Run `npm install`.
 1. Run `npm run build`.
-1. Run `yalc publish`.
-1. Go to the Portal.Web.Frontend directory and run `yalc add @talxis/react-components`. This will replace the NPM package in `package.json` with the locally built version.
-1. Run the Portal.
+1. Run `npm link`.
+1. Go to `Portal.Web.Frontend` directory.
+1. Add the following prop in the `vite.config.mts` file under `defineConfig`:
+
+```typescript
+optimizeDeps: {
+    exclude: ['@talxis/base-controls']
+}
+```
+7. Delete `node_modules`
+8. Run `npm install`
+9. Run `npm link @talxis/base-controls`
+10. Run `npm start`
+
+These steps only need to be done once. If you want to see any future changes you made in Base Control package, you need to run `npm run build` in Base Control root directory and Portal will automatically reload with your changes applied.
+
+**Don't forget to revert the `vite.config.mts` file to the original version before pushing any changes to the Portal repo!**
+
+> **_NOTE:_**  If Portal starts to complain that there is a mismatch in React versions, you need to delete the `react` and `react-dom` packages from the `node_modules` folder in Base Controls
 
-If you want to see the latest changes applied, repeat steps 2 and 3 and run `yalc update` in the `Portal.Web.Frontend` directory.
-**Don't forget to revert the `package.json` file to the original version before pushing any changes to the Portal repo!**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talxis/base-controls",
-  "version": "1.2408.16",
+  "version": "1.2408.18",
   "description": "Set of React components that natively work with Power Apps Component Framework API's",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -34,7 +34,6 @@
     "esbuild": "^0.13.9",
     "glob": "^11.0.0",
     "postcss": "^8.3.11",
-    "react-scripts": "^5.0.0",
     "rollup": "^2.58.1",
     "rollup-plugin-delete": "^2.0.0",
     "rollup-plugin-dts": "^4.0.0",
@@ -49,10 +48,7 @@
   },
   "scripts": {
     "build": "rollup -c",
-    "test": "react-scripts test",
-    "eject": "react-scripts eject",
     "documentation": "start-storybook -p 6006",
-    "sandbox": "react-scripts start",
     "build-documentation": "build-storybook",
     "lint": "eslint \"./src/**\"",
     "lint:fix": "eslint \"./src/**\" --fix",
@@ -84,7 +80,7 @@
     "@fluentui/react": "^8.119.1",
     "@fluentui/react-migration-v8-v9": "^9.6.20",
     "@talxis/client-libraries": "1.2407.2",
-    "@talxis/react-components": "1.2408.7",
+    "@talxis/react-components": "1.2408.10",
     "color": "^4.2.3",
     "dayjs": "^1.11.10",
     "external-svg-loader": "^1.7.1",