Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imgix/contentful
Browse, search, and add assets into your content quickly and easily via the imgix Asset Manager.
https://github.com/imgix/contentful
contentful imgix react
Last synced: 4 months ago
JSON representation
Browse, search, and add assets into your content quickly and easily via the imgix Asset Manager.
- Host: GitHub
- URL: https://github.com/imgix/contentful
- Owner: imgix
- License: bsd-2-clause
- Created: 2020-10-28T05:51:52.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T15:52:32.000Z (10 months ago)
- Last Synced: 2024-04-13T22:20:31.200Z (10 months ago)
- Topics: contentful, imgix, react
- Language: TypeScript
- Homepage:
- Size: 5.92 MB
- Stars: 10
- Watchers: 8
- Forks: 5
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE-OF-CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
A Contentful app that integrates with imgix's [Asset Manager](https://docs.imgix.com/setup/asset-manager). Browse, search, and insert assets into your content quickly and easily. Simplify your content editing workflow within Contentful and empower your developers with imgix’s powerful image rendering and optimization service.
[](https://www.npmjs.com/package/@imgix/contentful)
[](https://circleci.com/gh/imgix/contentful)
[](https://www.npmjs.com/package/@imgix/contentful)
[](https://github.com/imgix/contentful/blob/main/LICENSE.md)
[](https://github.com/prettier/prettier)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fimgix%2Fcontentful?ref=badge_shield)
---
- [Installation](#installation)
- [Configuration](#configuration)
- [Assign to Fields (Optional)](#assign-to-fields-optional)
- [Add to Content Model](#add-to-content-model)
- [Browse and Select Assets](#browse-and-select-assets)
- [Search for Assets](#search-for-assets)
- [Upload Assets](#upload-assets)
- [Query an Asset](#query-an-asset)
- [Transforming Assets](#transforming-assets)
- [Metadata](#metadata)
- [License](#license)
## Installation
The app can be installed to your Contentful workspace via the [marketplace](https://www.contentful.com/marketplace/app/imgix/).
If running locally, the app can be installed via npm:
```bash
npm install @imgix/contentful
npm run start
```
## Configuration
Upon installation, configure the app using an API key generated via the imgix [Dashboard](https://dashboard.imgix.com/api-keys). **Ensure that the generated key has the following permissions: `Sources` and `Asset Manager Browse`.**
> [!TIP]
> You can also optionally configure a default Source ID for the app to use. When configured, you'll have to click the Sources dropdown to select an asset from a different source.
Following the instructions on the screen, enter in the API key and press `Verify`. If the key is valid, you will receive a notification that the key has been successfully verified. If verification fails, you will need to ensure that the key was entered correctly.
https://user-images.githubusercontent.com/15919091/137049820-8ffc4bfd-43f1-41d2-b078-068ddaaa0c86.mp4
### Compatibility
This Contentful app is **not compatible with Web Proxy Sources**. Uploading functionality is **not compatible** with Web Folder sources. [See the imgix documentation](https://docs.imgix.com/setup/creating-sources) for a list of Sources that you can create in imgix.
### Assign to Fields (Optional)
The configuration page surfaces the option for users to select pre-existing content fields that are compatible with the imgix app. Note that the app is configured to integrate with `JSON object` fields only, therefore only fields of this type will be displayed. Users may prefer this method over selecting individual fields manually for each applicable content model.
https://user-images.githubusercontent.com/15919091/137056243-487233b5-228a-4f7b-bcd3-a99bed55f460.mp4
## Add to Content Model
Of the many content types that users can choose from, imgix specifically integrates with the `JSON object`. Please note that if you are currently using a `Media` content type for images, you will need to create a new field of type `JSON object` to integrate the app with.
Designate a field to use imgix on by navigating to that field’s Appearance tab and selecting the app. This step can be skipped if you already [assigned the app](#assign-to-fields-optional) directly to the desired field(s).
https://user-images.githubusercontent.com/15919091/137056289-8ee117fa-c254-4ae9-93aa-0bea3b975d1b.mp4
## Browse and Select Assets
From any instance of a field using the imgix app, a modal can be opened to browse assets by imgix source. First, select a desired source to browse assets from. Using any of the pagination buttons, navigate each page of assets to choose from. After selecting an asset, it can be inserted to the field via the `Add asset` button. Additionally, there are options to replace an asset, or clear a selection from the field altogether.
https://user-images.githubusercontent.com/15919091/137056329-97e3536d-2bf3-471e-970a-2921fab44e8d.mp4
### Add Parameters to Assets
>[!NOTE]
> Some parameters are only available for Premium accounts. [Contact](https://www.imgix.com/contact?imgix-plugin=contentful&cta=param-tooltip) us to enable them.
Once you've selected an asset, you can optionally apply imgix rendering parameters to it right in the Field Preview by toggling the parameter checkboxes.
https://github.com/imgix/contentful/assets/16711614/56b4c838-e504-48a9-94ad-c003764461b6
## Search for Assets
The imgix app enables users to conduct a keyword search across assets in a source. Using the search box near the top of the modal will execute a search across multiple pre-determined fields: file origin path, asset tags, and categories. To learn more about these fields, see our Asset Manager [documentation](https://docs.imgix.com/setup/asset-manager#image-details).
https://user-images.githubusercontent.com/15919091/141595662-3a9a98fd-aa88-4e56-8d6f-c30a782c678b.mov
## Upload Assets
> note: uploading to web folder sources is not supported at this time.
The imgix app enables users to upload assets to a source. Using the "Upload" button near the top of the modal, users can select an image to upload to their desired source. Users change the upload source destination, filepath, or filename. To learn more about uploading, see our Asset Manager [documentation](https://docs.imgix.com/setup/asset-manager).
https://user-images.githubusercontent.com/16711614/205107815-9d576fd8-530a-41c0-99fa-0e3800b3e896.mp4
## Query an Asset
Once the content is published, developers can query the `src` of the selected asset, returned as a string, via the Contentful API. The example below demonstrates this using GraphQL, but this can be done independent of any specific tool.
```graphql
query MyQuery {
allContentfulArticle {
nodes {
avatar {
src
}
bannerImage {
src
}
}
}
}
```
returns something similar to:
```json
{
"data": {
"allContentfulArticle": {
"nodes": [
{
"avatar": {
"src": "https://fourbottle.imgix.net/heroes/pourover.jpg"
},
"bannerImage": {
"src": "https://fourbottle.imgix.net/heroes/light-scatter.jpg"
}
}
]
}
},
"extensions": {}
}
```
### Transforming Assets
Developers can leverage the power of imgix's [rendering API](https://docs.imgix.com/apis/rendering) downstream from where the asset was selected in Contentful. We recommend piping the value of the `src` field of the asset through to one of imgix's [SDKs](https://docs.imgix.com/libraries#frontend-libraries). The example below builds on the previous one by passing the image `src` through to [@imgix/gatsby](https://github.com/imgix/gatsby) component:
```js
import React from 'react';
import { graphql } from 'gatsby';
import { ImgixGatsbyImage } from '@imgix/gatsby';
export default function Page({ data }) {
return data.allContentfulArticle.nodes.map(({ node }) => (
));
}
export const query = graphql`
query MyQuery {
allContentfulArticle {
nodes {
avatar {
src
}
}
}
}
`;
```
### Metadata
Users may also access metadata associated with an asset via the `attributes` field. Refer to the [imgix documentation metadata](https://docs.imgix.com/getting-started/setup/asset-manager#metadata) to learn more about the various types of metadata available on images and how to use them.
```graphql
query MyQuery {
allContentfulArticle {
nodes {
bannerImage {
src
attributes {
analyzed_content_warnings
analyzed_faces
analyzed_tags
color_model
color_profile
content_type
custom_fields
date_created
date_modified
dpi_height
dpi_width
face_count
file_size
has_frames
media_height
media_kind
media_width
origin_path
source_id
tags
uploaded_by_api
warning_adult
warning_medical
warning_racy
warning_spoof
warning_violence
}
}
}
}
}
```
returns something similar to:
```json
{
"data": {
"allContentfulArticle": {
"nodes": [
{
"bannerImage": {
"src": "https://fourbottle.imgix.net/heroes/woman-stirring.jpg",
"attributes": {
"analyzed_content_warnings": true,
"analyzed_faces": true,
"analyzed_tags": true,
"color_model": "RGB",
"color_profile": "c2",
"content_type": "image/jpeg",
"custom_fields": "\"\"",
"date_created": 1625796011,
"date_modified": 1642786873,
"dpi_height": 72,
"dpi_width": 72,
"face_count": 1,
"file_size": 3411741,
"has_frames": false,
"media_height": 4000,
"media_kind": "IMAGE",
"media_width": 6000,
"origin_path": "/heroes/woman-stirring.jpg",
"source_id": "5f73d9798d5327eb5194d54a",
"tags": "{\"Arm\":0.9448454976081848,\"Cup\":0.8950006365776062,\"Drinkware\":0.9177042841911316,\"Glasses\":0.9809675216674805,\"Hand\":0.9596579074859619,\"Joint\":0.9762823581695557,\"Photograph\":0.94278883934021,\"Shoulder\":0.9465579986572266,\"Tableware\":0.949840784072876,\"Vision care\":0.9289617538452148}",
"uploaded_by_api": false,
"warning_adult": 1,
"warning_medical": 1,
"warning_racy": 2,
"warning_spoof": 1,
"warning_violence": 1
}
}
}
]
}
}
}
```
**Note**: Certain fields under `attributes` are returned as strings to provide better [resiliency](https://forums.fauna.com/t/how-to-store-arbitrary-json-object-via-graphql/142/3) when used with GraphQL. Therefore, these fields (`custom_fields`, `tags`, `colors.dominant_colors`) will need to be parsed back into JSON objects after being queried. The example below demonstrates how to do this:
```js
export default function Page({ data }) {
return data.allContentfulArticle.edges.map(({ node }) => (
{node.bannerImage.attributes.custom_fields ? (
Object.entries(
JSON.parse(node.bannerImage.attributes.custom_fields),
).map(([key, value]) => (
{key}: {value}
))
) : (
)}
{Object.entries(
JSON.parse(node.bannerImage.attributes.colors.dominant_colors),
).map(([key, value]) => (
{key}: {value}
))}
{Object.entries(JSON.parse(node.bannerImage.attributes.tags)).map(
([key, value]) => (
{key}: {value}
),
)}
));
}
export const query = graphql`
{
allContentfulArticle {
edges {
node {
bannerImage {
src
attributes {
custom_fields
colors {
dominant_colors
}
tags
}
}
}
}
}
}
`;
```