opentui-responsive 0.2.8 → 0.3.0

package/README.md

@@ -41,7 +41,7 @@ Create the responsive provider in your layout, then use its hook directly in chi
 import { createResponsiveTui } from "opentui-responsive/solid";
 import type { ParentProps } from "solid-js";
 
-export const { ResponsiveTUI, useResponsiveTui } = createResponsiveTui({
+export const { ResponsiveTUI, useBreakpoint } = createResponsiveTui({
   // Required: each axis must include a 0 threshold.
   width: { narrow: 0, medium: 60, wide: 100 },
   height: { short: 0, medium: 16, tall: 28 },
@@ -55,10 +55,10 @@ export function Layout(props: ParentProps) {
 `src/content.tsx`
 
 ```tsx
-import { useResponsiveTui } from "./layout.tsx";
+import { useBreakpoint } from "./layout.tsx";
 
 export function Content() {
-  const breakpoint = useResponsiveTui();
+  const breakpoint = useBreakpoint();
   // You can use it to directly check [width, height] breakpoint
   const isWideAndTall = breakpoint(["wide", "tall"]);
 
@@ -87,7 +87,7 @@ export function App() {
 }
 ```
 
-`useResponsiveTui()` updates when the terminal crosses a configured threshold. Its accessor returns the current width and height names, or accepts an exact `[width, height]` pair and returns whether both axes match.
+`useBreakpoint()` updates when the terminal crosses a configured threshold. Its accessor returns the current width and height names, or accepts an exact `[width, height]` pair and returns whether both axes match.
 
 Run `bun run demo` from the package directory to try the Solid example. Resize the terminal to see its layout respond.
 
@@ -97,14 +97,14 @@ The React adapter has the same factory, provider, hook, and inferred breakpoint
 
 ### `opentui-responsive/solid` and `opentui-responsive/react`
 
-| API                               | Description                                                                              |
-| --------------------------------- | ---------------------------------------------------------------------------------------- |
-| `createResponsiveTui(scales)`     | Validates the scales and creates a `ResponsiveTUI` provider and `useResponsiveTui` hook. |
-| `ResponsiveTUI`                   | Tracks terminal dimensions and provides the current breakpoint accessor.                 |
-| `useResponsiveTui()`              | Reads the accessor from the nearest generated provider.                                  |
-| `ResponsiveBreakpointAccessor`    | Reads the current match or tests an exact breakpoint pair.                               |
-| `ResponsiveTuiConfigurationError` | Thrown when the supplied breakpoint scales are invalid.                                  |
-| `ResponsiveTuiProviderError`      | Thrown when the generated hook is called outside its provider.                           |
+| API                               | Description                                                                           |
+| --------------------------------- | ------------------------------------------------------------------------------------- |
+| `createResponsiveTui(scales)`     | Validates the scales and creates a `ResponsiveTUI` provider and `useBreakpoint` hook. |
+| `ResponsiveTUI`                   | Tracks terminal dimensions and provides the current breakpoint accessor.              |
+| `useBreakpoint()`                 | Reads the accessor from the nearest generated provider.                               |
+| `ResponsiveBreakpointAccessor`    | Reads the current match or tests an exact breakpoint pair.                            |
+| `ResponsiveTuiConfigurationError` | Thrown when the supplied breakpoint scales are invalid.                               |
+| `ResponsiveTuiProviderError`      | Thrown when the generated hook is called outside its provider.                        |
 
 ### `opentui-responsive/core`
 

package/dist/react/index.d.ts

@@ -14,5 +14,5 @@ export declare class ResponsiveTuiProviderError extends Error {
 /** Creates a React provider and hook bound to one breakpoint definition. */
 export declare const createResponsiveTui: <const Scales extends BreakpointScales>(scales: Parameters<typeof createBreakpointDefinition<Scales>>[0]) => {
     ResponsiveTUI: (props: PropsWithChildren) => import("react").FunctionComponentElement<import("react").ProviderProps<ResponsiveBreakpointAccessor<Scales> | undefined>>;
-    useResponsiveTui: () => ResponsiveBreakpointAccessor<Scales>;
+    useBreakpoint: () => ResponsiveBreakpointAccessor<Scales>;
 };

package/dist/react/index.js

@@ -82,7 +82,7 @@ var isThreshold = (value) => typeof value === "number" && Number.isFinite(value)
 class ResponsiveTuiProviderError extends Error {
   _tag = "ResponsiveTuiProviderError";
   constructor() {
-    super("useResponsiveTui must be used within a ResponsiveTUI");
+    super("useBreakpoint must be used within a ResponsiveTUI");
     this.name = this._tag;
   }
 }
@@ -94,14 +94,14 @@ var createResponsiveTui = (scales) => {
     const breakpoint = (pair) => pair ? breakpoints.matches(dimensions, pair) : breakpoints.match(dimensions);
     return createElement(ResponsiveTuiContext.Provider, { value: breakpoint }, props.children);
   };
-  const useResponsiveTui = () => {
+  const useBreakpoint = () => {
     const breakpoint = useContext(ResponsiveTuiContext);
     if (!breakpoint) {
       throw new ResponsiveTuiProviderError;
     }
     return breakpoint;
   };
-  return { ResponsiveTUI, useResponsiveTui };
+  return { ResponsiveTUI, useBreakpoint };
 };
 export {
   ResponsiveTuiConfigurationError,

package/dist/solid/index.d.ts

@@ -14,5 +14,5 @@ export declare class ResponsiveTuiProviderError extends Error {
 /** Creates a Solid provider and hook bound to one breakpoint definition. */
 export declare const createResponsiveTui: <const Scales extends BreakpointScales>(scales: Parameters<typeof createBreakpointDefinition<Scales>>[0]) => {
     ResponsiveTUI: (props: ParentProps) => any;
-    useResponsiveTui: () => ResponsiveBreakpointAccessor<Scales>;
+    useBreakpoint: () => ResponsiveBreakpointAccessor<Scales>;
 };

package/dist/solid/index.js

@@ -82,7 +82,7 @@ var isThreshold = (value) => typeof value === "number" && Number.isFinite(value)
 class ResponsiveTuiProviderError extends Error {
   _tag = "ResponsiveTuiProviderError";
   constructor() {
-    super("useResponsiveTui must be used within a ResponsiveTUI");
+    super("useBreakpoint must be used within a ResponsiveTUI");
     this.name = this._tag;
   }
 }
@@ -100,14 +100,14 @@ var createResponsiveTui = (scales) => {
       value: breakpoint
     });
   };
-  const useResponsiveTui = () => {
+  const useBreakpoint = () => {
     const breakpoint = useContext(ResponsiveTuiContext);
     if (!breakpoint) {
       throw new ResponsiveTuiProviderError;
     }
     return breakpoint;
   };
-  return { ResponsiveTUI, useResponsiveTui };
+  return { ResponsiveTUI, useBreakpoint };
 };
 export {
   ResponsiveTuiConfigurationError,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opentui-responsive",
-  "version": "0.2.8",
+  "version": "0.3.0",
   "description": "Typed responsive breakpoints for OpenTUI.",
   "keywords": [
     "breakpoints",