This is the smallest and most primitive reactive atom used to track a single value. By default signals always notify on setting a value. You can have it only notify on changes if you pass true to the second parameter. Or a custom comparator can be passed in to indicate whether the values should be considered equal and listeners not notified.
Creates a readonly derived signal that recalculates it's value whenever the executed codes dependencies update. By default memos always notify on updating a value. You can have it only notify on changes if you pass true to the third parameter. Or a custom comparator can be passed in to indicate whether the values should be considered equal and listeners not notified.
Creates a new computation that automatically tracks dependencies and runs after each render where a dependency has changed. Ideal for using refs and managing other side effects. 2nd argument is the initial value.
Registers a method that runs after initial render and elements have been mounted. Ideal for using refs and managing other one time side effects.
Registers a cleanup method that executes on disposal or recalculation of the current context. Can be used in components or computations.
Creates a new State proxy object and setState pair. State only triggers update on values changing. Tracking is done by intercepting property access and automatically tracks deep nesting via proxy.
Creates a new context object that can be used with useContext and the Provider control flow. Default Context is used when no Provider is found above in the hierarchy.
Hook to grab context to allow for deep passing of props with hierarchal resolution of dependencies without having to pass them through each Component function.
The following are not required to build simple applications but allow a lot more power and control.
Creates a new non-tracked context that doesn't auto-dispose. All Solid code should be wrapped in one of these top level as they ensure that all memory/computations are freed up.
Ignores tracking any of the dependencies in the executing code block and returns the value.
Ensures that all notification of updates within the block happen at the same time to prevent unnecessary recalculation. Solid State's setState method and computations(useEffect, useMemo) automatically wrap their code in a batch.
on is designed to be passed into a computation to make its deps explicit. If more than one dep is passed, value and prevValue are arrays.
Registers an error handler method that executes when child context errors. Only nearest context error handlers execute. Rethrow to trigger up the line.
Creates a new mutable State proxy object. State only triggers update on values changing. Tracking is done by intercepting property access and automatically tracks deep nesting via proxy.
Creates memo that only notifies downstream changes when the browser is idle. timeoutMs is the maximum time to wait before forcing the update.
Creates a new computation that automatically tracks dependencies and runs immediately. Use this to write to other reactive primitives or to reactively trigger async data loading before render. 2nd argument is the initial value.
Creates a new computation that automatically tracks dependencies and runs during the render phase as DOM elements are created and updated but not necessarily connected. All internal DOM updates happen at this time.
Creates a conditional signal that only notifies subscribers when entering or exiting their key matching the value. Useful for delegated selection state.
Creates a new resource signal that can hold an async resource. Resources when read while loading trigger Suspense. The fetcher is a function that accepts return value of the source if provided and returns a Promise whose resolved value is set in the resource. The fetcher is not reactive so use the optional first argument if you want it to run more than once. If provided false, null, or undefined signals not to fetch.
Used to lazy load components to allow for things like code splitting and Suspense.
Used to batch async updates deferring commit until all async processes are complete.
A reactive object merge method. Useful for setting default props for components in case caller doesn't provide them. Or cloning the props object including reactive properties.
Splits a reactive object by keys while maintaining reactivity.