create-swc-uxp-react-app

create-swc-uxp-react-app

This package includes the global command for to create a UXP-SWC app in React context.

Prerequisites

1. NodeJS >= 18.x
2. Yarn v3.x (Quick steps to migrate from yarn 1.x)
3. UXP v7.2

Quick Start

1. Use the create-swc-uxp-react-app to create the boiler plate project

   npx create-swc-uxp-react-app <name-of-the-app>
   cd <name-of-the-app>

2. Make the config changes to define how node packages should be installed.

   yarn config set nodeLinker "node-modules"

3. Install the dependancies

   yarn install

4. Install respective components from swc-uxp-wrapper and swc-react libraries.

   yarn add @swc-uxp-wrappers/checkbox
   yarn add @swc-react/checkbox
   yarn watch (and continue using the react components)
   

5. Once you have the project structure ready, you can import the component in for example App.js

   import { Checkbox } from "@swc-react/checkbox";

   And finally use the component

   <Checkbox> I am a checkbox</Checkbox>