UNPKG

@delicious-simplicity/next-image-contentful-loader

Version:

A comprehensive [Contentful](https://www.contentful.com/developers/docs/references/images-api) image loader for the [Next.js Image component](https://nextjs.org/docs/api-reference/next/image).

50 lines 2.5 kB
{ "name": "@delicious-simplicity/next-image-contentful-loader", "version": "1.0.4", "repository": "https://github.com/delicious-simplicity/next-image-contentful-loader.git", "author": "Devin Metivier <devinmetivier@gmail.com>", "contributors": [ "Devin Metivier <devin@delicious-simplicity.com>", "Delicious Simplicity <info@delicious-simplicity.com>" ], "license": "MIT", "keywords": [ "nextjs", "image", "contentful", "loader" ], "main": "cjs/index.js", "module": "esm/index.js", "types": "types/index.d.ts", "sideEffects": false, "files": [ "cjs", "esm", "types" ], "devDependencies": { "@delicious-simplicity/eslint-config": "^1.1.0", "@types/jest": "^29.0.3", "@types/node": "^17.0.23", "@vercel/ncc": "^0.34.0", "jest": "^29.0.3", "next": "^12.3.1", "react": "^18.2.0", "react-dom": "^18.2.0", "ts-jest": "^29.0.2", "typescript": "^4.8.3" }, "scripts": { "clean": "rm -rf esm/ && rm -rf cjs/ && rm -rf types/ && rm -rf dist/", "build": "pnpm build:esm && pnpm build:cjs && pnpm build:types", "build:watch": "tsc-watch -p ./tsconfig.json --onSuccess 'pnpm build'", "build:cjs": "ncc build src/index.ts -o cjs -m -e react", "build:esm": "tsc --target ESNext --module ES6 --outDir esm", "build:types": "tsc --d --declarationMap --declarationDir types", "lint": "eslint . --ext .js,.ts,.jsx,.tsx", "lint:fix": "eslint . --ext .js,.ts,.jsx,.tsx --fix", "test": "jest" }, "readme": "# @delicious-simplicity/next-image-contentful-loader\n\nA comprehensive [Contentful](https://www.contentful.com/developers/docs/references/images-api) image loader for the [Next.js Image component](https://nextjs.org/docs/api-reference/next/image).\n\n### Features\n\n- Allows for native Contentful image params/options\n- Similar error boundaries as `next/image`\n- Additional options for managing the aspect ratio of requested images\n\n### Usage\n\n```tsx\nimport Image from \"next/image\";\nimport { contentfulLoader } from \"@delicious-simplicity/next-image-contentful-loader\";\n\nconst Component = ({ image }) => {\n return (\n <>\n <Image\n loader={(props) => contentfulLoader(props, { fit: \"crop\", ar: \"1:1\" })}\n src={image.url}\n alt={image.title}\n width={image.width}\n height={image.height}\n />\n </>\n );\n};\n```\n\n### Required packages\n\n- [`next`](https://www.npmjs.com/package/next)\n" }