solid-js 1.2.0-beta.0 → 1.2.0

package/h/README.md

@@ -0,0 +1,99 @@
+# Solid HyperScript
+
+This sub module provides a HyperScript method for Solid. This is useful to use Solid in non-compiled environments or in some environments where you can only use a standard JSX transform. This method can be used as the JSX factory function.
+
+HyperScript function takes a few forms. The 2nd props argument is optional. Children may be passed as either an array to the 2nd/3rd argument or as every argument past the 2nd.
+
+```js
+// create an element with a title attribute
+h("button", { title: "My button" }, "Click Me")
+
+// create a component with a title prop
+h(Button, { title: "My button" }, "Click Me")
+
+// create an element with many children
+h("div", { title: "My button" }, h("span", "1"), h("span", "2"), h("span", "3"))
+```
+
+This is the least efficient way to use Solid as it requires a slightly larger runtime that isn't treeshakebable, and cannot leverage anything in the way of analysis, so it requires manual wrapping of expressions and has a few other caveats (see below).
+
+## Example
+
+```js
+import { render } from "solid-js/web";
+import h from "solid-js/h";
+import { createSignal } from "solid-js";
+
+function Button(props) {
+  return h("button.btn-primary", props)
+}
+
+function Counter() {
+  const [count, setCount] = createSignal(0);
+  const increment = (e) => setCount(c => c + 1);
+
+  return h(Button, { type: "button", onClick: increment }, count);
+}
+
+render(Counter, document.getElementById("app"));
+```
+
+## Differences from JSX
+
+There are a few differences from Solid's JSX that are important to note. And also apply when attempting use any transformation that would compile to HyperScript.
+
+1. Reactive expression must be manually wrapped in functions to be reactive.
+
+```js
+// jsx
+<div id={props.id}>{firstName() + lastName()}</div>
+
+// hyperscript
+h("div", { id: () => props.id }, () => firstName() + lastName())
+```
+
+2. Merging spreads requires using the merge props helper to keep reactivity
+
+```js
+// jsx
+<div class={selectedClass()} {...props} />
+
+// hyperscript
+import { mergeProps } from "solid-js"
+
+h("div", mergeProps({ class: selectedClass }, props))
+```
+
+3. Events on components require explicit event in the arguments
+
+Solid's HyperScript automatically wraps functions passed to props of components with no arguments in getters so you need to provide one to prevent this. The same applies to render props like in the `<For>` component.
+
+```js
+// good
+h(Button, { onClick: (e) => console.log("Hi")});
+
+// bad
+h(Button, { onClick: () => console.log("Hi")})
+```
+
+4. All refs are callback form
+
+We can't do the compiled assigment trick so only the callback form is supported.
+
+```js
+let myEl;
+
+h(div, { ref: (el) => myEl = el });
+```
+
+5. There is a shorthand for static id and classes
+
+```js
+h("div#some-id.my-class")
+```
+
+6. Fragments are just arrays
+
+```js
+[h("span", "1"), h("span", "2")]
+```

package/html/README.md

@@ -0,0 +1,84 @@
+# Solid Tagged Template Literals
+
+This sub module provides a Tagged Template Literal `html` method for Solid. This is useful to use Solid in non-compiled environments. This method can be used as replacement for JSX.
+
+`html` uses `${}` to escape into JavaScript expressions. Components are closed with `<//>`
+
+```js
+// create an element with a title attribute
+html`<button title="My button">Click Me</button>`
+
+// create a component with a title prop
+html`<${Button} title="My button">Click me<//>`
+
+// create an element with dynamic attribute and spread
+html`<div title=${() => selectedClass()} ...${props} />`
+```
+
+Using `html` is slightly less efficient than JSX(but more than HyperScript), requires a larger runtime that isn't treeshakebable, and cannot leverage expression analysis, so it requires manual wrapping of expressions and has a few other caveats (see below).
+
+## Example
+
+```js
+import { render } from "solid-js/web";
+import html from "solid-js/html";
+import { createSignal } from "solid-js";
+
+function Button(props) {
+  return html`<button class="btn-primary" ...${props} />`;
+}
+
+function Counter() {
+  const [count, setCount] = createSignal(0);
+  const increment = (e) => setCount((c) => c + 1);
+
+  return html`<${Button} type="button" onClick=${increment}>${count}<//>`;
+}
+
+render(Counter, document.getElementById("app"));
+```
+
+## Differences from JSX
+
+There are a few differences from Solid's JSX that are important to note.
+
+1. Reactive expression must be manually wrapped in functions to be reactive.
+
+```js
+// jsx
+<div id={props.id}>{firstName() + lastName()}</div>
+
+// hyperscript
+html`<div id=${() => props.id}>${() => firstName() + lastName()}</div>`
+```
+
+2. Events on components require explicit event in the arguments
+
+Solid's Tagged Template Literals automatically wraps functions passed to props of components with no arguments in getters so you need to provide one to prevent this. The same applies to render props like in the `<For>` component.
+
+```js
+// good
+html`<${Button} onClick=${(e) => console.log("Hi")} />`;
+
+// bad
+html`<${Button} onClick=${() => console.log("Hi")} />`;
+```
+
+4. All refs are callback form
+
+We can't do the compiled assigment trick so only the callback form is supported.
+
+```js
+let myEl;
+html`<div ref=${(el) => myEl = el} />`;
+```
+
+5. There can be multiple top level elements
+
+No need for fragments just:
+```js
+html`
+  <div>1</div>
+  <div>2</div>
+`
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "solid-js",
   "description": "A declarative JavaScript library for building user interfaces.",
-  "version": "1.2.0-beta.0",
+  "version": "1.2.0",
   "author": "Ryan Carniato",
   "license": "MIT",
   "homepage": "https://github.com/solidjs/solid#readme",
@@ -132,5 +132,5 @@
     "compiler",
     "performance"
   ],
-  "gitHead": "ec5bfa3adc09c0efd9210be6ff5096ec18c06d02"
+  "gitHead": "e6bbfa693db53cffd3372ee8bf1c61e3f1d47064"
 }

package/store/README.md

@@ -0,0 +1,23 @@
+# Solid Store
+
+This submodules contains the means for handling deeps nested reactivity. It provides 2 main primitives `createStore` and `createMutable` which leverage proxies to create dynamic nested reactive structures.
+
+This also contains helper methods `produce` and `reconcile` which augment the behavior of the store setter method to allow for localized mutationa and data diffing.
+
+For full documentation, check out the [website](https://www.solidjs.com/docs/latest/api).
+
+## Example
+
+```js
+import { createStore } from "solid-js/store";
+
+const [store, setStore] = createStore({
+  user: {
+    firstName: "John",
+    lastName: "Smith"
+  }
+});
+
+// update store.user.firstName
+setStore("user", "firstName", "Will");
+```

package/types/jsx.d.ts

@@ -11,7 +11,7 @@ export namespace JSX {
     | Node
     | ArrayElement
     | FunctionElement
-    | string
+    | (string & {})
     | number
     | boolean
     | null

package/universal/README.md

@@ -0,0 +1,102 @@
+# Solid Universal
+
+This contains the means to create the runtime for a custom renderer for Solid. This can enable using Solid to render to different platforms like native mobile and desktop, canvas or WebGL, or even the terminal. It relies on custom compilation from `babel-preset-solid` and exporting the result of `createRenderer` at a referenceable location.
+
+## Example
+
+To use a custom renderer available in the (fictional) `solid-custom-dom` package you'd configure your babelrc as:
+```json
+{
+  "presets": [
+    [
+      "babel-preset-solid",
+      {
+        "moduleName": "solid-custom-dom",
+        "generate": "universal"
+      }
+    ]
+  ]
+}
+```
+
+To create a custom renderer you must implement certain methods and export (as named exports) the results. You may also want to forward `solid-js` control flow to allow them to be auto imported as well.
+
+```js
+// example custom dom renderer
+import { createRenderer } from "solid-js/universal";
+
+const PROPERTIES = new Set(["className", "textContent"]);
+
+export const {
+  render,
+  effect,
+  memo,
+  createComponent,
+  createElement,
+  createTextNode,
+  insertNode,
+  insert,
+  spread,
+  setProp,
+  mergeProps
+} = createRenderer({
+  createElement(string) {
+    return document.createElement(string);
+  },
+  createTextNode(value) {
+    return document.createTextNode(value);
+  },
+  replaceText(textNode, value) {
+    textNode.data = value;
+  },
+  setProperty(node, name, value) {
+    if (name === "style") Object.assign(node.style, value);
+    else if (name.startsWith("on")) node[name.toLowerCase()] = value;
+    else if (PROPERTIES.has(name)) node[name] = value;
+    else node.setAttribute(name, value);
+  },
+  insertNode(parent, node, anchor) {
+    parent.insertBefore(node, anchor);
+  },
+  isTextNode(node) {
+    return node.type === 3;
+  },
+  removeNode(parent, node) {
+    parent.removeChild(node);
+  },
+  getParentNode(node) {
+    return node.parentNode;
+  },
+  getFirstChild(node) {
+    return node.firstChild;
+  },
+  getNextSibling(node) {
+    return node.nextSibling;
+  }
+});
+
+// Forward Solid control flow
+export {
+  For,
+  Show,
+  Suspense,
+  SuspenseList,
+  Switch,
+  Match,
+  Index,
+  ErrorBoundary
+} from "solid-js";
+```
+
+Then to consume:
+```js
+import { render } from "solid-custom-dom";
+
+function App() {
+  // the skies the limits
+}
+
+render(() => <App />, mountNode)
+```
+
+> Note: For TypeScript support of non-standard JSX you will need to provide your own types at a jsx-runtime entry on your package so that it can be set as the `jsxImportSource`. If mixing and matching different JSX implementations you will need use the per file pragmas.

package/web/README.md

@@ -0,0 +1,7 @@
+# Solid Web
+
+This submodule contains the web specific APIs for Solid that are mostly internal methods imported during compilation. It has all the code to render for the web on the server and the browser.
+
+In addition this modules provides the primary entry point methods `render`, `hydrate`, `renderToString`, `renderToStringAsync`, `pipeToNodeWritable`, and `pipeToWritable`. As well as a few web specific control flow components `<Portal>` and `<Dynamic>`.
+
+Refer to the [website](https://www.solidjs.com/docs/latest/api) for documentation.