From 198e110c6c67ea13e45f64363164f27b9b3ecb0c Mon Sep 17 00:00:00 2001 From: Damian Tarnawski Date: Thu, 12 Sep 2024 18:48:02 +0200 Subject: [PATCH] Change hash href attrs to be lowercase (fixes #544) --- .gitignore | 1 + packages/active-element/README.md | 8 ++++---- packages/autofocus/README.md | 2 +- packages/bounds/README.md | 2 +- packages/broadcast-channel/README.md | 6 +++--- packages/connectivity/README.md | 6 +++--- packages/cursor/README.md | 4 ++-- packages/date/README.md | 14 ++++++------- packages/deep/README.md | 8 ++++---- packages/event-bus/README.md | 10 ++++----- packages/event-listener/README.md | 26 ++++++++++++------------ packages/flux-store/README.md | 4 ++-- packages/immutable/README.md | 2 +- packages/intersection-observer/README.md | 6 +++--- packages/jsx-tokenizer/README.md | 12 +++++------ packages/keyboard/README.md | 12 +++++------ packages/keyed/README.md | 10 ++++----- packages/lifecycle/README.md | 6 +++--- packages/list/README.md | 4 ++-- packages/masonry/README.md | 2 +- packages/media/README.md | 8 ++++---- packages/memo/README.md | 14 ++++++------- packages/mouse/README.md | 14 ++++++------- packages/mutable/README.md | 4 ++-- packages/page-visibility/README.md | 4 ++-- packages/pagination/README.md | 4 ++-- packages/pointer/README.md | 10 ++++----- packages/promise/README.md | 4 ++-- packages/props/README.md | 4 ++-- packages/raf/README.md | 4 ++-- packages/range/README.md | 4 ++-- packages/refs/README.md | 8 ++++---- packages/resize-observer/README.md | 8 ++++---- packages/resource/README.md | 2 +- packages/rootless/README.md | 12 +++++------ packages/scheduled/README.md | 2 +- packages/scroll/README.md | 4 ++-- packages/set/README.md | 4 ++-- packages/share/README.md | 6 +++--- packages/static-store/README.md | 8 ++++---- packages/styles/README.md | 4 ++-- packages/timer/README.md | 10 ++++----- packages/transition-group/README.md | 4 ++-- packages/trigger/README.md | 4 ++-- site/scripts/generate.ts | 5 +++-- 45 files changed, 151 insertions(+), 149 deletions(-) diff --git a/.gitignore b/.gitignore index 9c01f3b8c..879b66d6f 100644 --- a/.gitignore +++ b/.gitignore @@ -154,6 +154,7 @@ dist/ # vscode settings .vscode/settings.json +.vscode/launch.json # Temporary folders tmp/ diff --git a/packages/active-element/README.md b/packages/active-element/README.md index dc90a2f8f..68e0fdb5f 100644 --- a/packages/active-element/README.md +++ b/packages/active-element/README.md @@ -11,13 +11,13 @@ ##### Non-reactive primitives: -- [`makeActiveElementListener`](#makeActiveElementListener) - Listen for changes to the `document.activeElement`. -- [`makeFocusListener`](#makeFocusListener) - Attaches "blur" and "focus" event listeners to the element. +- [`makeActiveElementListener`](#makeactiveelementlistener) - Listen for changes to the `document.activeElement`. +- [`makeFocusListener`](#makefocuslistener) - Attaches "blur" and "focus" event listeners to the element. ##### Reactive primitives: -- [`createActiveElement`](#createActiveElement) - Provides reactive signal of `document.activeElement`. -- [`createFocusSignal`](#createFocusSignal) - Provides a signal representing element's focus state. +- [`createActiveElement`](#createactiveelement) - Provides reactive signal of `document.activeElement`. +- [`createFocusSignal`](#createfocussignal) - Provides a signal representing element's focus state. ##### Directives: diff --git a/packages/autofocus/README.md b/packages/autofocus/README.md index e7375ac65..55e2bc9ec 100644 --- a/packages/autofocus/README.md +++ b/packages/autofocus/README.md @@ -14,7 +14,7 @@ Primitives for autofocusing HTML elements. The native autofocus attribute only works on page load, which makes it incompatible with SolidJS. These primitives run on render, allowing autofocus on initial render as well as dynamically added components. - [`autofocus`](#autofocus) - Directive to autofocus an element on render. -- [`createAutofocus`](#createAutofocus) - Reactive primitive to autofocus an element on render. +- [`createAutofocus`](#createautofocus) - Reactive primitive to autofocus an element on render. ## Installation diff --git a/packages/bounds/README.md b/packages/bounds/README.md index 1e878a75d..5254a5566 100644 --- a/packages/bounds/README.md +++ b/packages/bounds/README.md @@ -11,7 +11,7 @@ Primitives for tracking HTML element size and position on screen as it changes. -- [`createElementBounds`](#createElementBounds) - Creates a reactive store-like object of current element bounds — position on the screen, and size dimensions. +- [`createElementBounds`](#createelementbounds) - Creates a reactive store-like object of current element bounds — position on the screen, and size dimensions. ## Installation diff --git a/packages/broadcast-channel/README.md b/packages/broadcast-channel/README.md index 6f1c0061a..a0a0a3cf6 100644 --- a/packages/broadcast-channel/README.md +++ b/packages/broadcast-channel/README.md @@ -23,8 +23,8 @@ pnpm add @solid-primitives/broadcast-channel ## Available primitives -- [`makeBroadcastChannel`](#makeBroadcastChannel) -- [`createBroadcastChannel`](#createBroadcastChannel) +- [`makeBroadcastChannel`](#makebroadcastchannel) +- [`createBroadcastChannel`](#createbroadcastchannel) ### `makeBroadcastChannel` @@ -97,7 +97,7 @@ const App = () => { ### `createBroadcastChannel` -Provedes the same functionality as [`makeBroadcastChannel`](#makeBroadcastChannel) but instead of returning `onMessage` function, it returns a `message` signal accessor that updates when postMessage is fired from other contexts. +Provedes the same functionality as [`makeBroadcastChannel`](#makebroadcastchannel) but instead of returning `onMessage` function, it returns a `message` signal accessor that updates when postMessage is fired from other contexts. ```ts const { postMessage } = createBroadcastChannel("test_channel"); diff --git a/packages/connectivity/README.md b/packages/connectivity/README.md index 0024f5937..9c334d0e6 100644 --- a/packages/connectivity/README.md +++ b/packages/connectivity/README.md @@ -11,8 +11,8 @@ A [`navigator.onLine`](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/Online_and_offline_events) signal that tells you when the browser _thinks_ you're online. Connectivity is determined by your browser, which is a best-effort process. -- [`makeConnectivityListener`](#makeConnectivityListener) - Attaches event listeners and fires callback whenever `window.onLine` changes. -- [`createConnectivitySignal`](#createConnectivitySignal) - A signal representing the browser's interpretation of whether it is on- or offline. +- [`makeConnectivityListener`](#makeconnectivitylistener) - Attaches event listeners and fires callback whenever `window.onLine` changes. +- [`createConnectivitySignal`](#createconnectivitysignal) - A signal representing the browser's interpretation of whether it is on- or offline. ## Installation @@ -57,7 +57,7 @@ isOnline(); // T: boolean This primitive provides a [singleton root](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSingletonRoot) variant that will reuse event listeners and signals across dependents. -It's behavior is the same as [`createConnectivitySignal`](#createConnectivitySignal). +It's behavior is the same as [`createConnectivitySignal`](#createconnectivitysignal). ```ts import { useConnectivitySignal } from "@solid-primitives/connectivity"; diff --git a/packages/cursor/README.md b/packages/cursor/README.md index e4f8a0d91..054d4b9fd 100644 --- a/packages/cursor/README.md +++ b/packages/cursor/README.md @@ -11,8 +11,8 @@ Two simple primitives for setting cursor css property reactively. -- [`createElementCursor`](#createElementCursor) - Set provided cursor to given HTML Element styles reactively. -- [`createBodyCursor`](#createBodyCursor) - Set selected cursor to body element styles reactively. +- [`createElementCursor`](#createelementcursor) - Set provided cursor to given HTML Element styles reactively. +- [`createBodyCursor`](#createbodycursor) - Set selected cursor to body element styles reactively. ## Installation diff --git a/packages/date/README.md b/packages/date/README.md index 7186bd43d..7560819a0 100644 --- a/packages/date/README.md +++ b/packages/date/README.md @@ -11,13 +11,13 @@ Collection of reactive primitives and utility functions, providing easier ways to deal with dates in SolidJS. -- [`createDate`](#createDate) - Creates a reactive `Date` signal. -- [`createDateNow`](#createDateNow) - Creates an autoupdating and reactive `new Date()`. -- [`createTimeDifference`](#createTimeDifference) - Provides a reactive time difference _(in ms)_ signal. -- [`createTimeDifferenceFromNow`](#createTimeDifferenceFromNow) - Provides a autoupdating, reactive time difference _(in ms)_ from **now** as a signal. -- [`createTimeAgo`](#createTimeAgo) - Provides a reactive, formatted, autoupdating date difference in relation to **now**. -- [`createCountdown`](#createCountdown) - Provides a reactive broken down time remaining Store. -- [`createCountdownFromNow`](#createCountdownFromNow) - Provides a reactive, autoupdating _(from **now**)_, broken down "time remaining" as a Store. +- [`createDate`](#createdate) - Creates a reactive `Date` signal. +- [`createDateNow`](#createdatenow) - Creates an autoupdating and reactive `new Date()`. +- [`createTimeDifference`](#createtimedifference) - Provides a reactive time difference _(in ms)_ signal. +- [`createTimeDifferenceFromNow`](#createtimedifferencefromnow) - Provides a autoupdating, reactive time difference _(in ms)_ from **now** as a signal. +- [`createTimeAgo`](#createtimeago) - Provides a reactive, formatted, autoupdating date difference in relation to **now**. +- [`createCountdown`](#createcountdown) - Provides a reactive broken down time remaining Store. +- [`createCountdownFromNow`](#createcountdownfromnow) - Provides a reactive, autoupdating _(from **now**)_, broken down "time remaining" as a Store. - \+ [some non-reactive date-related utility functions](#utility-functions). ## Installation diff --git a/packages/deep/README.md b/packages/deep/README.md index 4ed962ce8..7a1a5f11e 100644 --- a/packages/deep/README.md +++ b/packages/deep/README.md @@ -11,9 +11,9 @@ Primitives for tracking and observing nested reactive objects in Solid. -- [`trackDeep`](#trackDeep) - Tracks all properties of a store by iterating over them recursively. -- [`trackStore`](#trackStore) - A more performant alternative to `trackDeep` utilizing specific store implementations. -- [`captureStoreUpdates`](#captureStoreUpdates) - A utility function that captures all updates to a store and returns them as an array. +- [`trackDeep`](#trackdeep) - Tracks all properties of a store by iterating over them recursively. +- [`trackStore`](#trackstore) - A more performant alternative to `trackDeep` utilizing specific store implementations. +- [`captureStoreUpdates`](#capturestoreupdates) - A utility function that captures all updates to a store and returns them as an array. ## Installation @@ -121,7 +121,7 @@ setState("todos", ["foo"]); getDelta(); // [{ path: ["todos"], value: ["foo"] }] ``` -The returned function will track all updates to a store (just like [`trackStore`](#trackStore)), so it can be used inside a tracking scope. +The returned function will track all updates to a store (just like [`trackStore`](#trackstore)), so it can be used inside a tracking scope. ```ts const [state, setState] = createStore({ todos: [] }); diff --git a/packages/event-bus/README.md b/packages/event-bus/README.md index 418253348..cf7edd7bc 100644 --- a/packages/event-bus/README.md +++ b/packages/event-bus/README.md @@ -11,10 +11,10 @@ A collection of SolidJS primitives providing various features of a pubsub/event-emitter/event-bus: -- [`createEventBus`](#createEventBus) - Provides a simple way to listen to and emit events. -- [`createEmitter`](#createEmitter) - Creates an emitter with which you can listen to and emit various events. -- [`createEventHub`](#createEventHub) - Provides helpers for using a group of buses. -- [`createEventStack`](#createEventStack) - Provides the emitted events as list/history, with tools to manage it. +- [`createEventBus`](#createeventbus) - Provides a simple way to listen to and emit events. +- [`createEmitter`](#createemitter) - Creates an emitter with which you can listen to and emit various events. +- [`createEventHub`](#createeventhub) - Provides helpers for using a group of buses. +- [`createEventStack`](#createeventstack) - Provides the emitted events as list/history, with tools to manage it. ## Installation @@ -189,7 +189,7 @@ hub.myBus.value(); ## `createEventStack` -Extends [`createEmitter`](#createEmitter). Provides the emitted events in a list/history form, with tools to manage it. +Extends [`createEmitter`](#createemitter). Provides the emitted events in a list/history form, with tools to manage it. ### How to use it diff --git a/packages/event-listener/README.md b/packages/event-listener/README.md index 45d85e5b8..7280e94bc 100644 --- a/packages/event-listener/README.md +++ b/packages/event-listener/README.md @@ -13,25 +13,25 @@ A set of primitives that help with listening to DOM and Custom Events. ##### Non-reactive primitives: -- [`makeEventListener`](#makeEventListener) — Non-reactive primitive for adding event listeners that gets removed onCleanup. -- [`makeEventListenerStack`](#makeEventListenerStack) — Creates a stack of event listeners, that will be automatically disposed on cleanup. +- [`makeEventListener`](#makeeventlistener) — Non-reactive primitive for adding event listeners that gets removed onCleanup. +- [`makeEventListenerStack`](#makeeventlistenerstack) — Creates a stack of event listeners, that will be automatically disposed on cleanup. ##### Reactive primitives: -- [`createEventListener`](#createEventListener) — Reactive version of [`makeEventListener`](#makeEventListener), that takes signal arguments to apply new listeners once changed. -- [`createEventSignal`](#createEventListener) — Like [`createEventListener`](#createEventListener), but captured events are stored in a returned signal. -- [`createEventListenerMap`](#createEventListenerMap) — A helpful primitive that listens to a map of events. Handle them by individual callbacks. +- [`createEventListener`](#createeventlistener) — Reactive version of [`makeEventListener`](#makeeventlistener), that takes signal arguments to apply new listeners once changed. +- [`createEventSignal`](#createeventlistener) — Like [`createEventListener`](#createeventlistener), but captured events are stored in a returned signal. +- [`createEventListenerMap`](#createeventlistenermap) — A helpful primitive that listens to a map of events. Handle them by individual callbacks. ##### Component global listeners: -- [`WindowEventListener`](#WindowEventListener) — Listen to the `window` DOM Events, using a component. -- [`DocumentEventListener`](#DocumentEventListener) — Listen to the `document` DOM Events, using a component. +- [`WindowEventListener`](#windoweventlistener) — Listen to the `window` DOM Events, using a component. +- [`DocumentEventListener`](#documenteventlistener) — Listen to the `document` DOM Events, using a component. ##### Callback Wrappers -- [`preventDefault`](#preventDefault) — Wraps event handler with `e.preventDefault()` call. -- [`stopPropagation`](#stopPropagation) — Wraps event handler with `e.stopPropagation()` call. -- [`stopImmediatePropagation`](#stopImmediatePropagation) — Wraps event handler with `e.stopImmediatePropagation()` call. +- [`preventDefault`](#preventdefault) — Wraps event handler with `e.preventDefault()` call. +- [`stopPropagation`](#stoppropagation) — Wraps event handler with `e.stopPropagation()` call. +- [`stopImmediatePropagation`](#stopimmediatepropagation) — Wraps event handler with `e.stopImmediatePropagation()` call. ## Installation @@ -108,7 +108,7 @@ clear(); ## `createEventListener` -Reactive version of [`makeEventListener`](#makeEventListener), that can take signal `target` and `type` arguments to apply new listeners once changed. +Reactive version of [`makeEventListener`](#makeeventlistener), that can take signal `target` and `type` arguments to apply new listeners once changed. ### How to use it @@ -197,7 +197,7 @@ eventListener; ## `createEventSignal` -Like [`createEventListener`](#createEventListener), but events are handled with the returned signal, instead of with a callback. +Like [`createEventListener`](#createeventlistener), but events are handled with the returned signal, instead of with a callback. ### How to use it @@ -268,7 +268,7 @@ import { WindowEventListener } from "@solid-primitives/event-listener"; ## `DocumentEventListener` -The same as [`WindowEventListener`](#WindowEventListener), but listens to `document` events. +The same as [`WindowEventListener`](#windoweventlistener), but listens to `document` events. ### How to use it diff --git a/packages/flux-store/README.md b/packages/flux-store/README.md index ca01975b0..4a5c649fc 100644 --- a/packages/flux-store/README.md +++ b/packages/flux-store/README.md @@ -11,8 +11,8 @@ A library for creating Solid stores with implementing state management through explicit getters for reads and actions for writes. -- [`createFluxStore`](#createFluxStore) — Creates a store instance with explicit getters and actions. -- [`createFluxStoreFactory`](#createFluxStoreFactory) — Create a `FluxStore` encapsulated in a factory function for reusable store implementation. +- [`createFluxStore`](#createfluxstore) — Creates a store instance with explicit getters and actions. +- [`createFluxStoreFactory`](#createfluxstorefactory) — Create a `FluxStore` encapsulated in a factory function for reusable store implementation. ## Installation diff --git a/packages/immutable/README.md b/packages/immutable/README.md index d550cf7a4..962da1b32 100644 --- a/packages/immutable/README.md +++ b/packages/immutable/README.md @@ -11,7 +11,7 @@ Primitive for rectifying immutable values and dealing with immutability in Solid. -- [`createImmutable`](#createImmutable) - Creates a store derived from the given immutable source. +- [`createImmutable`](#createimmutable) - Creates a store derived from the given immutable source. ## Installation diff --git a/packages/intersection-observer/README.md b/packages/intersection-observer/README.md index be2921054..288ab1fa2 100644 --- a/packages/intersection-observer/README.md +++ b/packages/intersection-observer/README.md @@ -11,9 +11,9 @@ A range of IntersectionObserver API utilities great for different types of use cases: -- [`createIntersectionObserver`](#createIntersectionObserver) - A reactive observer primitive. -- [`createViewportObserver`](#createViewportObserver) - More advanced tracker that creates a store of element signals. -- [`createVisibilityObserver`](#createVisibilityObserver) - Basic visibility observer using a signal. +- [`createIntersectionObserver`](#createintersectionobserver) - A reactive observer primitive. +- [`createViewportObserver`](#createviewportobserver) - More advanced tracker that creates a store of element signals. +- [`createVisibilityObserver`](#createvisibilityobserver) - Basic visibility observer using a signal. ## Installation diff --git a/packages/jsx-tokenizer/README.md b/packages/jsx-tokenizer/README.md index da5252e9a..aae49a85e 100644 --- a/packages/jsx-tokenizer/README.md +++ b/packages/jsx-tokenizer/README.md @@ -7,14 +7,14 @@ [![version](https://img.shields.io/npm/v/@solid-primitives/jsx-tokenizer?style=for-the-badge)](https://www.npmjs.com/package/@solid-primitives/jsx-tokenizer) [![stage](https://img.shields.io/endpoint?style=for-the-badge&url=https%3A%2F%2Fraw.githubusercontent.com%2Fsolidjs-community%2Fsolid-primitives%2Fmain%2Fassets%2Fbadges%2Fstage-2.json)](https://github.com/solidjs-community/solid-primitives#contribution-process) -A set of primitives that help safely pass data through JSX to the parent component using [token components](#createToken). +A set of primitives that help safely pass data through JSX to the parent component using [token components](#createtoken). This pattern is very useful when you want to use JSX to create a declarative API for your components. It lets you resolve the JSX structure and pass the data to the parent component without triggering rendering of the children - it puts the parent in control over what getting rendered. -- [`createTokenizer`](#createTokenizer) — Creates a JSX Tokenizer that can be used to create multiple token components with the same id. -- [`createToken`](#createToken) — Creates a token component for passing custom data through JSX structure. -- [`resolveTokens`](#resolveTokens) — Resolves passed JSX structure, searching for tokens with the given tokenizer id. -- [`isToken`](#isToken) — Checks if passed value is a token created by the corresponding jsx-tokenizer. +- [`createTokenizer`](#createtokenizer) — Creates a JSX Tokenizer that can be used to create multiple token components with the same id. +- [`createToken`](#createtoken) — Creates a token component for passing custom data through JSX structure. +- [`resolveTokens`](#resolvetokens) — Resolves passed JSX structure, searching for tokens with the given tokenizer id. +- [`isToken`](#istoken) — Checks if passed value is a token created by the corresponding jsx-tokenizer. ## Installation @@ -149,7 +149,7 @@ A function similar to Solid's [`children()`](https://www.solidjs.com/docs/latest `resolveTokens` takes three parameters: -- `tokenizer` - identity object returned by [`createTokenizer`](#createTokenizer) or a token component. An array of multiple tokenizers can be passed. +- `tokenizer` - identity object returned by [`createTokenizer`](#createtokenizer) or a token component. An array of multiple tokenizers can be passed. - `fn` accessor that returns a JSX Element (e.g. `() => props.children`) - `options` options for the resolver: - `includeJSXElements` - if `true`, other JSX Elements will be included in the result array (default: `false`) diff --git a/packages/keyboard/README.md b/packages/keyboard/README.md index b2d3cf608..406eee1c0 100644 --- a/packages/keyboard/README.md +++ b/packages/keyboard/README.md @@ -11,12 +11,12 @@ A library of reactive promitives helping handling user's keyboard input. -- [`useKeyDownEvent`](#useKeyDownEvent) — Provides a signal with the last keydown event. -- [`useKeyDownList`](#useKeyDownList) — Provides a signal with the list of currently held keys -- [`useCurrentlyHeldKey`](#useCurrentlyHeldKey) — Provides a signal with the currently held single key. -- [`useKeyDownSequence`](#useKeyDownSequence) — Provides a signal with a sequence of currently held keys, as they were pressed down and up. -- [`createKeyHold`](#createKeyHold) — Provides a signal indicating if provided key is currently being held down. -- [`createShortcut`](#createShortcut) — Creates a keyboard shotcut observer. +- [`useKeyDownEvent`](#usekeydownevent) — Provides a signal with the last keydown event. +- [`useKeyDownList`](#usekeydownlist) — Provides a signal with the list of currently held keys +- [`useCurrentlyHeldKey`](#usecurrentlyheldkey) — Provides a signal with the currently held single key. +- [`useKeyDownSequence`](#usekeydownsequence) — Provides a signal with a sequence of currently held keys, as they were pressed down and up. +- [`createKeyHold`](#createkeyhold) — Provides a signal indicating if provided key is currently being held down. +- [`createShortcut`](#createshortcut) — Creates a keyboard shotcut observer. ## Installation diff --git a/packages/keyed/README.md b/packages/keyed/README.md index 70270f28b..a6ed35ff7 100644 --- a/packages/keyed/README.md +++ b/packages/keyed/README.md @@ -11,10 +11,10 @@ Control Flow primitives and components that require specifying explicit keys to identify or rerender elements. -- [`keyArray`](#keyArray) - Reactively maps an array by specified key with a callback function - underlying helper for the `` control flow. -- [`Key`](#Key) - Creates a list of elements by mapping items by provided key. -- [`Entries`](#Entries) - Creates a list of elements by mapping object entries. -- [`Rerun`](#Rerun) - Causes the children to rerender when the `on` changes. +- [`keyArray`](#keyarray) - Reactively maps an array by specified key with a callback function - underlying helper for the `` control flow. +- [`Key`](#key) - Creates a list of elements by mapping items by provided key. +- [`Entries`](#entries) - Creates a list of elements by mapping object entries. +- [`Rerun`](#rerun) - Causes the children to rerender when the `on` changes. ## Installation @@ -26,7 +26,7 @@ yarn add @solid-primitives/keyed ## `keyArray` -Reactively maps an array by specified key with a callback function - underlying helper for the [``](#Key) control flow. +Reactively maps an array by specified key with a callback function - underlying helper for the [``](#key) control flow. ### How to use it diff --git a/packages/lifecycle/README.md b/packages/lifecycle/README.md index 7707f6e93..1f6d3c2a3 100644 --- a/packages/lifecycle/README.md +++ b/packages/lifecycle/README.md @@ -11,9 +11,9 @@ Package providing extra layer of lifecycle primitives for Solid. -- [`createIsMounted`](#createIsMounted) - Returns a boolean signal indicating whether the component is mounted or not. -- [`isHydrated`](#isHydrated) - A signal with the same behavior as [`isHydrating`](#isHydrating) but this one focused only on client-side updates. -- [`onElementConnect`](#onElementConnect) - Calls the given callback when the target element is connected to the DOM. +- [`createIsMounted`](#createismounted) - Returns a boolean signal indicating whether the component is mounted or not. +- [`isHydrated`](#ishydrated) - A signal with the same behavior as [`isHydrating`](#ishydrating) but this one focused only on client-side updates. +- [`onElementConnect`](#onelementconnect) - Calls the given callback when the target element is connected to the DOM. ## Installation diff --git a/packages/list/README.md b/packages/list/README.md index a098ae2d4..e38c59635 100644 --- a/packages/list/README.md +++ b/packages/list/README.md @@ -11,8 +11,8 @@ Package providing additional way to manage arrays. Alternative to `` and `` that has reactive item value and reactive index. Focuses on avoiding recreation of mapped elements. -[`List`](#List) - Component that provides reactive item value and reactive index. -[`listArray`](#listArray) - Underlying helper for `` unkeyed control flow, similar to `mapArray` and `indexArray`. +[`List`](#list) - Component that provides reactive item value and reactive index. +[`listArray`](#listarray) - Underlying helper for `` unkeyed control flow, similar to `mapArray` and `indexArray`. ## Installation diff --git a/packages/masonry/README.md b/packages/masonry/README.md index 1ffeedaf9..ae4bacd68 100644 --- a/packages/masonry/README.md +++ b/packages/masonry/README.md @@ -11,7 +11,7 @@ Primitives for creating a reactive masonry layout. -- [`createMasonry`](#createMasonry) - Creates a reactive masonry layout data from a reactive source array. +- [`createMasonry`](#createmasonry) - Creates a reactive masonry layout data from a reactive source array. ## Installation diff --git a/packages/media/README.md b/packages/media/README.md index a32d9cbd9..7d15fd81e 100644 --- a/packages/media/README.md +++ b/packages/media/README.md @@ -11,10 +11,10 @@ Collection of reactive primitives to deal with media queries. -- [`makeMediaQueryListener`](#makeMediaQueryListener) - Listen for changes to provided Media Query. -- [`createMediaQuery`](#createMediaQuery) - Creates a very simple and straightforward media query monitor. -- [`createBreakpoints`](#createBreakpoints) - Creates a multi-breakpoint monitor to make responsive components easily. -- [`createPrefersDark`](#createPrefersDark) - Provides a signal indicating if the user has requested dark color theme. +- [`makeMediaQueryListener`](#makemediaquerylistener) - Listen for changes to provided Media Query. +- [`createMediaQuery`](#createmediaquery) - Creates a very simple and straightforward media query monitor. +- [`createBreakpoints`](#createbreakpoints) - Creates a multi-breakpoint monitor to make responsive components easily. +- [`createPrefersDark`](#createprefersdark) - Provides a signal indicating if the user has requested dark color theme. ## Installation diff --git a/packages/memo/README.md b/packages/memo/README.md index 465c3fc53..f1ece8686 100644 --- a/packages/memo/README.md +++ b/packages/memo/README.md @@ -11,13 +11,13 @@ Collection of custom `createMemo` primitives. They extend it's functionality while keeping the usage similar. -- [`createLatest`](#createLatest) - A combined memo of a list of sources, returns the value of last updated one. -- [`createLatestMany`](#createLatestMany) - A combined memo of a list of sources, returns the value of all last updated ones. -- [`createWritableMemo`](#createWritableMemo) - Solid's `createMemo` which value can be overwritten by a setter. -- [`createLazyMemo`](#createLazyMemo) - Lazily evaluated memo. Will run the calculation only if is being listened to. -- [`createPureReaction`](#createPureReaction) - A `createReaction` that runs before render _(non-batching)_. -- [`createMemoCache`](#createMemoCache) - Custom, lazily-evaluated, memo, with caching based on keys. -- [`createReducer`](#createReducer) - Primitive for updating signal in a predictable way. +- [`createLatest`](#createlatest) - A combined memo of a list of sources, returns the value of last updated one. +- [`createLatestMany`](#createlatestmany) - A combined memo of a list of sources, returns the value of all last updated ones. +- [`createWritableMemo`](#createwritablememo) - Solid's `createMemo` which value can be overwritten by a setter. +- [`createLazyMemo`](#createlazymemo) - Lazily evaluated memo. Will run the calculation only if is being listened to. +- [`createPureReaction`](#createpurereaction) - A `createReaction` that runs before render _(non-batching)_. +- [`createMemoCache`](#creatememocache) - Custom, lazily-evaluated, memo, with caching based on keys. +- [`createReducer`](#createreducer) - Primitive for updating signal in a predictable way. ## Installation diff --git a/packages/mouse/README.md b/packages/mouse/README.md index 072ab2e10..be48d3b92 100644 --- a/packages/mouse/README.md +++ b/packages/mouse/README.md @@ -13,19 +13,19 @@ A collection of primitives, capturing current mouse cursor position, and helping ##### Reactive primitives: -- [`createMousePosition`](#createMousePosition) - Listens to the mouse events, providing a reactive up-to-date position of the cursor on the page. -- [`createPositionToElement`](#createPositionToElement) - Provides an auto-updating position relative to a provided element. +- [`createMousePosition`](#createmouseposition) - Listens to the mouse events, providing a reactive up-to-date position of the cursor on the page. +- [`createPositionToElement`](#createpositiontoelement) - Provides an auto-updating position relative to a provided element. ##### Non-reactive primitives: -- [`makeMousePositionListener`](#makeMousePositionListener) - Attaches event listeners to provided target, listening for changes to the mouse/touch position. -- [`makeMouseInsideListener`](#makeMouseInsideListener) - Attaches event listeners to provided target, listening for mouse/touch entering/leaving the element. +- [`makeMousePositionListener`](#makemousepositionlistener) - Attaches event listeners to provided target, listening for changes to the mouse/touch position. +- [`makeMouseInsideListener`](#makemouseinsidelistener) - Attaches event listeners to provided target, listening for mouse/touch entering/leaving the element. ##### Calculations: -- [`getPositionToElement`](#getPositionToElement) - Turn position relative to the page, into position relative to an element. -- [`getPositionInElement`](#getPositionInElement) - Turn position relative to the page, into position relative to an element. Clamped to the element bounds. -- [`getPositionToScreen`](#getPositionToScreen) - Turn position relative to the page, into position relative to the screen. +- [`getPositionToElement`](#getpositiontoelement) - Turn position relative to the page, into position relative to an element. +- [`getPositionInElement`](#getpositioninelement) - Turn position relative to the page, into position relative to an element. Clamped to the element bounds. +- [`getPositionToScreen`](#getpositiontoscreen) - Turn position relative to the page, into position relative to the screen. ## Installation diff --git a/packages/mutable/README.md b/packages/mutable/README.md index af86bf4e0..633f92dfa 100644 --- a/packages/mutable/README.md +++ b/packages/mutable/README.md @@ -11,8 +11,8 @@ A primitive for creating a mutable store proxy object. An alternative to `createStore` from `"solid-js/store"`. -- [`createMutable`](#createMutable) - Creates a mutable store proxy object. -- [`modifyMutable`](#modifyMutable) - Helper for applying store mutation utilities - like `produce` or `reconcile` from `"solid-js/store"` - to a mutable store. +- [`createMutable`](#createmutable) - Creates a mutable store proxy object. +- [`modifyMutable`](#modifymutable) - Helper for applying store mutation utilities - like `produce` or `reconcile` from `"solid-js/store"` - to a mutable store. ## Installation diff --git a/packages/page-visibility/README.md b/packages/page-visibility/README.md index 418d95673..50b61d6e1 100644 --- a/packages/page-visibility/README.md +++ b/packages/page-visibility/README.md @@ -9,8 +9,8 @@ [![size](https://img.shields.io/npm/v/@solid-primitives/page-visibility?style=for-the-badge)](https://www.npmjs.com/package/@solid-primitives/page-visibility) [![stage](https://img.shields.io/endpoint?style=for-the-badge&url=https%3A%2F%2Fraw.githubusercontent.com%2Fsolidjs-community%2Fsolid-primitives%2Fmain%2Fassets%2Fbadges%2Fstage-3.json)](https://github.com/solidjs-community/solid-primitives#contribution-process) -- [`createPageVisibility`](#createPageVisibility) - Creates a signal with a boolean value identifying the page visibility state -- [`usePageVisibility`](#usePageVisibility) - A [singleton root](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSingletonRoot) alternative. +- [`createPageVisibility`](#createpagevisibility) - Creates a signal with a boolean value identifying the page visibility state +- [`usePageVisibility`](#usepagevisibility) - A [singleton root](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSingletonRoot) alternative. ## Installation diff --git a/packages/pagination/README.md b/packages/pagination/README.md index 0ca417337..04dd5672e 100644 --- a/packages/pagination/README.md +++ b/packages/pagination/README.md @@ -11,8 +11,8 @@ A primitive that creates all the reactive data to manage your pagination: -- [`createPagination`](#createPagination) - Provides an array with the properties to fill your pagination with and a page setter/getter. -- [`createInfiniteScroll`](#createInfiniteScroll) - Provides an easy way to implement infinite scrolling. +- [`createPagination`](#createpagination) - Provides an array with the properties to fill your pagination with and a page setter/getter. +- [`createInfiniteScroll`](#createinfinitescroll) - Provides an easy way to implement infinite scrolling. ## Installation diff --git a/packages/pointer/README.md b/packages/pointer/README.md index cf2b01ebc..15488357a 100644 --- a/packages/pointer/README.md +++ b/packages/pointer/README.md @@ -11,11 +11,11 @@ A collection of primitives, giving you a nicer API to handle pointer events in a reactive context. -- [`createPointerListeners`](#createPointerListeners) - Setups event listeners for pointer events, that will get automatically removed on cleanup, -- [`createPerPointerListeners`](#createPerPointerListeners) - Setup pointer event listeners, while following the pointers individually, from when they appear, until they're gone, -- [`createPointerPosition`](#createPointerPosition) - Returns a signal with autoupdating Pointer position, -- [`createPointerList`](#createPointerList) - Provides a signal of current pointers on screen -- [`pointerHover`](#pointerHover) - A directive for checking if the element is being hovered by at least one pointer. +- [`createPointerListeners`](#createpointerlisteners) - Setups event listeners for pointer events, that will get automatically removed on cleanup, +- [`createPerPointerListeners`](#createperpointerlisteners) - Setup pointer event listeners, while following the pointers individually, from when they appear, until they're gone, +- [`createPointerPosition`](#createpointerposition) - Returns a signal with autoupdating Pointer position, +- [`createPointerList`](#createpointerlist) - Provides a signal of current pointers on screen +- [`pointerHover`](#pointerhover) - A directive for checking if the element is being hovered by at least one pointer. ## Installation diff --git a/packages/promise/README.md b/packages/promise/README.md index 387a5fc0f..b6b799521 100644 --- a/packages/promise/README.md +++ b/packages/promise/README.md @@ -11,8 +11,8 @@ A library of reactive primitives and helpers for handling promises. -- [`promiseTimeout`](#promiseTimeout) — Creates a promise that resolves _(or rejects)_ after given time. -- [`raceTimeout`](#raceTimeout) — Combination of `Promise.race()` and `promiseTimeout`. +- [`promiseTimeout`](#promisetimeout) — Creates a promise that resolves _(or rejects)_ after given time. +- [`raceTimeout`](#racetimeout) — Combination of `Promise.race()` and `promiseTimeout`. - [`until`](#until) — Promised one-time watch for changes. Await a reactive condition. ## Installation diff --git a/packages/props/README.md b/packages/props/README.md index 523068abc..5ea82f1c9 100644 --- a/packages/props/README.md +++ b/packages/props/README.md @@ -11,8 +11,8 @@ Library of primitives focused around component props. -- [`combineProps`](#combineProps) - Reactively merges multiple props objects together while smartly combining some of Solid's JSX/DOM attributes. -- [`filterProps`](#filterProps) - Create a new props object with only the property names that match the predicate. +- [`combineProps`](#combineprops) - Reactively merges multiple props objects together while smartly combining some of Solid's JSX/DOM attributes. +- [`filterProps`](#filterprops) - Create a new props object with only the property names that match the predicate. ## Installation diff --git a/packages/raf/README.md b/packages/raf/README.md index eb7d7d865..5966811df 100644 --- a/packages/raf/README.md +++ b/packages/raf/README.md @@ -11,8 +11,8 @@ Reactive primitives providing support to `window.requestAnimationFrame`. -- [`createRAF`](#createRAF) - Creates an auto-disposing requestAnimationFrame loop. -- [`targetFPS`](#targetFPS) - Used to limit the FPS of [`createRAF`](#createRAF) +- [`createRAF`](#createraf) - Creates an auto-disposing requestAnimationFrame loop. +- [`targetFPS`](#targetfps) - Used to limit the FPS of [`createRAF`](#createraf) ## Installation diff --git a/packages/range/README.md b/packages/range/README.md index bedc30069..5b3a8c729 100644 --- a/packages/range/README.md +++ b/packages/range/README.md @@ -13,9 +13,9 @@ Control Flow Primitives for displaying a number range or given number of element - [`repeat`](#repeat) - Primitive for mapping a number of elements. Underlying helper for the [``](#repeat-1) control flow. - [``](#repeat-1) - Control Flow Component for displaying a number of elements. -- [`mapRange`](#mapRange) - Primitive for mapping a number range of given start, end, and step values. Underlying helper for the [``](#range) control flow. +- [`mapRange`](#maprange) - Primitive for mapping a number range of given start, end, and step values. Underlying helper for the [``](#range) control flow. - [``](#range) - Control Flow Component for displaying a number range of elements. -- [`indexRange`](#indexRange) - Primitive for mapping a number range while keeping previous elements of the same index. Underlying helper for the [``](#indexrange-1) control flow. +- [`indexRange`](#indexrange) - Primitive for mapping a number range while keeping previous elements of the same index. Underlying helper for the [``](#indexrange-1) control flow. - [``](#indexrange-1) - Control Flow Component for displaying a number range of elements, where elements receive a number value as signal. ## Installation diff --git a/packages/refs/README.md b/packages/refs/README.md index 8a8ae4fc6..1b1bff663 100644 --- a/packages/refs/README.md +++ b/packages/refs/README.md @@ -13,9 +13,9 @@ Collection of primitives, components and directives that help managing reference ##### Primitives: -- [`mergeRefs`](#mergeRefs) - Utility for chaining multiple `ref` assignments with `props.ref` forwarding. -- [`resolveElements`](#resolveElements) - Utility for resolving recursively nested JSX children to a single element or an array of elements. -- [`resolveFirst`](#resolveFirst) - Utility for resolving recursively nested JSX children in search of the first element that matches a predicate. +- [`mergeRefs`](#mergerefs) - Utility for chaining multiple `ref` assignments with `props.ref` forwarding. +- [`resolveElements`](#resolveelements) - Utility for resolving recursively nested JSX children to a single element or an array of elements. +- [`resolveFirst`](#resolvefirst) - Utility for resolving recursively nested JSX children in search of the first element that matches a predicate. - [``](#refs) - Get up-to-date references of the multiple children elements. - [``](#ref) - Get up-to-date reference to a single child element. @@ -111,7 +111,7 @@ Utility for resolving recursively nested JSX children in search of the first ele ### How to use it -`resolveFirst` matches the API of [`resolveElements`](#resolveElements) but returns only the first element that matches the predicate. +`resolveFirst` matches the API of [`resolveElements`](#resolveelements) but returns only the first element that matches the predicate. ```tsx function Button(props: ParentProps) { diff --git a/packages/resize-observer/README.md b/packages/resize-observer/README.md index 4171e42d2..c8ada9c0b 100644 --- a/packages/resize-observer/README.md +++ b/packages/resize-observer/README.md @@ -11,10 +11,10 @@ Reactive primitives for observing resizing of HTML elements. -- [`makeResizeObserver`](#makeResizeObserver) — Instantiate a new ResizeObserver that automatically get's disposed on cleanup. -- [`createResizeObserver`](#createResizeObserver) — Create resize observer instance, listening for changes to size of reactive element targets array. -- [`createWindowSize`](#createWindowSize) — Creates a reactive store-like object of current width and height dimensions of the browser window. -- [`createElementSize`](#createElementSize) — Creates a reactive store-like object of current width and height dimensions of html element. +- [`makeResizeObserver`](#makeresizeobserver) — Instantiate a new ResizeObserver that automatically get's disposed on cleanup. +- [`createResizeObserver`](#createresizeobserver) — Create resize observer instance, listening for changes to size of reactive element targets array. +- [`createWindowSize`](#createwindowsize) — Creates a reactive store-like object of current width and height dimensions of the browser window. +- [`createElementSize`](#createelementsize) — Creates a reactive store-like object of current width and height dimensions of html element. ## Installation diff --git a/packages/resource/README.md b/packages/resource/README.md index d27515907..d41507299 100644 --- a/packages/resource/README.md +++ b/packages/resource/README.md @@ -14,7 +14,7 @@ A collection of composable primitives to augment [`createResource`](https://www. - [`createAggregated`](#createaggregated) - wraps the resource to aggregate data instead of overwriting it - [`createDeepSignal`](#createdeepsignal) - provides a fine-grained signal for the [resource storage option](https://docs.solidjs.com/reference/basic-reactivity/create-resource#options) - [`makeAbortable`](#makeabortable) - sets up an AbortSignal with auto-abort on re-fetch or timeout -- [`createAbortable`](#createAbortable) - like `makeAbortable`, but with automatic abort on cleanup +- [`createAbortable`](#createabortable) - like `makeAbortable`, but with automatic abort on cleanup - [`makeCache`](#makecache) - wraps the fetcher to cache the responses for a certain amount of time - [`makeRetrying`](#makeretrying) - wraps the fetcher to retry requests after a delay diff --git a/packages/rootless/README.md b/packages/rootless/README.md index 596b70edd..4954bddc5 100644 --- a/packages/rootless/README.md +++ b/packages/rootless/README.md @@ -11,11 +11,11 @@ A collection of helpers that aim to simplify using reactive primitives outside of reactive roots, and managing disposal of reactive roots. -- [`createSubRoot`](#createSubRoot) - Creates a reactive **sub root**, that will be automatically disposed when it's owner does. -- [`createCallback`](#createCallback) - A wrapper for creating callbacks with `runWithOwner`. -- [`createDisposable`](#createDisposable) - For disposing computations early – before the root cleanup. -- [`createSingletonRoot`](#createSingletonRoot) - Share "global primitives" across multiple reactive scopes. -- [`createRootPool`](#createRootPool) - Creates a pool of reactive roots, that can be reused. +- [`createSubRoot`](#createsubroot) - Creates a reactive **sub root**, that will be automatically disposed when it's owner does. +- [`createCallback`](#createcallback) - A wrapper for creating callbacks with `runWithOwner`. +- [`createDisposable`](#createdisposable) - For disposing computations early – before the root cleanup. +- [`createSingletonRoot`](#createsingletonroot) - Share "global primitives" across multiple reactive scopes. +- [`createRootPool`](#createrootpool) - Creates a pool of reactive roots, that can be reused. ## Installation @@ -98,7 +98,7 @@ For disposing computations early – before the root cleanup. ### How to use it -Executes provided function in a [`createSubRoot`](#createSubRoot) _(auto-disposing root)_, and returns a dispose function, to dispose computations used inside before automatic cleanup. +Executes provided function in a [`createSubRoot`](#createsubroot) _(auto-disposing root)_, and returns a dispose function, to dispose computations used inside before automatic cleanup. ```ts const dispose = createDisposable(dispose => { diff --git a/packages/scheduled/README.md b/packages/scheduled/README.md index f77b32088..15a336bd5 100644 --- a/packages/scheduled/README.md +++ b/packages/scheduled/README.md @@ -13,7 +13,7 @@ Primitives for creating scheduled — throttled or debounced — callbacks. - [`debounce`](#debounce) - Creates a callback that is **debounced** and cancellable. - [`throttle`](#throttle) - Creates a callback that is **throttled** and cancellable. -- [`scheduleIdle`](#scheduleIdle) - Creates a callback throttled using `window.requestIdleCallback()`. +- [`scheduleIdle`](#scheduleidle) - Creates a callback throttled using `window.requestIdleCallback()`. - [`leading`](#leading) - Creates a scheduled and cancellable callback that will be called on **leading** edge. - [`createScheduled`](#createscheduled) - Creates a signal used for scheduling execution of solid computations by tracking. - [Scheduling explanation](#scheduling-explanation) diff --git a/packages/scroll/README.md b/packages/scroll/README.md index 500d5eb67..6b9f689eb 100644 --- a/packages/scroll/README.md +++ b/packages/scroll/README.md @@ -11,8 +11,8 @@ Reactive primitives to react to element/window scrolling. -- [`createScrollPosition`](#createScrollPosition) - Reactive primitive providing a store-like object with current scroll position of specified target. -- [`useWindowScrollPosition`](#useWindowScrollPosition) - Returns a reactive object with current window scroll position. +- [`createScrollPosition`](#createscrollposition) - Reactive primitive providing a store-like object with current scroll position of specified target. +- [`useWindowScrollPosition`](#usewindowscrollposition) - Returns a reactive object with current window scroll position. ## Installation diff --git a/packages/set/README.md b/packages/set/README.md index ee944de24..f7890e41b 100644 --- a/packages/set/README.md +++ b/packages/set/README.md @@ -11,8 +11,8 @@ The Javascript built-in `Set` & `WeakSet` data structures as a reactive signals. -- **[`ReactiveSet`](#ReactiveSet)** - A reactive version of a Javascript built-in `Set` class. -- **[`ReactiveWeakSet`](#ReactiveWeakSet)** - A reactive version of a Javascript built-in `WeakSet` class. +- **[`ReactiveSet`](#reactiveset)** - A reactive version of a Javascript built-in `Set` class. +- **[`ReactiveWeakSet`](#reactiveweakset)** - A reactive version of a Javascript built-in `WeakSet` class. ## Installation diff --git a/packages/share/README.md b/packages/share/README.md index 75574a25e..372445021 100644 --- a/packages/share/README.md +++ b/packages/share/README.md @@ -11,9 +11,9 @@ Primitives for supporting sharing of resources on social media and beyond. -- [`createSocialShare`](#createSocialShare) - A primitive for sharing on social media and beyond. -- [`makeWebShare`](#makeWebShare) - Generates a simple non-reactive WebShare primitive for sharing. -- [`createWebShare`](#createWebShare) - Creates a reactive status about web share. +- [`createSocialShare`](#createsocialshare) - A primitive for sharing on social media and beyond. +- [`makeWebShare`](#makewebshare) - Generates a simple non-reactive WebShare primitive for sharing. +- [`createWebShare`](#createwebshare) - Creates a reactive status about web share. ## Installation diff --git a/packages/static-store/README.md b/packages/static-store/README.md index 0f842cbe0..5e1dde026 100644 --- a/packages/static-store/README.md +++ b/packages/static-store/README.md @@ -11,8 +11,8 @@ Primitives for creating small reactive objects that doesn't change their shape over time - don't need a proxy wrapper. -- [`createStaticStore`](#createStaticStore) - Creates a writable static store object. -- [`createDerivedStaticStore`](#createDerivedStaticStore) - Creates a static store that is derived from a source function. +- [`createStaticStore`](#createstaticstore) - Creates a writable static store object. +- [`createDerivedStaticStore`](#createderivedstaticstore) - Creates a static store that is derived from a source function. ## Installation @@ -57,7 +57,7 @@ setSize("new-property", "value"); ## `createDerivedStaticStore` -A derived version of the [`createStaticStore`](#createStaticStore). It will use the update function to derive the value of the store. It will only update when the dependencies of the update function change. +A derived version of the [`createStaticStore`](#createstaticstore). It will use the update function to derive the value of the store. It will only update when the dependencies of the update function change. ### How to use it @@ -82,7 +82,7 @@ el.addEventListener("resize", () => { ## `createHydratableStaticStore` -A "hydratable" version of the [`createStaticStore`](#createStaticStore) - it will use the `serverValue` on the server and the `update` function on the client. If initialized during hydration it will use `serverValue` as the initial value and update it once hydration is complete. +A "hydratable" version of the [`createStaticStore`](#createstaticstore) - it will use the `serverValue` on the server and the `update` function on the client. If initialized during hydration it will use `serverValue` as the initial value and update it once hydration is complete. > **Warning** This primitive version is experimental, and mostly used internally by other primitives. It is not recommended to use it directly. diff --git a/packages/styles/README.md b/packages/styles/README.md index 944c6ec66..dbbbd32cf 100644 --- a/packages/styles/README.md +++ b/packages/styles/README.md @@ -11,7 +11,7 @@ Collection of reactive primitives focused on styles. -- [`createRemSize`](#createRemSize) - Create a reactive signal of css `rem` size in pixels. +- [`createRemSize`](#createremsize) - Create a reactive signal of css `rem` size in pixels. ## Installation @@ -46,7 +46,7 @@ createEffect(() => { This primitive provides a [singleton root](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSingletonRoot) variant that will reuse signals, HTML elements and the ResizeObserver instance across all dependents that use it. -It's behavior is the same as [`createRemSize`](#createRemSize). +It's behavior is the same as [`createRemSize`](#createremsize). ```ts import { useRemSize } from "@solid-primitives/styles"; diff --git a/packages/timer/README.md b/packages/timer/README.md index a6dcefd3e..279be2e53 100644 --- a/packages/timer/README.md +++ b/packages/timer/README.md @@ -11,11 +11,11 @@ Timer primitives related to [`setInterval`](https://developer.mozilla.org/en-US/docs/Web/API/setInterval) and [`setTimeout`](https://developer.mozilla.org/en-US/docs/Web/API/setTimeout): -- [`makeTimer`](#makeTimer) - Makes an automatically cleaned up timer. -- [`createTimer`](#createTimer) - [makeTimer](#maketimer), but with a fully reactive delay -- [`createTimeoutLoop`](#createTimeoutLoop) - Like createInterval, except the delay only updates between executions. -- [`createPolled`](#createPolled) - Polls a function periodically. Returns an to the latest polled value. -- [`createIntervalCounter`](#createIntervalCounter) - Creates a counter which increments periodically. +- [`makeTimer`](#maketimer) - Makes an automatically cleaned up timer. +- [`createTimer`](#createtimer) - [makeTimer](#maketimer), but with a fully reactive delay +- [`createTimeoutLoop`](#createtimeoutloop) - Like createInterval, except the delay only updates between executions. +- [`createPolled`](#createpolled) - Polls a function periodically. Returns an to the latest polled value. +- [`createIntervalCounter`](#createintervalcounter) - Creates a counter which increments periodically. ## Installation diff --git a/packages/transition-group/README.md b/packages/transition-group/README.md index 7c675885c..d3eb17a86 100644 --- a/packages/transition-group/README.md +++ b/packages/transition-group/README.md @@ -11,8 +11,8 @@ Provides reactive primitives for implementing transition effects on a group of elements, or your own `` and `` components. -- [`createSwitchTransition`](#createSwitchTransition) - Create an element transition interface for switching between single elements. -- [`createListTransition`](#createListTransition) - Create an element list transition interface for changes to the list of elements. +- [`createSwitchTransition`](#createswitchtransition) - Create an element transition interface for switching between single elements. +- [`createListTransition`](#createlisttransition) - Create an element list transition interface for changes to the list of elements. ## Installation diff --git a/packages/trigger/README.md b/packages/trigger/README.md index 4d6b80df0..ca2227f15 100644 --- a/packages/trigger/README.md +++ b/packages/trigger/README.md @@ -11,8 +11,8 @@ A set of primitives based on Solid signals, used to trigger computations. -- [`createTrigger`](#createTrigger) - Set listeners in reactive computations and then trigger them when you want. -- [`createTriggerCache`](#createTriggerCache) - Creates a cache of triggers that can be used to mark dirty only specific keys. +- [`createTrigger`](#createtrigger) - Set listeners in reactive computations and then trigger them when you want. +- [`createTriggerCache`](#createtriggercache) - Creates a cache of triggers that can be used to mark dirty only specific keys. ## Installation diff --git a/site/scripts/generate.ts b/site/scripts/generate.ts index 004feaa69..8e521276d 100644 --- a/site/scripts/generate.ts +++ b/site/scripts/generate.ts @@ -138,7 +138,7 @@ async function generatePrimitiveSizes(module: ModuleData) { const sizes = module.primitives.map(async primitive => { const result = await getPackageBundlesize(module.name, { exportName: primitive, - peerDependencies: module.peerDependencies, + peerDependencies: module.peer_deps, }); if (!result) return null; return { @@ -153,7 +153,7 @@ async function generatePrimitiveSizes(module: ModuleData) { async function generatePackageSize(module: ModuleData) { const result = await getPackageBundlesize(module.name, { - peerDependencies: module.peerDependencies, + peerDependencies: module.peer_deps, }); if (!result) return null; return { @@ -229,3 +229,4 @@ async function generatePackageSize(module: ModuleData) { await fsp.writeFile(distPath, html); })(); +