@css-hooks/preact 0.6.0 → 0.8.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Nick Saunders
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+<p align="center">
+  <a href="https://css-hooks.com/#gh-dark-mode-only" target="_blank">
+    <img alt="CSS Hooks" src="https://raw.githubusercontent.com/css-hooks/css-hooks/HEAD/.github/logo-dark.svg" width="310" height="64" style="max-width: 100%;">
+  </a>
+  <a href="https://css-hooks.com/#gh-light-mode-only" target="_blank">
+    <img alt="CSS Hooks" src="https://raw.githubusercontent.com/css-hooks/css-hooks/HEAD/.github/logo-light.svg" width="310" height="64" style="max-width: 100%;">
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/css-hooks/css-hooks/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/css-hooks/css-hooks/ci.yml?branch=master" alt="Build Status"></a>
+  <a href="https://github.com/css-hooks/css-hooks/releases"><img src="https://img.shields.io/npm/v/@css-hooks%2Fcore.svg" alt="Latest Release"></a>
+  <a href="https://github.com/css-hooks/css-hooks/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/css-hooks.svg" alt="License"></a>
+</p>
+
+---
+
+## Overview
+
+Hooks bring CSS features to native inline styles, enabling you to target various
+states such as hover, focus, and active, all without leaving the `style` prop.
+For example, hooks can easily solve the common use case of applying state-driven
+styles to a link:
+
+```jsx
+<a
+  href="https://css-hooks.com/"
+  style={hooks({
+    color: "#03f",
+    hover: {
+      color: "#09f",
+    },
+    active: {
+      color: "#e33",
+    },
+  })}
+>
+  Hooks
+</a>
+```
+
+Notably, the `hooks` function is pure. It simply returns a flat style object
+that is compatible with the `style` prop, creating dynamic property values that
+change under various conditions through CSS variables.
+
+## Documentation
+
+Please visit [css-hooks.com](https://css-hooks.com) to get started.
+
+## Packages
+
+- [@css-hooks/react](packages/react): React framework integration
+- [@css-hooks/solid](packages/solid): Solid framework integration
+- [@css-hooks/preact](packages/preact): Preact framework integration
+- [@css-hooks/core](packages/core): Core CSS Hooks package (internal use only)
+
+## Contributing
+
+Contributions are welcome. Please see the
+[contributing guidelines](CONTRIBUTING.md) for more information.
+
+## License
+
+CSS Hooks is offered under the [MIT license](LICENSE).

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@css-hooks/preact",
   "description": "CSS Hooks for Preact",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "author": "Nick Saunders",
   "dependencies": {
-    "@css-hooks/core": "^0.6.0"
+    "@css-hooks/core": "^0.8.0"
   },
   "devDependencies": {
     "@tsconfig/node-lts": "^18.12.3",

package/types/index.d.ts

@@ -25,5 +25,7 @@ export declare function stringifyValue(propertyName: string | number | symbol, v
  *
  * @returns The CSS required to enable the configured hooks, along with the corresponding `hooks` function for use in components.
  */
-export declare const createHooks: <HookProperties extends string | number | symbol>(config: Record<HookProperties, `@container ${string}` | `@media ${string}` | `:${string}` | `${string}&${string}`>) => readonly [string, (properties: import("@css-hooks/core").WithHooks<HookProperties, CSSProperties>) => CSSProperties];
+export declare const createHooks: <HookProperties extends string | number | symbol>(config: Record<HookProperties, `@container ${string}` | `@media ${string}` | `:${string}` | `${string}&${string}` | {
+    or: readonly ((`@container ${string}` | `@media ${string}` | `:${string}` | `${string}&${string}` | any) & string)[];
+}>) => readonly [string, (properties: import("@css-hooks/core").WithHooks<HookProperties, CSSProperties>) => CSSProperties];
 export { recommended };