From 54676f4f2684c8a6a85fb3cb35ebdee8d44db1fe Mon Sep 17 00:00:00 2001 From: Juergen Kunz Date: Wed, 11 Mar 2026 08:28:16 +0000 Subject: [PATCH] fix(breakpoints): rename exported functions to reflect constraint-based API: cssForCustom -> cssForConstraint and cssForCustomContainer -> cssForConstraintContainer; update README usage --- changelog.md | 9 +++++++++ readme.md | 4 ++-- ts/00_commitinfo_data.ts | 2 +- ts/domtools.css.breakpoints.ts | 6 +++--- 4 files changed, 15 insertions(+), 6 deletions(-) diff --git a/changelog.md b/changelog.md index 1a36ee3..2b137fd 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,14 @@ # Changelog +## 2026-03-11 - 2.5.1 - fix(breakpoints) +rename exported functions to reflect constraint-based API: cssForCustom -> cssForConstraint and cssForCustomContainer -> cssForConstraintContainer; update README usage + +- Renamed cssForCustom to cssForConstraint +- Renamed cssForCustomContainer to cssForConstraintContainer +- Updated README examples to use new names +- Function behavior and signatures unchanged; only exported names and internal comment updated +- Consumers must update imports/usages to the new function names (breaking change) + ## 2026-03-11 - 2.5.0 - feat(breakpoints) document preset viewport helpers, low-level container helpers, and exported types for breakpoints diff --git a/readme.md b/readme.md index c5e132f..bd5202c 100644 --- a/readme.md +++ b/readme.md @@ -125,7 +125,7 @@ import { breakpoints } from '@design.estate/dees-domtools'; import { css as litCss } from 'lit'; // Viewport-level with custom constraints (emits @media + @container wccToolsViewport) -breakpoints.cssForCustom({ maxWidth: 800 })(litCss`.box { padding: 8px; }`) +breakpoints.cssForConstraint({ maxWidth: 800 })(litCss`.box { padding: 8px; }`) // Component-level — targets a named container (no @media fallback) breakpoints.cssForContainer( @@ -135,7 +135,7 @@ breakpoints.cssForContainer( ) // Component-level with custom constraints (curried) -breakpoints.cssForCustomContainer({ maxWidth: 500 }, 'my-component')(litCss` +breakpoints.cssForConstraintContainer({ maxWidth: 500 }, 'my-component')(litCss` .grid { gap: 8px; } `) diff --git a/ts/00_commitinfo_data.ts b/ts/00_commitinfo_data.ts index 35838d9..cb56509 100644 --- a/ts/00_commitinfo_data.ts +++ b/ts/00_commitinfo_data.ts @@ -3,6 +3,6 @@ */ export const commitinfo = { name: '@design.estate/dees-domtools', - version: '2.5.0', + version: '2.5.1', description: 'A package providing tools to simplify complex CSS structures and web development tasks, featuring TypeScript support and integration with various web technologies.' } diff --git a/ts/domtools.css.breakpoints.ts b/ts/domtools.css.breakpoints.ts index 656c35e..2eb4e3c 100644 --- a/ts/domtools.css.breakpoints.ts +++ b/ts/domtools.css.breakpoints.ts @@ -54,13 +54,13 @@ export const cssForContainer = (cssArg: CSSResult, condition: string, containerN }; // --------------------------------------------------------------------------- -// Custom constraints (curried) +// Constraint-based (curried) // --------------------------------------------------------------------------- -export const cssForCustom = (constraints: ICssForConstraints) => +export const cssForConstraint = (constraints: ICssForConstraints) => (cssArg: CSSResult) => cssForViewport(cssArg, buildCondition(constraints)); -export const cssForCustomContainer = (constraints: ICssForConstraints, containerName: string) => +export const cssForConstraintContainer = (constraints: ICssForConstraints, containerName: string) => (cssArg: CSSResult) => cssForContainer(cssArg, buildCondition(constraints), containerName); // ---------------------------------------------------------------------------