Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^7.2.3
->^8.0.0
^0.26.5
->^1.0.0
Release Notes
steelbrain/package-deps
v8.0.0
Compare Source
Although none of the APIs have changed, this change may be potentially unstable, so marking it as semver-major
so consumers have to opt-in to this.
solidjs/solid
v1.6.14
Compare Source
v1.6.13
Compare Source
v1.6.12
Compare Source
v1.6.11
Compare Source
v1.6.10
Compare Source
v1.6.9
Compare Source
v1.6.8
Compare Source
v1.6.7
Compare Source
v1.6.6
Compare Source
v1.6.5
Compare Source
v1.6.4
Compare Source
v1.6.3
Compare Source
v1.6.2
Compare Source
v1.6.1
Compare Source
v1.6.0
Solid v1.6 doesn't bring a ton of new features but brings some big improvements in existing ones.
Highlights
Official Partial Hydration Support
Solid has worked for quite some time in partial hydrated ("Islands") frameworks like Astro, Iles, Solitude, etc.. but now we have added core features to support this effort better. These features are mostly designed for metaframework authors rather than the end user they are exposed through a couple APIs.
<Hydration />
joins<NoHydration />
as being a way to resume hydration and hydration ids during server rendering. Now we can stop and start hydratable sections. This is important because it opens up a new optimization.createResource
calls under non-hydrating sections do not serialize. That means that resources that are server only stay on the server. The intention is that hydrating Islands can then serialize theirprops
coming in. Essentially only shipping the JSON for data actually used on the client.The power here is static markup can interview dynamic components.
Keep in mind Server rendered content like this can only be rendered on the server so to maintain a client navigation with this paradigm requires a special router that handles HTML partials.
Similarly we want the trees to talk to each other so
hydrate
calls now have been expanded to accept a parentOwner
this will allow Islands to communicate through Contex without shipping the whole tree to browser.These improvements make it easier to create Partial Hydration solutions on top of Solid, and serve to improve the capabilities of the ones we already have.
Native Spread Improvements
Native spreads are something we started at very naively. Simply just iterating an object that has some reactive properties and updating the DOM element. However, this didn't take into consideration two problems.
First properties on objects can change, they can be added or removed, and more so the object itself can be swapped. Since Solid doesn't re-render it needs to keep a fixed reference to the merged properties. Secondly, these are merged. Properties override others. What this means is we need to consider the element holistically to know that the right things are applied.
For Components this was a never a problem since they are just function calls. Unfortunately for native elements this means all those compiler optimizations we do for specific bindings now need to get pulled into this. Which is why we avoided it in the past. But the behavior was too unpredictable.
In 1.6 we have smartened spread to merge properly using similar approach to how process Components. We've also found new ways to optimize the experience. (See below).
Other Improvements
Deproxification
Working on new Spread behavior we realized that while we can't tell from compilation which spreads can change. We can tell at runtime which are proxies. And in so if we only need to merge things which don't swap, and aren't proxies we can avoid making a Proxy.
What is great about this is it has a cascading effect. If component props aren't a proxy, then
splitProps
andmergeProps
don't need to create them, and so on. While this requires a little extra code it is a real win.We get a lot request for low end IoT devices because of Solid's incredible performance. In tests Solid outperforms many of the Virtual DOM solutions in this space. However most of them don't support proxies.
So now if you don't use a
Store
or swap out the props object:We don't need to introduce any proxy the user didn't create. This makes Solid a viable option for these low-end devices.
v1.5.6
Compare Source
v1.5.5
Compare Source
v1.5.4
Compare Source
v1.5.3
Compare Source
v1.5.2
Compare Source
v1.5.1
Compare Source
v1.5.0
Compare Source
Key Highlights
New Batching Behavior
Solid 1.4 patched a long time hole in Solid's behavior. Until that point Stores did not obey batching. However, it shone a light on something that should maybe have been obvious before. Batching behavior which stays in the past is basically broken for mutable data, No Solid only has
createMutable
andproduce
but with these sort of primitives the sole purpose is that you perform a sequence of actions, and batching not making this properly was basically broken. Adding an element to an array then removing another item shouldn't just skip the first operation.After a bunch of careful thought and auditting we decided that Solid's
batch
function should behave the same as how reactivity propagates in the system once a signal is set. As in we just add observers to a queue to run, but if we read from a derived value that is stale it will evaluate eagerly. In so signals will update immediately in a batch now and any derived value will be on read. The only purpose of it is to group writes that begin outside of the reactive system, like in event handlers.More Powerful Resources
Resources continue to get improvements. A common pattern in Islands frameworks like Astro is to fetch the data from the out side and pass it in. In this case you wouldn't want Solid to do the fetching on initial render or the serialization, but you still may want to pass it to a resource so it updates on any change. For that to work reactivity needs to run in the browser. The whole thing has been awkward to wire up but no longer.
ssrLoadFrom
field lets you specify where the value comes from during ssr. The default isserver
which fetches on the server and serializes it for client hydration. Butinitial
will use theinitialValue
instead and not do any fetching or addtional serialization.We've improved TypeScript by adding a new
state
field which covers a more detailed view of the Resource state beyondloading
anderror
. You can now check whether a Resource is"unresolved"
,"pending"
,"ready"
,"refreshing"
, or"error"
.A widely requested feature has been allowing them to be stores. While higher level APIs are still being determined we now have a way to plugin the internal storage by passing something with the signature of a signal to the new Experimental
storage
option.Consolidated SSR
This release marks the end of years long effort to merge async and streaming mechanism. Since pre 1.0 these were seperate. Solid's original SSR efforts used reactivity on the server with different compilation. It was easiest to migrate synchronous and streaming rendering and for a time async had a different compilation. We got them on the same compilation 2 years ago but runtimes were different. Piece by piece things have progressed until finally async is now just streaming if flushed at the end.
This means some things have improved across the board. Async triggered Error Boundaries previously were only ever client rendered (throwing an error across the network), but now if they happen any time before sending to the browser they are server rendered.
onCleanup
now runs on the server if a branch changes. Keep in mind this is for rendering effects (like setting a status code) and not true side effects as not all rendering cleans up.Finally we've had a chance to do a bunch of SSR rendering performance improvements. Including replacing our data serializer with an early copy of Dylan Piercey from Marko's upcoming serializer for Marko 6. Which boasts performance improvements of up to 6x
devalue
which we used previously.Keyed Control Flow
Solid's
<Show>
and<Match>
control flow originally re-rendered based on value change rather than truthy-ness changing. This allowed the children to be "keyed" to the value but lead to over rendering in common cases. Pre 1.0 it was decided to make these only re-render when statement changed fromtrue
tofalse
or vice versa, except for the callback form that was still keyed.This worked pretty well except it was not obvious that a callback was keyed. So in 1.5 we are making this behavior explicit. If you want keyed you should specify it via attribute:
However, to not be breaking if a callback is present we will assume it's keyed. We still recommend you start adding these attributes (and TS will fail without them).
In the future we will introduce a non-keyed callback form as well so users can benefit from type narrowing in that case as well.
Other Improvements
children.toArray
Children helper now has the ability to be coerced to an array:
Better SSR Spreads
Finally fixed spread merging with non-spread properties during SSR, including the ability to merge children.
Better Error Handling
We weren't handling falsey errors previously. Now when Solid receives an error that isn't an
Error
object or a string it will coerce it into anUnknown Error
.v1.4.8
Compare Source
v1.4.7
Compare Source
v1.4.6
Compare Source
v1.4.5
Compare Source
v1.4.4
Compare Source
v1.4.3
Compare Source
v1.4.2
Compare Source
v1.4.1
Compare Source
v1.4.0
Compare Source
New Features
Resource Deferred Streaming
Streaming brings a lot of performance benefits but it also comes with the tradeoff we need to respond with the headers before we can send any content. This means we must set the Response headers early if we want to benefit from streaming. While it's always possible to fetch first and delay rendering that slows down everything. Even our async server rendering doesn't block rendering but instead just waits to respond to the end.
But what if you want to stream but also want to wait on some key data loading so you still have an opportunity to handle the response on the server before sending it to the browser?
We now have the ability to tell Solid's stream renderer to wait for a resource before flushing the stream. That you can opt in by setting
deferStream
option.Top Level Arrays in Stores
Since Stores were first introduced it has always bugged me that the most common case, creating a list required nesting it under a property to track properly. Thanks to some exploration into proxy traps and iteration we now support top level arrays. In addition to its other modes, the Store setter will accept an array which allows for common operations.
Through this change we also stopped over execution when listening to specific properties. To support iteration Solid previously would notify the owning object of any array when an was index added/removed or object new property created or deleted on any object.
The one caveat is downstream optimized control flow that untrack index reads on arrays will now need to track the iterated object explicity. Solid exports a
$TRACK
symbol used to subscribe to the object and all its properties.Stale Resource Reads
Suspense and Transitions are amazingly powerful feature but occasionally you want to opt out of the consistency and show things out of date because it will show up faster and some of things you are waiting for are not as high priority. In so you want the Transition to end sooner, but not necessarily stop showing the stale data for part of the screen. It is still preferable to receding back to loading spinner state.
Solid's Resources now support being able to read the value without triggering Suspense. As long as it has loaded previously
latest
property won't cause fallback appear or Transitions to hold. This will always return thelatest
value regardless whether it is stale (ie.. a new value is being fetched) and will reactively update. This is super powerful in Transitions as you can use the Resources ownloading
state to know if it is stale. Since the Transition will hold while the critical data is loading, the loading state will not be applied to the in view screen until that Transition has ended. If the resource is still loading now you can show that it is stale.Example: https://codesandbox.io/s/solid-stale-resource-y3fy4l
Combining multiple Custom Renderers
The Babel plugin now allows configuring multiple custom renderers at the same time. The primary case it is so a developer can still lever Solid's optimized DOM compilation while using their custom renderer. To make this work specify the tags each renderer is reponsible for. It will try to resolve them in order.
Improvements/Fixes
Synchronous Top Level
createEffect
These were originally deferred to a microtask to resemble how effects are queued under a listener. However it is more correct to run immediate like everything else top level.
Better Types around Components
This one took the effort of many resident TypeScript experts, but we've now landed on some better types for components. The biggest change is
Component
no longer has an opinion on whether it should havechildren
or not. We've added supplementary typesParentComponent
andFlowComponent
to denote Components that may havechildren
or always havechildren
. And we've addedVoidComponent
for those which may never have children.Sources in
createResource
are now MemosA small change but it was unusual to have refetching trigger a reactive expression outside of a reactive context. Now on refetch it grabs the last source value rather than re-running it.
createMutable
batches array methods like push, pop, etc..Now these built-ins are batched and more performant. We've also add
modifyMutable
that applies modifiers batched to stores created withcreateMutable
.Stores and mutables now respect batch
Writing to a store or mutable within
batch
(including effects) no longer immediately updates the value, so reading within the same batch gives the old value. This guarantees consistency with memos and other computations, just like signals.Better Support for React JSX transform
We have added support to
solid-js/h
to support the new React JSX transform. You can use it directly in TypeScript by using:Keep in mind this has all the consequences of not using the custom transform. It means larger library code, slower performance, and worse ergonomics. Remember to wrap your reactive expressions in functions.
HyperScript now returns functions
This one is a potentially breaking change, but the current behavior was broken. It was possible(and common) for children to be created before the parents the way JSX worked. This was an oversight on my original design that needs to be fixed, as it breaks context, and disposal logic. So now when you get your results back from
h
you need to call it. Solid'srender
function will handle this automatically.Removals and Deprecations
className
,htmlFor
deprecatedWhile they still work for now, Solid will remove support for these React-isms in a future version. They leave us with multiple ways to set the same attribute. This is problematic for trying to merge them. Solid updates independently so it is too easy for these things to trample on each other. Also when optimizing for compilation since with things like Spreads you can't know if the property is present, Solid has to err on the side of caution. This means more code and less performance.
Experimental
refetchResources
removedThis primitive ended up being too general to be useful. There are enough cases we can't rely on the refetch everything by default mentality. For that reason we are dropping support of this experimental feature.
v1.3.17
Compare Source
v1.3.16
Compare Source
v1.3.15
Compare Source
v1.3.14
Compare Source
v1.3.13
Compare Source
v1.3.12
Compare Source
v1.3.11
Compare Source
v1.3.10
Compare Source
v1.3.9
Compare Source
v1.3.8
Compare Source
v1.3.7
Compare Source
v1.3.6
Compare Source
v1.3.5
Compare Source
v1.3.4
Compare Source
v1.3.3
Compare Source
v1.3.2
Compare Source
v1.3.1
Compare Source
v1.3.0
Compare Source
New Features
HTML Streaming
This release adds support for HTML streaming. Now we not only stream data after the initial shell but the HTML as it finishes. The big benefit is that now for cached results, or times when the network are slow we no longer have to show the placeholder while waiting for JavaScript bundle to load. As soon as the HTML is available it will be streamed and inserted.
With it comes new streaming API
renderToStream
. This is a universal API designed to handle both Node and Web writable streams. It returns an object that mirrors a Readable stream on both platforms that has bothpipe
(node) andpipeTo
(web). The benefit of thispipe
API is the user can choose when to insert the content in the output stream whether soon as possible, oronCompleteShell
, oronCompleteAll
. This decouples Solid's rendering a from the stream a bit but leaves things open to performance improvements in the future.Error Boundaries on the Server
We've added support for Error Boundaries on the Server for all rendering methods(
renderToString
,renderToStringAsync
,renderToStream
). Errors can be caught both from synchronous rendering and from errors that happen in Resource resolution. However, Our approach doesn't guarentee all errors are handled on the server as with streaming it is possible that the Error Boundary has already made it to the browser while a nested Suspense component hasn't settled. If an Error is hit it will propagate up to the top most Suspense Boundary that hasn't been flushed yet. If it is not handled by an Error Boundary before that it will abort rendering, and send the Error to the browser to propagate up to the nearest Error Boundary.This works now but there is more to explore here in improving Error handling in general with SSR. So look forward to feedback on the feature.
Isolated Server Render/Hydration Contexts
Sometimes you want to server render and hydrate multiple Solid apps on the same page. Maybe you are using the Islands architecture with something like Astro. We now have the ability to pass a unique
renderId
on all our server rendering methods and to thehydrate
function. This will isolate all hydration and resource resolution. This means we can use things like server side Suspense in these solutions.Also now you only need to include the Hydration Script once on the page. Each Island will be responsible for initializing it's own resources.
createReaction
This new primitive is mostly for more advanced use cases and is very helpful for interopt with purely pull based systems (like integrating with React's render cycle). It registers an untracked side effect and returns a tracking function. The tracking function is used to track code block, and the side effect is not fired until the first time any of the dependencies in the tracking code is updated.
track
must be called to track again.This primitive is niche for certain use cases but where it is useful it is indispensible (like the next feature which uses a similar API).
External Sources (experimental)
Ever wanted to use a third party reactive library directly in Solid, like MobX, Vue Reactivity, or Kairo. We are experimenting with adding native support so reactive atoms from these libraries can be used directly in Solid's primitives and JSX without a wrapper. This feature is still experimental since supporting Transitions and Concurrent Rendering will take some more effort. But we have added
enableExternalSource
enable this feature. Thanks @3Shain for designing this solution.refetchResources
(experimental)In efforts to allow for scaling from simple resources up to cached solutions we are adding some experimental features to
createResource
to work with library writers to develop the best patterns. Caching is always a tricky problem and with SSR and streaming being part of the equation the core framework needs at minimum to provide some hooks into orchestrating them.Sometimes it's valuable to trigger
refetch
across many resources. Now you can.You can also pass a parameter to
refetchResources
to provide additional information to therefetching
info of the fetcher. This could be used for conditional cache invalidation. Like only refetch resources related tousers
. This mechanism requires a bit of wiring but the idea is you'd wrapcreateResource
in maybe acreateQuery
and implement your own conventions around resource cache management. Still working out how this should work best, but the goal is to provide the mechanisms to support resource caches without being responsible for their implementation.To opt-out being part of the global refetch createResource now takes a
globalRefetch
option that can be set to false. In addition to a new option to disablerefetchResources
there is no anonHydrated
callback that takes the same arguments as the fetcher. When a resource is restored from the server the fetcher is not called. However, this callback will be. This is useful for populating caches.Improvements
Better TypeScript Support
Thanks to the tireless efforts of several contributors we now have significantly better types in Solid. This was a huge effort and involved pulling in maintainers of TypeScript to help us work through it. Thank you @trusktr for spearheading the effort.
Better SourceMaps
Work has been done to improve sourcemaps by updating
babel-plugin-dom-expressions
to better preserve identifiers from the JSX. Thanks to @LXSMNSYC for exploring and implementing this.Breaking Changes/Deprecations
startTransition
no longer takes callback as a second argumentInstead it returns a promise you can await. This works better for chaining sequences of actions.
Resource fetcher info object replaces
getPrev
To streamline API for refetch we are slightly updating the
createResource
:For those using existing 2nd argument:
Deprecating Legacy Streaming APIs
pipeToNodeWritable
andpipeToWritable
are deprecated. They will still work for now with basic usage but some of the more advanced options didn't map over to the new APIs directly and have been removed. Move to usingrenderToStream
.Bug Fixes
<html>
on hydration from document.createSelector
.preload
on lazy components to always be a promise.v1.2.6
Compare Source
v1.2.5
Compare Source
v1.2.4
Compare Source
v1.2.3
Compare Source
v1.2.2
Compare Source
v1.2.1
Compare Source
v1.2.0
Compare Source
New Features
Custom Renderers
This release adds support custom renderers through a new "universal" transform. Solid now provides a sub module
solid-js/universal
that exports acreateRenderer
method that allows you to create your own runtimes. This will enable things like native mobile and desktop, canvas and webgl, or even rendering to the terminal. This is still new so very much looking for feedback.Spreads Added to Solid's
html
It's been a long time coming but Solid's Tagged Template Literals now support element and component spreads using htm inspired syntax.
Fixes
Dynamic Spreads now work on Components
Previously spreads on components would only track property changes on bound objects and not when the whole object changed. This now works:
ClassList properly merges multiple classnames in the key
It is common in libraries like Tailwind to apply multiple classes at the same time. There was an issue where true and false resolutions were cancelling each other out. This would only set
text-sm
.Consistent handling of HTMLEntities
Things like
used to render differently depending if in elements or components(or fragments). This has been made consistent across all three.Various improvements to Types and Transitions
A lot of bugs from the last minor release were around Transitions that have been addressed. And as always Types have been gradually improving.
v1.1.7
Compare Source
v1.1.6
Compare Source
v1.1.5
Compare Source
v1.1.4
Compare Source
v1.1.3
Compare Source
v1.1.2
Compare Source
v1.1.1
Compare Source
v1.1.0
Compare Source
Expanding Solid's concurrency to include scheduling. Bug fixes around Types and around reactive execution order guarantees.
New Features
createUniqueId
A universal id generator that works across server/browser.
from
A simple helper to make it easier to interopt with external producers like RxJS observables or with Svelte Stores. This basically turns any subscribable (object with a
subscribe
method) into a Signal and manages subscription and disposal.It can also take a custom producer function where the function is passed a setter function returns a unsubscribe function:
enableScheduling
(experimental)By default Solid's concurrent rendering/Transitions doesn't schedule work differently and just runs synchronously. Its purpose is to smooth out IO situations like Navigation. However now you can opt into interruptible scheduling similar to React's behavior by calling this once at your programs entry. I've yet to see a realworld scenario where this makes a big difference but now we can do cool demos too and start testing it.
startTransition
Works like its counterpart in
useTransition
, this useful when you don't need pending state.v1.0.7
Compare Source
v1.0.6
Compare Source
v1.0.5
Compare Source
v1.0.4
Compare Source
v1.0.3
Compare Source
v1.0.2
Compare Source
v1.0.1
Compare Source
v1.0.0
Compare Source
Breaking Changes
setSignal now supports function form
While that in itself is a great new feature as you can do:
This promotes immutable patterns, let's you access the previous value without it being tracked, and makes Signals consistent with State.
It means that when functions are stored in signals you need to use this form to remove ambiguity
createState
moved and renamedcreateState
has been renamed tocreateStore
and moved tosolid-js/store
. Also moved tosolid-js/store
:createMutable
,produce
,reconcile
SSR Entry points
renderToString
andrenderToStringAsync
now only return their stringified markup. To insert scripts you need to callgenerateHydrationScript
or use the new<HydrationScript>
component.renderToNodeStream
andrenderToWebStream
have been replaced withpipeToNodeWritable
andpipeToWritable
, respectively.Options Objects
Most non-essential arguments on reactive primitives are now living on an options object. This was done to homogenize the API and make it easier to make future additions while remaining backwards compatible.
on
No longer uses rest parameters for multiple dependencies. Instead pass an array. This facilitates new option to defer execution until dependencies change.
Actions renamed to Directives
To remove future confusion with other uses of actions the
JSX.Actions
interace is now theJSX.Directives
interface.Configuration
📅 Schedule: Branch creation - "every weekend" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR has been generated by Mend Renovate. View repository job log here.