Change hash href attrs to be lowercase (fixes #544)

solidjs-community · Sep 12, 2024 · 198e110 · 198e110
1 parent 3548322
commit 198e110
Show file tree

Hide file tree

Showing 45 changed files with 151 additions and 149 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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 `<Key>` 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 `<Key>` 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>`](#Key) control flow.
+Reactively maps an array by specified key with a callback function - underlying helper for the [`<Key>`](#key) control flow.
 
 ### How to use it