misc cleanup (#146)

* cleanup TypeScript
* Update READMEs

Author: Christopher J Baker

README.md

@@ -2,10 +2,20 @@
 
 `@r2wc/react-to-web-component` converts [React](https://reactjs.org/) components to [custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements)! It lets you share React components as native elements that **don't** require being mounted through React. The custom element acts as a wrapper for the underlying React component. Use these custom elements with any project that uses HTML even in any framework (vue, svelte, angular, ember, canjs) the same way you would use standard HTML elements.
 
+> Note: The latest version of this package only works with the React 18. If you are using React 16 or 17, please use version 1.
+
 `@r2wc/react-to-web-component`:
 
 - Works in all modern browsers. (Edge needs a [customElements polyfill](https://github.com/webcomponents/polyfills/tree/master/packages/custom-elements)).
-- Is `1.11KB` minified and gzipped.
+- Is `1.26KB` minified and gzipped.
+
+## Setup
+
+To install from npm:
+
+```
+npm install @r2wc/react-to-web-component
+```
 
 ## Need help or have questions?
 
@@ -46,8 +56,6 @@ Now we can use `<web-greeting>` like any other HTML element!
 </body>
 ```
 
-Note that by using React 18, `r2wc` will use the new root API. If your application needs the legacy API, please use React 17
-
 In the above case, the web-greeting custom element is not making use of the `name` property from our `Greeting` component.
 
 ## Working with Attributes
@@ -81,25 +89,15 @@ For projects needing more advanced usage of the web components, see our [program
 
 We also have a [complete example using a third party library](docs/complete-example.md).
 
-## Setup
-
-To install from npm:
+## Examples
 
-```
-npm install @r2wc/react-to-web-component
-```
+* [Hello World](https://codesandbox.io/s/hello-world-md5oih) - The quintessential software demo!
+* [All the Props](https://codesandbox.io/s/all-the-props-n8z5hv) - A demo of all the prop transform types that R2WC supports.
+* [Header Example](https://codesandbox.io/s/example-header-blog-7k313l) - An example reusable Header component.
+* [MUI Button](https://codesandbox.io/s/example-mui-button-qwidh9) - An example application using an MUI button with theme customization.
+* [Checklist Demo](https://codesandbox.io/s/example-checklist-blog-y3nqwx) - An example Checklist application.
 
-## External Examples
-
-Greeting example in [CodeSandbox](https://codesandbox.io/s/sample-greeting-app-ts-qwidh9)
-
-Hello, world example (React17) in [CodeSandbox](https://codesandbox.io/s/hello-world-react17-u4l3x1)
-
-Example with all prop types in [CodeSandbox](https://codesandbox.io/p/sandbox/vite-example-with-numerous-types-gjf87o)
-
-R2WC With Vite Header Example in [CodeSandbox](https://codesandbox.io/p/sandbox/r2wc-header-example-vqzfgo)
-
-## External Blog Posts
+## Blog Posts
 
 R2WC with Vite [View Post](https://www.bitovi.com/blog/react-everywhere-with-vite-and-react-to-webcomponent)
 
@@ -112,30 +110,13 @@ Check out our [full API documentation](https://github.com/bitovi/react-to-web-co
 Under the hood, `r2wc` creates a `CustomElementConstructor` with custom getters/setters and life cycle methods that keep track of the props that you have defined. When a property is set, its custom setter:
 
 - re-renders the React component inside the custom element.
-- creates an enumerable getter / setter on the instance
-  to save the set value and avoid hitting the proxy in the future.
+- creates an enumerable getter / setter on the instance to save the set value and avoid hitting the proxy in the future.
 
 Also:
 
 - Enumerable properties and values on the custom element are used as the `props` passed to the React component.
 - The React component is not rendered until the custom element is inserted into the page.
 
-# Tests
-
-To run tests, first run:
-
-```
-npm run buildtests
-```
-
-This copies the root test file into each of the `/tests/react*` versioned folders, modifies the ReactDOM import for older versions, and installs the corresponding version of react in that directory.
-
-Then run:
-
-```
-npm run test
-```
-
 # We want to hear from you.
 
 Come chat with us about open source in our Bitovi community [Discord](https://discord.gg/J7ejFsZnJ4).

package.json

@@ -1,9 +1,10 @@
 {
+  "private": true,
+  "homepage": "https://www.bitovi.com/open-source/react-to-web-component",
   "namespace": "r2wc",
   "workspaces": [
     "packages/*"
   ],
-  "private": true,
   "scripts": {
     "check-packages": "ts-node ./scripts/check-packages"
   },

packages/core/README.md

@@ -0,0 +1,33 @@
+# React to Web Component
+
+`@r2wc/core` is the heart of our system that converts [React](https://reactjs.org/) components to [custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements)! It lets you share React components as native elements that **don't** require being mounted through React. The custom element acts as a wrapper for the underlying React component. Use these custom elements with any project that uses HTML even in any framework (vue, svelte, angular, ember, canjs) the same way you would use standard HTML elements.
+
+This project is an internal library that should not need to be used directly outside of renderers designed for this system, such as [@r2wc/react-to-web-component](../react-to-web-component).
+
+## Need help or have questions?
+
+This project is supported by [Bitovi, a React consultancy](https://www.bitovi.com/frontend-javascript-consulting/react-consulting). You can get help or ask questions on our:
+
+- [Discord Community](https://discord.gg/J7ejFsZnJ4)
+- [Twitter](https://twitter.com/bitovi)
+
+Or, you can hire us for training, consulting, or development. [Set up a free consultation.](https://www.bitovi.com/frontend-javascript-consulting/react-consulting)
+
+
+## How it works
+
+Under the hood, `r2wc` creates a `CustomElementConstructor` with custom getters/setters and life cycle methods that keep track of the props that you have defined. When a property is set, its custom setter:
+
+- re-renders the React component inside the custom element.
+- creates an enumerable getter / setter on the instance to save the set value and avoid hitting the proxy in the future.
+
+Also:
+
+- Enumerable properties and values on the custom element are used as the `props` passed to the React component.
+- The React component is not rendered until the custom element is inserted into the page.
+
+# We want to hear from you.
+
+Come chat with us about open source in our Bitovi community [Discord](https://discord.gg/J7ejFsZnJ4).
+
+See what we're up to by following us on [Twitter](https://twitter.com/bitovi).

packages/core/package.json

@@ -2,7 +2,7 @@
   "name": "@r2wc/core",
   "version": "1.0.1",
   "description": "Convert framework components to native Web Components.",
-  "homepage": "https://www.bitovi.com/frontend-javascript-consulting/react-consulting",
+  "homepage": "https://www.bitovi.com/open-source/react-to-web-component",
   "author": "Bitovi",
   "license": "MIT",
   "keywords": [

packages/core/src/core.ts

@@ -1,8 +1,9 @@
 import type { R2WCType } from "./transforms"
 
 import transforms from "./transforms"
+import { toDashedCase } from "./utils"
 
-type PropName<Props> = Extract<keyof Props, string>
+type PropName<Props> = Exclude<Extract<keyof Props, string>, "container">
 type PropNames<Props> = Array<PropName<Props>>
 
 export interface R2WCOptions<Props> {
@@ -20,6 +21,10 @@ export interface R2WCRenderer<Props, Context> {
   unmount: (context: Context) => void
 }
 
+export interface R2WCBaseProps {
+  container?: HTMLElement
+}
+
 const renderSymbol = Symbol.for("r2wc.render")
 const connectedSymbol = Symbol.for("r2wc.connected")
 const contextSymbol = Symbol.for("r2wc.context")
@@ -32,7 +37,7 @@ const propsSymbol = Symbol.for("r2wc.props")
  * @param {String?} options.shadow - Shadow DOM mode as either open or closed.
  * @param {Object|Array?} options.props - Array of camelCasedProps to watch as Strings or { [camelCasedProp]: "string" | "number" | "boolean" | "function" | "json" }
  */
-export default function r2wc<Props, Context>(
+export default function r2wc<Props extends R2WCBaseProps, Context>(
   ReactComponent: React.ComponentType<Props>,
   options: R2WCOptions<Props>,
   renderer: R2WCRenderer<Props, Context>,
@@ -43,14 +48,9 @@ export default function r2wc<Props, Context>(
       : []
   }
 
-  const propNames = (
-    Array.isArray(options.props)
-      ? options.props.slice()
-      : (Object.keys(options.props) as PropNames<Props>)
-  ).filter((prop) => {
-    //@ts-ignore
-    return prop !== "container"
-  })
+  const propNames = Array.isArray(options.props)
+    ? options.props.slice()
+    : (Object.keys(options.props) as PropNames<Props>)
 
   const propTypes = {} as Record<PropName<Props>, R2WCType>
   const mapPropAttribute = {} as Record<PropName<Props>, string>
@@ -60,7 +60,7 @@ export default function r2wc<Props, Context>(
       ? "string"
       : options.props[prop]
 
-    const attribute = toDashedStyle(prop)
+    const attribute = toDashedCase(prop)
 
     mapPropAttribute[prop] = attribute
     mapAttributeProp[attribute] = prop
@@ -87,7 +87,6 @@ export default function r2wc<Props, Context>(
         this.container = this
       }
 
-      // @ts-ignore: There won't always be a container in the definition
       this[propsSymbol].container = this.container
 
       for (const prop of propNames) {
@@ -96,9 +95,9 @@ export default function r2wc<Props, Context>(
         const type = propTypes[prop]
         const transform = transforms[type]
 
-        if (value && transform?.parse) {
+        if (transform?.parse && value) {
           //@ts-ignore
-          this[propsSymbol][prop] = transform.parse(value, this)
+          this[propsSymbol][prop] = transform.parse(value, attribute, this)
         }
       }
     }
@@ -126,9 +125,9 @@ export default function r2wc<Props, Context>(
       const type = propTypes[prop]
       const transform = transforms[type]
 
-      if (prop in propTypes && transform?.parse) {
+      if (prop in propTypes && transform?.parse && value) {
         //@ts-ignore
-        this[propsSymbol][prop] = transform.parse(value, this)
+        this[propsSymbol][prop] = transform.parse(value, attribute, this)
 
         this[renderSymbol]()
       }
@@ -165,7 +164,7 @@ export default function r2wc<Props, Context>(
         const transform = transforms[type]
         if (transform?.stringify) {
           //@ts-ignore
-          const attributeValue = transform.stringify(value)
+          const attributeValue = transform.stringify(value, attribute, this)
           const oldAttributeValue = this.getAttribute(attribute)
 
           if (oldAttributeValue !== attributeValue) {
@@ -178,7 +177,3 @@ export default function r2wc<Props, Context>(
 
   return ReactWebComponent
 }
-
-function toDashedStyle(camelCase = "") {
-  return camelCase.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase()
-}

packages/core/src/transforms/boolean.ts

@@ -1,8 +1,8 @@
 import type { Transform } from "./index"
 
-const string: Transform<boolean> = {
+const boolean: Transform<boolean> = {
   stringify: (value) => (value ? "true" : "false"),
   parse: (value) => /^[ty1-9]/i.test(value),
 }
 
-export default string
+export default boolean

packages/core/src/transforms/function.ts

@@ -1,8 +1,8 @@
 import type { Transform } from "./index"
 
-const string: Transform<(...args: unknown[]) => unknown> = {
+const function_: Transform<(...args: unknown[]) => unknown> = {
   stringify: (value) => value.name,
-  parse: (value, element) => {
+  parse: (value, attribute, element) => {
     const fn = (() => {
       if (typeof window !== "undefined" && value in window) {
         // @ts-expect-error
@@ -19,4 +19,4 @@ const string: Transform<(...args: unknown[]) => unknown> = {
   },
 }
 
-export default string
+export default function_

packages/core/src/transforms/index.ts

@@ -5,8 +5,8 @@ import function_ from "./function"
 import json from "./json"
 
 export interface Transform<Type> {
-  stringify?: (value: Type) => string
-  parse: (value: string, element: HTMLElement) => Type
+  stringify?: (value: Type, attribute: string, element: HTMLElement) => string
+  parse: (value: string, attribute: string, element: HTMLElement) => Type
 }
 
 const transforms = {

packages/core/src/transforms/json.ts

@@ -1,8 +1,8 @@
 import type { Transform } from "./index"
 
-const string: Transform<string> = {
+const json: Transform<string> = {
   stringify: (value) => JSON.stringify(value),
   parse: (value) => JSON.parse(value),
 }
 
-export default string
+export default json

packages/core/src/transforms/number.ts

@@ -1,8 +1,8 @@
 import type { Transform } from "./index"
 
-const string: Transform<number> = {
+const number: Transform<number> = {
   stringify: (value) => `${value}`,
   parse: (value) => parseFloat(value),
 }
 
-export default string
+export default number