Skip to content

Commit

Permalink
feat(preact): add Preact support (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
ascorbic authored Feb 21, 2023
1 parent 61b67e7 commit 79cd706
Show file tree
Hide file tree
Showing 21 changed files with 15,065 additions and 5,294 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A cross-framework component for responsive, high-performance images using image CDNs.

[`@unpic/react`](https://github.com/ascorbic/unpic-img/tree/main/packages/react)[`@unpic/vue`](https://github.com/ascorbic/unpic-img/tree/main/packages/vue)[`@unpic/solid`](https://github.com/ascorbic/unpic-img/tree/main/packages/solid)[`@unpic/svelte`](https://github.com/ascorbic/unpic-img/tree/main/packages/svelte)[`@unpic/astro`](https://github.com/ascorbic/unpic-img/tree/main/packages/astro)
[`@unpic/react`](https://github.com/ascorbic/unpic-img/tree/main/packages/react)[`@unpic/vue`](https://github.com/ascorbic/unpic-img/tree/main/packages/vue)[`@unpic/solid`](https://github.com/ascorbic/unpic-img/tree/main/packages/solid)[`@unpic/svelte`](https://github.com/ascorbic/unpic-img/tree/main/packages/svelte)[`@unpic/astro`](https://github.com/ascorbic/unpic-img/tree/main/packages/astro)[`@unpic/preact`](https://github.com/ascorbic/unpic-img/tree/main/packages/preact)

## Features

Expand All @@ -17,8 +17,6 @@ A cross-framework component for responsive, high-performance images using image
- Uses [unpic](https://github.com/ascorbic/unpic) to support most image CDNs, including Cloudinary, Imgix, and Shopify.
- Can generate a low-res background image for a blurred placeholder effect.

This library is a work in progress. It currently supports React, Vue and SolidJS.

## Usage

For details of usage, see the individual framework packages:
Expand All @@ -28,6 +26,7 @@ For details of usage, see the individual framework packages:
- [`@unpic/solid`](https://github.com/ascorbic/unpic-img/tree/main/packages/solid)
- [`@unpic/svelte`](https://github.com/ascorbic/unpic-img/tree/main/packages/svelte)
- [`@unpic/astro`](https://github.com/ascorbic/unpic-img/tree/main/packages/astro)
- [`@unpic/preact`](https://github.com/ascorbic/unpic-img/tree/main/packages/preact)

## FAQ

Expand Down
3 changes: 3 additions & 0 deletions examples/preact/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
/build
/*.log
25 changes: 25 additions & 0 deletions examples/preact/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"private": true,
"name": "preact-demo",
"license": "MIT",
"scripts": {
"build": "preact build",
"serve": "sirv build --port 8080 --cors --single",
"dev": "preact watch"
},
"eslintConfig": {
"extends": "preact"
},
"eslintIgnore": [
"build/*"
],
"devDependencies": {
"preact-cli": "^3.0.0",
"sirv-cli": "^1.0.3"
},
"dependencies": {
"@unpic/preact": "workspace:^",
"preact": "^10.1.0",
"preact-render-to-string": "^5.1.2"
}
}
1 change: 1 addition & 0 deletions examples/preact/size-plugin.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"timestamp":1677008993909,"files":[{"filename":"bundle.*****.esm.js","previous":9734,"size":9723,"diff":-11},{"filename":"polyfills.*****.esm.js","previous":2317,"size":2317,"diff":0},{"filename":"sw-esm.js","previous":11114,"size":11113,"diff":-1},{"filename":"sw.js","previous":11109,"size":11108,"diff":-1},{"filename":"bundle.bffa0.js","previous":10889,"size":0,"diff":-10889},{"filename":"polyfills.2748d.js","previous":2418,"size":2418,"diff":0},{"filename":"index.html","previous":423,"size":1127,"diff":704},{"filename":"200.html","previous":429,"size":429,"diff":0},{"filename":"bundle.e87c0.js","previous":0,"size":10877,"diff":10877}]},{"timestamp":1677008937240,"files":[{"filename":"ssr-build/ssr-bundle.js","previous":11438,"size":0,"diff":-11438},{"filename":"bundle.*****.esm.js","previous":0,"size":9734,"diff":9734},{"filename":"polyfills.*****.esm.js","previous":0,"size":2317,"diff":2317},{"filename":"sw-esm.js","previous":0,"size":11114,"diff":11114},{"filename":"sw.js","previous":0,"size":11109,"diff":11109},{"filename":"bundle.bffa0.js","previous":0,"size":10889,"diff":10889},{"filename":"polyfills.2748d.js","previous":0,"size":2418,"diff":2418},{"filename":"index.html","previous":0,"size":423,"diff":423},{"filename":"200.html","previous":0,"size":429,"diff":429}]}]
Binary file added examples/preact/src/assets/favicon.ico
Binary file not shown.
Binary file added examples/preact/src/assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions examples/preact/src/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import { Image } from "@unpic/preact";

export default function App() {
return (
<div>
<Image
src="https://images.unsplash.com/photo-1674255909399-9bcb2cab6489?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=996&q=80"
layout="fullWidth"
alt=""
priority
height={400}
background="auto"
/>
<Image
src="https://cdn.shopify.com/static/sample-images/bath_grande_crop_center.jpeg"
layout="constrained"
width={800}
height={600}
alt="Shopify"
/>
<Image
src="https://bunnyoptimizerdemo.b-cdn.net/bunny7.jpg?width=300"
width={400}
height={300}
layout="fixed"
alt="Bunny.net"
/>
</div>
);
}
16 changes: 16 additions & 0 deletions examples/preact/src/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"name": "preact-demo",
"short_name": "preact-demo",
"start_url": "/",
"display": "standalone",
"orientation": "portrait",
"background_color": "#fff",
"theme_color": "#673ab8",
"icons": [
{
"src": "/assets/icon.png",
"type": "image/png",
"sizes": "512x512"
}
]
}
8 changes: 8 additions & 0 deletions examples/preact/src/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
html, body {
font: 14px/1.21 'Helvetica Neue', arial, sans-serif;
font-weight: 400;
}

h1 {
text-align: center;
}
4 changes: 4 additions & 0 deletions examples/preact/src/sw.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import { getFiles, setupPrecaching, setupRouting } from 'preact-cli/sw/';

setupRouting();
setupPrecaching(getFiles());
15 changes: 15 additions & 0 deletions examples/preact/src/template.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title><% preact.title %></title>
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-capable" content="yes">
<link rel="apple-touch-icon" href="<%= htmlWebpackPlugin.files.publicPath %>assets/icons/apple-touch-icon.png">
<% preact.headEnd %>
</head>
<body>
<% preact.bodyEnd %>
</body>
</html>
89 changes: 89 additions & 0 deletions examples/preact/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
"target": "ESNext", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
"jsx": "react-jsx", /* Specify what JSX code is generated. */
"jsxImportSource": "preact",
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "React.createElement", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "React.Fragment", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "react", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "ESNext", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
"moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true, /* Skip type checking all .d.ts files. */
"types": []
}
}
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"license": "MIT",
"scripts": {
"build:demo": "yarn workspaces foreach -ptvR --from react-demo run build",
"build:packages": "yarn workspaces foreach -ptvR --from '{@unpic/solid,@unpic/react,@unpic/vue,@unpic/svelte}' run build",
"build:packages": "yarn workspaces foreach -ptvR --from '{@unpic/solid,@unpic/react,@unpic/vue,@unpic/svelte,@unpic/preact}' run build",
"publish": "yarn workspaces foreach --include '@unpic/*' npm publish --tolerate-republish --access public"
},
"dependencies": {
Expand All @@ -23,4 +23,4 @@
"packages/*",
"examples/*"
]
}
}
21 changes: 21 additions & 0 deletions packages/preact/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Matt Kane

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.
40 changes: 40 additions & 0 deletions packages/preact/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# `@unpic/preact` 🖼 📐

Preact component for responsive, high-performance images.

## Features

- Just an `<img>` tag! No extra elements, no runtime JavaScript. Easy to style.
- Automatically generates correct srcset and sizes attributes for responsive images
- Handles responsive resizing of images, preserving aspect ratio
- Uses native lazy loading and aync decoding for offscreen images
- Handles different image layouts: fixed, constrained and full width
- Uses eager loading and high priority fetching for important images
- Delivers modern image formats, including WebP and AVIF if supported by your browser
- No built step or server-side rendering required: uses your existing image CDN or CMS, with no additional configuration
- Uses [unpic](https://github.com/ascorbic/unpic) to support most image CDNs, including Cloudinary, Imgix, and Shopify
- Can generate a low-res background image for a blurred placeholder effect

## Installation and usage

```bash
npm install @unpic/preact
```

```tsx
import { Image } from "@unpic/preact";

function MyComponent() {
return (
<Image
src="https://cdn.shopify.com/static/sample-images/bath_grande_crop_center.jpeg"
layout="constrained"
width={800}
height={600}
alt="A lovely bath"
/>
);
}
```

For the supported props, see [the main README](https://github.com/ascorbic/unpic-img/#props).
33 changes: 33 additions & 0 deletions packages/preact/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"name": "@unpic/preact",
"version": "0.0.0",
"files": [
"dist",
"src"
],
"main": "./dist/index.js",
"module": "./dist/index.mjs",
"types": "./dist/index.d.ts",
"exports": {
".": {
"types": "./dist/index.d.ts",
"require": "./dist/index.js",
"import": "./dist/index.mjs"
}
},
"scripts": {
"build": "tsup src/index.ts --format cjs,esm --dts --clean",
"prepublishOnly": "yarn build"
},
"devDependencies": {
"preact": "^10.12.1",
"tsup": "^6.6.0",
"typescript": "^4.9.5"
},
"dependencies": {
"@unpic/core": "workspace:^"
},
"peerDependencies": {
"preact": "*"
}
}
Loading

0 comments on commit 79cd706

Please sign in to comment.