Update README.md - #115
Merged
Merged
Conversation
Signed-off-by: Jonas Pfalzgraf <[email protected]>
|
Warning Review limit reached
More reviews will be available in 46 minutes and 22 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the README.md release highlight section to adjust the messaging around backward compatibility by adding an “unchanged APIs” statement and removing the separate 1.13.0 highlight block.
Changes:
- Appends “All 1.13.x and earlier APIs remain unchanged.” to the existing 1.14.0 highlight.
- Removes the “New in 1.13.0” highlight block.
- Removes an extra blank line before “## Highlights”.
| @@ -18,8 +18,6 @@ | |||
|
|
|||
| > **New in 1.14.0:** `@bquery/bquery/media`, `@bquery/bquery/plugin`, `@bquery/bquery/devtools`, and `@bquery/bquery/testing` all graduate into the batteries-included tier. Media ships 25+ new reactive composables — preference signals (`usePreferredColorScheme`, `usePreferredContrast`, `usePreferredReducedTransparency`, `usePreferredLanguage`/`usePreferredLanguages`), page state (`useOnlineStatus`, `usePageVisibility`, `useDocumentFocus`, `useWindowFocus`, `useIdle`), element observers (`useElementSize`, `useElementBounding`, `useElementVisibility`, `useHover`, `useFocus`, `useFocusWithin`, `useActiveElement`), pointer/scroll (`usePointer`, `useScroll`), platform integrations (`usePermission`, `useWakeLock`, `useShare`/`useShareSupported`, `useBroadcastChannel`, `useEventListener`, `useMediaDevices`, `useStorage`), and clipboard upgrades (`clipboard.isSupported`/`clipboard.isImageSupported`/`clipboard.readImage()`/`clipboard.writeImage()`/`clipboardText()`) — every composable accepts an optional `{ signal: AbortSignal }` for auto-teardown. Plugin gains a hook bus (`addFilter`/`applyFilters`, `addAction`/`doAction`), container DI (`createInjectionKey`/`provide`/`inject`), `unuse`/`uninstall` lifecycle, async install, plugin metadata + dependencies (`getPluginInfo`, `getInstalledPlugins`), and namespaced directives with `{ mounted, unmounted }`. Devtools adds a ring-buffered timeline (`maxTimelineEntries`, default 1000) with richer `TimelineEntry`, `filterTimeline`/`subscribeTimeline`, privacy-aware `inspectSignals`, structural `diffSignals`/`diffStores`, `traceSignal`/`untraceSignal`, `inspectEffects`, snapshot import/export, `installBrowserBridge()`, and perf helpers `time`/`measureRender`/`getPerformanceSummary`. Testing adds auto cleanup, `fireEvent.*` shortcuts, a `userEvent` namespace, shadow-DOM-aware `screen`/`within` queries, reactive harnesses (`mockComputed`/`mockEffect`/`tick`/`flushPromises`), module mocks (`mockStore`/`mockI18n`/`mockForm`/`mockFetch`/`mockWebSocket`), and a11y helpers (`prettyDOM`/`getReactiveSummary`/`expectAccessible`). Additive 1.14.0 expansions also land across `router` (`NavigationResult`, `pushResult`/`replaceResult`, `beforeResolve`, `resolveRoute`, dynamic `addRoute`/`removeRoute`/`hasRoute`, `isReady`, `lastNavigation`, `useNavigation`), `view` (`parseDirective`, new `bq-once`/`bq-init`/`bq-pre`/`bq-cloak`/`bq-html-safe`/`bq-memo`, full `bq-on` modifier system), `a11y` (`createLiveRegion`, `keyboardUserSignal`, `focusVisible`, `prefersReducedTransparency`/`prefersReducedData`/`forcedColors`, `inert`/`scrollLock`/`autoFocus`), `i18n` (`negotiateLocale`, `detectLocale`, `isRTL`, `formatRelativeTime`/`formatList`/`formatDisplayName`/`segment`), `dnd` (programmatic handles, `grid`/`delay`/`touchStartThreshold`/`keyboard`/`keyboardStep`, `'viewport'` bounds, reactive `useDraggable`/`useDroppable`/`useSortable`), `storybook` (`classMap`/`styleMap`/`ifDefined`/`repeat`/`storyText`/`unsafeHtml`/`storySvg`), `concurrency` (`withTransferables`, `createSharedBuffer`, RPC `maxInFlight`, pool priorities, `pause`/`resume`/`onIdle`, rolling reactive metrics), `ssr` (`flushBoundary`, `createSSRCache`, `createSSRMetrics`, `createEdgeHandler`, cache-aware `renderToResponse`, multi-chunk `renderToStream`), and `server` (`ServerHttpError`, `ctx.body`/`ctx.cookies`/`ctx.setCookie`/`ctx.accepts`/`ctx.stream`/`ctx.sse`/`ctx.renderStream`/`ctx.renderResponse`, `app.listen()`). All 1.13.x and earlier APIs remain unchanged. | |||
Comment on lines
19
to
21
| > **New in 1.14.0:** `@bquery/bquery/media`, `@bquery/bquery/plugin`, `@bquery/bquery/devtools`, and `@bquery/bquery/testing` all graduate into the batteries-included tier. Media ships 25+ new reactive composables — preference signals (`usePreferredColorScheme`, `usePreferredContrast`, `usePreferredReducedTransparency`, `usePreferredLanguage`/`usePreferredLanguages`), page state (`useOnlineStatus`, `usePageVisibility`, `useDocumentFocus`, `useWindowFocus`, `useIdle`), element observers (`useElementSize`, `useElementBounding`, `useElementVisibility`, `useHover`, `useFocus`, `useFocusWithin`, `useActiveElement`), pointer/scroll (`usePointer`, `useScroll`), platform integrations (`usePermission`, `useWakeLock`, `useShare`/`useShareSupported`, `useBroadcastChannel`, `useEventListener`, `useMediaDevices`, `useStorage`), and clipboard upgrades (`clipboard.isSupported`/`clipboard.isImageSupported`/`clipboard.readImage()`/`clipboard.writeImage()`/`clipboardText()`) — every composable accepts an optional `{ signal: AbortSignal }` for auto-teardown. Plugin gains a hook bus (`addFilter`/`applyFilters`, `addAction`/`doAction`), container DI (`createInjectionKey`/`provide`/`inject`), `unuse`/`uninstall` lifecycle, async install, plugin metadata + dependencies (`getPluginInfo`, `getInstalledPlugins`), and namespaced directives with `{ mounted, unmounted }`. Devtools adds a ring-buffered timeline (`maxTimelineEntries`, default 1000) with richer `TimelineEntry`, `filterTimeline`/`subscribeTimeline`, privacy-aware `inspectSignals`, structural `diffSignals`/`diffStores`, `traceSignal`/`untraceSignal`, `inspectEffects`, snapshot import/export, `installBrowserBridge()`, and perf helpers `time`/`measureRender`/`getPerformanceSummary`. Testing adds auto cleanup, `fireEvent.*` shortcuts, a `userEvent` namespace, shadow-DOM-aware `screen`/`within` queries, reactive harnesses (`mockComputed`/`mockEffect`/`tick`/`flushPromises`), module mocks (`mockStore`/`mockI18n`/`mockForm`/`mockFetch`/`mockWebSocket`), and a11y helpers (`prettyDOM`/`getReactiveSummary`/`expectAccessible`). Additive 1.14.0 expansions also land across `router` (`NavigationResult`, `pushResult`/`replaceResult`, `beforeResolve`, `resolveRoute`, dynamic `addRoute`/`removeRoute`/`hasRoute`, `isReady`, `lastNavigation`, `useNavigation`), `view` (`parseDirective`, new `bq-once`/`bq-init`/`bq-pre`/`bq-cloak`/`bq-html-safe`/`bq-memo`, full `bq-on` modifier system), `a11y` (`createLiveRegion`, `keyboardUserSignal`, `focusVisible`, `prefersReducedTransparency`/`prefersReducedData`/`forcedColors`, `inert`/`scrollLock`/`autoFocus`), `i18n` (`negotiateLocale`, `detectLocale`, `isRTL`, `formatRelativeTime`/`formatList`/`formatDisplayName`/`segment`), `dnd` (programmatic handles, `grid`/`delay`/`touchStartThreshold`/`keyboard`/`keyboardStep`, `'viewport'` bounds, reactive `useDraggable`/`useDroppable`/`useSortable`), `storybook` (`classMap`/`styleMap`/`ifDefined`/`repeat`/`storyText`/`unsafeHtml`/`storySvg`), `concurrency` (`withTransferables`, `createSharedBuffer`, RPC `maxInFlight`, pool priorities, `pause`/`resume`/`onIdle`, rolling reactive metrics), `ssr` (`flushBoundary`, `createSSRCache`, `createSSRMetrics`, `createEdgeHandler`, cache-aware `renderToResponse`, multi-chunk `renderToStream`), and `server` (`ServerHttpError`, `ctx.body`/`ctx.cookies`/`ctx.setCookie`/`ctx.accepts`/`ctx.stream`/`ctx.sse`/`ctx.renderStream`/`ctx.renderResponse`, `app.listen()`). All 1.13.x and earlier APIs remain unchanged. | ||
|
|
||
| > **New in 1.13.0:** `@bquery/bquery/forms` graduates into a true batteries-included tier with many new validators (`integer`, `between`, `oneOf`, `arrayOf`, `requiredIf`, `dateAfter`, `fileSize`, …), combinators (`compose`, `all`, `not`, `withMessage`), dynamic field arrays (`createFieldArray`), a fluent `schema()` builder, two-way DOM bindings (`bindForm`, `bindField`), scope-aware composables (`useForm`, `useField`, `useFieldArray`), and SSR resumability. `@bquery/bquery/component` adds slot/ref helpers (`useSlot`, `useRef`), DI (`provide`/`inject`), `beforeUnmount` and `errorBoundary` hooks, `useAsync`/`whenIdle`, sanitizer-safe delegated events (`on`/`onClick`/…), a `css` tagged template with adoptable stylesheets, and keyed list rendering. `@bquery/bquery/motion` ships a major expansion: the full Penner easing family with `cubicBezier`/`steps`/`mix`/`chain`, `tween()` with `pause`/`resume`/`reverse`/`seek`/`stop`/`progress` controls plus Promise-based `animateValue()`, `animateTo()`, `springVector()`, label-aware timelines (`reverse`, `repeat`, `yoyo`, `progress`, `onUpdate`), and new primitives `scrollProgress`/`inView`/`magnetic`/`tilt`/`shake`/`pulse`/`countUp`. `@bquery/bquery/core` adds a deep utilities expansion across arrays, functions, objects, strings, numbers, misc helpers, and type guards (`groupBy`, `memoize`, deep `get`/`set`, `formatBytes`, `uuid`, `retry`, …). All existing APIs from 1.12.x and earlier remain unchanged. | ||
|
|
||
| ## Highlights |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 pull request updates the
README.mdto clarify the release notes by explicitly stating that all existing APIs from version 1.12.x and earlier remain unchanged after the 1.13.0 release. This helps users understand backward compatibility when upgrading.