https://github.com/ryansolid/solid-element
Moved toSolid Components
This library extends Solid by adding Custom Web Components and extensions to manage modular behaviors and composition. It uses 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 interopt 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).
Component
The simplest way to create a Component is to use the Component method. The first argument is the Custom element tag, the 2nd is optional is the props, and the 3rd is the Solid template function. Solid template is provided State wrapped props as the first argument, and the underlying element as the 2nd.
import Component from 'solid-components';
Props get assigned as element properties and hyphenated attributes. This exposes the component that can be used in HTML/JSX as:
This is all you need to get stated with Solid Components.
Examples
Web Component Todos Simple Todos Comparison
Context
Solid Components also expose Component Register Context API for dependency detection which provides createContext, createProvider and useContext. createContext lets you define the initialization of any sort of state container. Both createProvider and useContext take context as the first argument. The second argument for provider is passed as argument to the context initializer, or if no initializer is the value of the context.
Example below using Solid's own state mechanism although context can house just about anything.
// counter.jsimport createContext from 'solid-components';import createState from 'solid-js'; ; return state { ; } { ; } ;}); // app.jsimport Component createProvider from 'solid-components';import CounterContext from './counter'; const AppComponent = // start counter at 2 ; // ... ; // nested.jsimport Component useContext from 'solid-components';import CounterContext from './counter'; const NestedComponent = const counter increment decrement = ; return <div> <div> countercount </div> <button =>+</button> <button =>-</button> </div>; ;
Hot Module Replacement (new)
Solid Components 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.
; ;
This is a new feature that is actively seeking feedback. Read more: Component Register
There is also a webpack loader that handles adding this automatically. Check out Component Register Loader
withSolid
Under the hood the Component 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.
import register from 'component-register'; /*register(tag, defaultProps)*/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.
import register compose from 'component-register';import withSolid from 'solid-components'; /*withSolid*/props options // ....