@solidjs/element 2.0.0-experimental.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016-2023 Ryan Carniato
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+# Solid Element
+[![Build Status](https://github.com/solidjs/solid/workflows/Solid%20CI/badge.svg)](https://github.com/solidjs/solid/actions/workflows/main-ci.yml)
+[![NPM Version](https://img.shields.io/npm/v/solid-element.svg?style=flat)](https://www.npmjs.com/package/solid-element)
+![](https://img.shields.io/librariesio/release/npm/solid-element)
+![](https://img.shields.io/npm/dm/solid-element.svg?style=flat)
+
+This library extends [Solid](https://github.com/solidjs/solid) by adding Custom Web Components and extensions to manage modular behaviors and composition. It uses [Component Register](https://github.com/ryansolid/component-register) to create Web Components and its composed mixin pattern to construct modular re-usable behaviors. This allows your code to available as simple HTML elements for library interop and to leverage Shadow DOM style isolation. Solid already supports binding to Web Components so this fills the gap allowing full modular applications to be built out of nested Web Components. Component Register makes use of the V1 Standards and on top of being compatible with the common webcomponent.js polyfills, has a solution for Polyfilling Shadow DOM CSS using the ShadyCSS Parser from Polymer in a generic framework agnostic way (unlike the ShadyCSS package).
+
+## Example
+
+[See here](https://webcomponents.dev/edit/yGRb00wV4AMncPupRmA9) for an example of a webcomponent created by `solid-element`.
+
+## Installation
+
+```sh
+npm i solid-element solid-js babel-preset-solid
+```
+
+## Custom Elements
+
+The simplest way to create a Web Component is to use the `customElement` method.
+
+The arguments of `customElement` are:
+1) custom element tag (e.g. `'my-component'`)
+2) (optional) Default prop values (e.g. `{someProp: 'one', otherProp: 'two'}`). Props without default values will be ignored by the customElement.
+3) the Solid template function. The arguments of this function are state wrapped props as the first argument, and the underlying element as the 2nd (e.g. `(props, { element }) => {  solid code here
+ }`)
+
+```jsx
+import { customElement } from 'solid-element';
+
+customElement('my-component', {someProp: 'one', otherProp: 'two'}, (props, { element }) => {
+  // ... Solid code
+})
+```
+
+Props get assigned as element properties and hyphenated attributes. This exposes the component that can be used in HTML/JSX as:
+```html
+<my-component some-prop="some value" other-prop="some value"></my-component>
+```
+
+This is all you need to get started with Solid Element.
+
+A shadow DOM is used by default for style isolation. If you want to disable the shadow DOM, you can do it with `noShadowDOM()` like this:
+
+```jsx
+import { customElement, noShadowDOM } from 'solid-element';
+
+customElement('my-component', {someProp: 'one', otherProp: 'two'}, (props, { element }) => {
+  noShadowDOM();
+  // ... Solid code
+})
+```
+
+## Examples
+
+[Web Component Todos](https://wc-todo.firebaseapp.com/) Simple Todos Comparison
+
+## Hot Module Replacement (new)
+
+Solid Element exposes Component Register's Hot Module Replacement solution for Webpack and Parcel. It does not preserve state, swapping Components that are changed and their descendants. This approach is simple but predictable. It works by indicating the component to be Hot Replaced with the `hot` method in your file.
+
+```js
+import { customElement, hot } from 'solid-element';
+
+hot(module, 'my-component');
+```
+This is a new feature that is actively seeking feedback. Read more: [Component Register](https://github.com/ryansolid/component-register#hot-module-replacement-new)
+
+There is also a webpack loader that handles adding this automatically. Check out [Component Register Loader](https://github.com/ryansolid/component-register-loader)
+
+## withSolid
+
+Under the hood the customElement method is using Component Register's mixins to create our Custom Element. So this library also provides the way to do so directly if you wish to mixin your own functionality. It all starts by using the register HOC which upgrades your class or method to a WebComponent. It is always the start of the chain.
+
+```jsx
+import { register } from 'component-register';
+
+/*
+register(tag, defaultProps)
+*/
+register('my-component', {someProp: 'one', otherProp: 'two'})((props, options) =>
+  // ....
+)
+```
+
+Component Register exposes a convenient compose method (a reduce right) that makes it easier compose multiple mixins. From there we can use withSolid mixin to basically produce the Component method above. However, now you are able to add more HOC mixins in the middle to add additional behavior in your components.
+
+```jsx
+import { register, compose } from 'component-register';
+import { withSolid } from 'solid-element';
+
+/*
+withSolid
+*/
+compose(
+  register('my-component'),
+  withSolid
+)((props, options) =>
+  // ....
+)
+```

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import { ComponentType as mComponentType, PropsDefinitionInput } from "component-register";
+export { hot, getCurrentElement, noShadowDOM } from "component-register";
+export type ComponentType<T> = mComponentType<T>;
+declare function withSolid<T extends object>(ComponentType: ComponentType<T>): ComponentType<T>;
+declare function customElement<T extends object>(
+  tag: string,
+  ComponentType: ComponentType<T>
+): CustomElementConstructor;
+declare function customElement<T extends object>(
+  tag: string,
+  props: PropsDefinitionInput<T>,
+  ComponentType: ComponentType<T>
+): CustomElementConstructor;
+export { withSolid, customElement };

package/dist/index.js

@@ -0,0 +1,52 @@
+import { register } from "component-register";
+export { hot, getCurrentElement, noShadowDOM } from "component-register";
+import { createRoot, createSignal, runWithOwner } from "solid-js";
+import { insert } from "@solidjs/web";
+function createProps(raw) {
+  const keys = Object.keys(raw);
+  const props = {};
+  for (let i = 0; i < keys.length; i++) {
+    const [get, set] = createSignal(() => raw[keys[i]]);
+    Object.defineProperty(props, keys[i], {
+      get,
+      set(v) {
+        set(() => v);
+      }
+    });
+  }
+  return props;
+}
+function lookupContext(el) {
+  if (el.assignedSlot && el.assignedSlot._$owner) return el.assignedSlot._$owner;
+  let next = el.parentNode;
+  while (next && !next._$owner && !(next.assignedSlot && next.assignedSlot._$owner))
+    next = next.parentNode;
+  return next && next.assignedSlot ? next.assignedSlot._$owner : el._$owner;
+}
+function withSolid(ComponentType) {
+  return (rawProps, options) => {
+    const { element } = options;
+    const owner = lookupContext(element);
+    function createComponent() {
+      return createRoot(dispose => {
+        const props = createProps(rawProps);
+        element.addPropertyChangedCallback((key, val) => (props[key] = val));
+        element.addReleaseCallback(() => {
+          element.renderRoot.textContent = "";
+          dispose();
+        });
+        const comp = ComponentType(props, options);
+        return insert(element.renderRoot, comp);
+      });
+    }
+    return owner ? runWithOwner(owner, createComponent) : createComponent();
+  };
+}
+function customElement(tag, props, ComponentType) {
+  if (arguments.length === 2) {
+    ComponentType = props;
+    props = {};
+  }
+  return register(tag, props)(withSolid(ComponentType));
+}
+export { withSolid, customElement };

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@solidjs/element",
+  "description": "Webcomponents wrapper for Solid",
+  "author": "Ryan Carniato",
+  "license": "MIT",
+  "version": "2.0.0-experimental.0",
+  "homepage": "https://github.com/solidjs/solid/blob/main/packages/solid-element#readme",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "component-register": "^0.8.7"
+  },
+  "peerDependencies": {
+    "solid-js": "^2.0.0-experimental.0",
+    "@solidjs/web": "^2.0.0-experimental.0"
+  },
+  "devDependencies": {
+    "solid-js": "2.0.0-experimental.0",
+    "@solidjs/web": "2.0.0-experimental.0"
+  },
+  "scripts": {
+    "clean": "rimraf dist/",
+    "build": "pnpm run clean && tsc"
+  }
+}