postcss-clampwind 0.0.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,345 @@
+# clampwind
+
+A PostCSS plugin that transforms any two‑argument `clamp()` call into a fully fluid value, seamlessly integrating with Tailwind CSS utilities. Made for Tailwind v4.
+
+## How it works
+
+Instead of the standard three-value `clamp(min, preferred, max)`, you supply just a minimum and maximum:
+
+```html
+<div class="text-[clamp(16px,50px)]"></div>
+```
+
+This will generate the following CSS:
+
+```css
+.text-\[clamp\(16px\,50px\)\] {
+  font-size: clamp(1rem, calc(1rem + 0.0379 * (100vw - 40rem)), 3.125rem);
+}
+```
+
+The supplied values are used to generate the expression inside the `clamp()` function, where the fluid transformation is calculated using Tailwind's smallest and largest breakpoints.
+
+
+## Installation
+
+Install the plugin from npm:
+
+```sh
+npm install -D clampwind
+```
+
+### PostCSS setup
+
+Add the plugin to your `postcss.config.js` file:
+
+```js
+// postcss.config.mjs
+import tailwindcss from "@tailwindcss/postcss"
+import clampwind from "clampwind"
+
+export default {
+  plugins: [
+    tailwindcss(),
+    clampwind(),
+  ]
+}
+```
+
+#### CommonJS usage
+
+If you are using CommonJS-based build tools like Webpack, you will need to use the `require` syntax and add `.default` to the import.
+
+```js
+// postcss.config.js
+module.exports = { 
+  plugins: { 
+    require("@tailwindcss/postcss"),
+    require('clampwind').default
+  } 
+};
+```
+
+### Vite project setup
+
+If you are using Vite, you are probably using Tailwind with `@tailwindcss/vite`. You need to import the plugin and use it in your `postcss.config.js` file.
+
+```js
+// postcss.config.js
+import clampwind from 'clampwind';
+
+export default { 
+  plugins: [ 
+    clampwind()
+  ] 
+}; 
+```
+
+## Features
+
+### Interchangeable px / rem units
+
+Allow clamped values to use either px or rem interchangeably.
+
+```html
+<div class="text-[clamp(1rem,50px)]"></div>
+```
+
+### Use Tailwind breakpoint modifiers
+
+Use the native Tailwind syntax to clamp values within a specific range by using breakpoint modifiers.
+
+```html
+<div class="md:max-lg:text-[clamp(16px,50px)]"></div>
+```
+### Unitless clamping
+
+If no unit is specified, default to your theme’s `--spacing` scale.
+
+```html
+<div class="text-[clamp(16,50)]"></div>
+```
+
+### Use Tailwind size variables
+
+Clamp using Tailwind’s predefined size tokens.
+
+```html
+<div class="text-[clamp(var(--text-sm),50px)]"></div>
+```
+
+### Use CSS custom properties
+
+Clamp using CSS custom properties.
+
+```html
+<div class="text-[clamp(var(--custom-value),50px)]"></div>
+```
+
+### Container query support
+
+Clamp values based on container query breakpoints.
+
+```html
+<div class="@md:text-[clamp(16px,50px)]"></div>
+```
+
+### Decreasing and negative ranges
+
+Support clamped ranges that shrink or go below zero.
+
+```html
+<div class="text-[clamp(50px,16px)]"></div>
+```
+
+### Error reporting via CSS comments
+
+Output validation errors as CSS comments for easy debugging.
+
+```css
+.text-\[clamp\(16%\,50px\)\] {
+  font-size: clamp(16%,50px); /* Invalid clamp() values */
+}
+```
+
+
+## Usage
+
+To use this plugin you need to use the `clamp()` function but with **only two arguments**, the first one is the minimum value and the second one is the maximum value.
+
+### Clamp between smallest and largest breakpoint
+
+Write the Tailwind utility you want to make fluid, without any breakpoint modifier, for example:
+
+```html
+<div class="text-[clamp(16px,50px)]"></div>
+```
+
+This will use Tailwind default largest and smallest breakpoint.
+
+```css
+.text-\[clamp\(16px\,50px\)\] {
+  font-size: clamp(1rem, calc(...) , 3.125rem);
+}
+```
+
+### Clamp between two breakpoints
+
+Simply add regular Tailwind breakpoint modifiers to the utility, for example:
+
+```html
+<div class="md:max-lg:text-[clamp(16px,50px)]"></div>
+```
+
+To clamp the CSS property between the two breakpoints you need to use the `max-` modifier, in this case the CSS property will be clamped between the `md` and `lg` breakpoints.
+
+This will generate the following css:
+
+```css
+.md\:max-lg\:text-\[clamp\(16px\,50px\)\] {
+  @media (width >= 48rem) { /* >= 768px */
+    @media (width < 64rem) { /* < 1024px */
+      font-size: clamp(1rem, calc(...), 3.125rem);
+    }
+  }
+}
+```
+
+### Clamp from one breakpoint
+
+If you want to define a clamp value from a single breakpoint, clampwind will automatically generate the calculation from the defined breakpoint to the smallest or largest breakpoint depending on the direction, for example:
+
+```html
+<div class="md:text-[clamp(16px,50px)]"></div>
+```
+
+This will generate the following css:
+
+```css
+.md\:text-\[clamp\(16px\,50px\)\] {
+    @media (width >= 48rem) {  /* >= 768px */
+      font-size: clamp(1rem, calc(...), 3.125rem);
+    }
+  }
+```
+Or if you use the `max-` modifier:
+
+```css
+.max-md\:text-\[clamp\(16px\,50px\)\] {
+    @media (width < 48rem) { /* < 768px */
+      font-size: clamp(1rem, calc(...), 3.125rem);
+    }
+  }
+```
+
+### Clamp between custom breakpoints
+
+With Tailwind v4 it's really easy to use one-time custom breakpoints, and this plugin will automatically detect them and use them to clamp the CSS property.
+
+```html
+<div class="min-[1000px]:max-xl:text-[clamp(16px,50px)]"></div>
+```
+
+This will generate the following css:
+
+```css
+.min-\[1000px\]\:max-xl\:text-\[clamp\(16px\,50px\)\] {
+  @media (width >= 1000px) { /* >= 1000px */
+    @media (width < 64rem) { /* < 1600px */
+      font-size: clamp(1rem, calc(...), 3.125rem);
+    }
+  }
+}
+```
+
+### Clamp between Tailwind spacing scale values
+
+A quick way to define two clamped values is to use the Tailwind spacing scale values, for example:
+
+```html
+<div class="text-[clamp(16,50)]"></div>
+```
+
+The bare values size depends on the theme `--spacing` size, so if you have have it set to `1px` it will generate the following css:
+
+```css
+.text-\[clamp\(16\,50\)\] {
+  font-size: clamp(1rem, calc(...), 3.125rem);
+}
+```
+
+### Clamp custom properties values
+
+You can also use custom properties in your clamped values, for example like this:
+
+```html
+<div class="text-[clamp(var(--text-sm),50px)]"></div>
+```
+or like this:
+
+```html
+<div class="text-[clamp(--text-sm,--text-lg)]"></div>
+```
+
+But this won't work when using two custom properties directly in the CSS with `@apply`, so you need to use the `var()` function instead.
+
+```css
+.h2 {
+  @apply text-[clamp(var(--text-sm),var(--text-lg))];
+}
+```
+
+
+
+### Clamp container queries
+
+Clampwind supports container queries, just by using the normal Tailwind container query syntax, for example:
+
+```html
+<div class="@md:text-[clamp(16px,50px)]"></div>
+```
+
+This will generate the following css:
+
+```css
+.@md\:text-\[clamp\(16px\,50px\)\] {
+  @container (width >= 28rem) { /* >= 448px */
+    font-size: clamp(1rem, calc(...), 3.125rem);
+  }
+}
+```
+
+## Configuration
+
+Tailwind v4 introduced the new CSS-based configuration and clampwind embraces it.
+
+### Add custom breakpoints
+
+To add new breakpoints in Tailwind v4 you normally define them inside the `@theme` directive.
+
+But Tailwind by default, will not output in your CSS any custom properties that are not referenced in your CSS, for this reason you should use the `@theme static` directive instead of `@theme` to create custom breakpoints.
+
+```css
+@theme static {
+  --breakpoint-4xl: 1600px;
+}
+```
+
+### Use custom properties
+
+You can use any custom properties in your clamped values, for example:
+
+```html
+<div class="text-[clamp(--custom-value,50px)]"></div>
+```
+
+You just need to make sure that the custom property is defined in your `:root` selector.
+
+```css
+:root {
+  --custom-value: 16px;
+}
+```
+
+### Pixel to rem conversion
+
+If you are using pixel values in your clamped values, clampwind will automatically convert them to rem. For the conversion it scans your generated css and if you have set pixel values for the root `font-size` or for your `--text-base` custom property in your `:root` selector, it will use that value to convert the pixel values to rem values. If you haven't set a font-size in your `:root` selector, it will use the default value of 16px.
+
+```css
+:root {
+  font-size: 18px; /* 18px = 1.125rem */
+}
+```
+or like this:
+
+```css
+:root {
+  --text-base: 18px; /* 18px = 1.125rem */
+}
+```
+
+## License and Credits
+
+This project is licensed under the [Apache-2.0 license](https://apache.org/licenses/LICENSE-2.0).
+
+Copyright © 2025 Daniele De Pietri.