@uniformdev/context-ui 14.2.1-alpha.177

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@uniformdev/context-ui",
+  "version": "14.2.1-alpha.177+e3102741f",
+  "description": "React-based functionality and components for Uniform Context",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "main": "./dist/index.js",
+  "module": "./dist/index.esm.js",
+  "exports": {
+    ".": {
+      "import": {
+        "node": "./dist/index.mjs",
+        "default": "./dist/index.esm.js"
+      },
+      "require": "./dist/index.js"
+    },
+    "./tailwind": {
+      "import": {
+        "node": "./dist/tailwind/plugin.mjs"
+      },
+      "require": "./dist/tailwind/plugin.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/index.d.ts"
+      ],
+      "tailwind": [
+        "./dist/tailwind/plugin.d.ts"
+      ]
+    }
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "run-s build:icons build:esm",
+    "build:esm": "tsup --minify",
+    "build:icons": "svgr -d ./src/assets ./src/assets --typescript --icon",
+    "dev": "tsup --watch",
+    "clean": "rimraf dist",
+    "test": "jest --maxWorkers=1 --passWithNoTests",
+    "lint": "eslint \"src/**/*.{js,ts,tsx}\"",
+    "format": "prettier --write \"src/**/*.{js,ts,tsx}\"",
+    "storybook": "pnpm build && start-storybook -p 9011 -c ./.storybook",
+    "storybook:publish": "pnpm build && pnpm build-storybook -o ./out"
+  },
+  "dependencies": {
+    "@uniformdev/context": "^14.2.1-alpha.177+e3102741f",
+    "immer": "9.0.12",
+    "react-beautiful-dnd": "13.1.0",
+    "react-select": "5.2.2",
+    "react-use": "17.3.2",
+    "reakit": "1.3.11",
+    "timeago.js": "4.0.2",
+    "uuid": "8.3.2"
+  },
+  "peerDependencies": {
+    "react": ">=16.8"
+  },
+  "devDependencies": {
+    "@babel/core": "7.17.5",
+    "@storybook/addon-controls": "6.4.19",
+    "@storybook/addon-essentials": "6.4.19",
+    "@storybook/addon-postcss": "2.0.0",
+    "@storybook/builder-webpack5": "^6.5.0-alpha.48",
+    "@storybook/manager-webpack5": "^6.5.0-alpha.48",
+    "@storybook/react": "6.4.19",
+    "@svgr/cli": "6.2.1",
+    "@tailwindcss/forms": "0.5.0",
+    "@types/react-beautiful-dnd": "13.1.2",
+    "autoprefixer": "10.4.2",
+    "postcss": "8.4.8",
+    "postcss-import": "14.0.2",
+    "react": "17.0.2",
+    "react-dom": "17.0.2",
+    "tailwindcss": "3.0.23",
+    "webpack": "5"
+  },
+  "files": [
+    "/dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "e3102741f79fa495dba2796f59e3b2a6734c3c7e"
+}

package/readme.md

@@ -0,0 +1,34 @@
+# Development notes
+
+## Developing
+* Copy/past `.env.example` and rename to `.env`, set up your project id, host, and API key.
+* `pnpm storybook` - run storybook app on http://localhost:9011/, is used for creating and editing components.
+
+## Icon component
+Icon component can be is used only as a child of IconsProvider component.
+
+## Build
+* `pnpm build` - builds icons, JS modules, and CSS.
+
+## CSS
+This package uses Tailwind CSS. Run `pnpm build:css` to compile the CSS file, which will run PostCSS with the Tailwind plugin against all `.css` files in the `assets` folder. The compiled CSS will be output to `dist/assets/[filename].css`.
+
+When Sanity Studio imports the JS modules exported by our plugin, the Sanity Studio bundler will also automatically import any CSS files that our code imports, e.g. `import '../dist/assets/optimize.css';`
+
+> NOTE: be sure to set NODE_ENV=production if you want PostCSS to purge unused CSS.
+
+## Icons
+If you want to import SVG icons as components in your code, do the following:
+
+* Add the the SVG icon to the `src/assets` folder
+* Run `pnpm build:icons`
+
+This will generate React components for every SVG icon in the `src/assets` folder. You can then import the icons in other React components, e.g. `import MyIcon from '../assets/MyIcon';`.
+
+Ideally, we could have `import MyIcon from '../assets/my-icon.svg` in our code and the SVG icon would automatically be converted to a React component at build time and our source code would be transformed to import the component. However, we're not using a bundler so it becomes challenging because we can't "hook" into the TypeScript build/transpile process. We could introduce a build tool like `ESBuild` or `@babel/typescript` and stop using `tsc`, but those options more tooling/overhead. We could also potentially use something like `ttypescript` (https://github.com/cevek/ttypescript) to create babel-esque plugins for TypeScript, but who knows how reliable that is and if we'd run into any issues in CI/testing.
+
+So, for now, icons are somewhat of a manual process.
+
+## CommonJS
+
+No CommonJS modules are exported from this package as the package is intended to be consumed by Sanity Studio and not used during SSR.