-
Notifications
You must be signed in to change notification settings - Fork 274
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add prismic provider #269
Merged
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b461b18
feat: add prismic provider
lihbr 12b4dec
test: add test for prismic provider
lihbr 00272f0
chore(playground): add prismic provider to playground
lihbr ac6c408
docs: document prismic provider
lihbr 6a9ae48
refactor: use new ufo utilities on prismic provider
lihbr 21aff06
Update docs/content/en/4.providers/prismic.md
pi0 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
menuTitle: Prismic | ||
title: Prismic Provider | ||
description: 'Nuxt Image has first class integration with Prismic' | ||
category: Providers | ||
--- | ||
|
||
Integration between [Prismic](https://prismic.io/docs) and the image module. | ||
|
||
To use this provider you just need to specify an empty object at `prismic` key in Nuxt Image options object. | ||
|
||
```js{}[nuxt.config.js] | ||
export default { | ||
image: { | ||
prismic: {} | ||
} | ||
} | ||
``` | ||
|
||
<alert type="info"> | ||
|
||
Prismic allows content writer to manipulate images through its UI (cropping, rezising, etc.). To preserve that behavior this provider does not strip query parameters coming from Prismic. Instead it only overrides them when needed, keeping developers in control. | ||
|
||
</alert> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,6 +10,7 @@ const BuiltInProviders = [ | |
'imagekit', | ||
'imgix', | ||
'ipx', | ||
'prismic', | ||
'sanity', | ||
'static', | ||
'twicpics', | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
import type { ProviderGetImage } from 'src' | ||
import { $URL, joinURL } from 'ufo' | ||
import { operationsGenerator } from './imgix' | ||
|
||
const PRISMIC_IMGIX_BUCKET = 'https://images.prismic.io' | ||
|
||
// Prismic image bucket is left configurable in order to test on other environments | ||
export const getImage: ProviderGetImage = ( | ||
src, | ||
{ modifiers = {}, baseURL = PRISMIC_IMGIX_BUCKET } = {} | ||
) => { | ||
const operations = operationsGenerator(modifiers) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Perf: We |
||
|
||
// If there are already some query parameters set by Prismic | ||
const joinOperator = src.includes('?') ? '&' : '?' | ||
lihbr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
// Create URL object accordingly | ||
const url = new $URL( | ||
lihbr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
joinURL( | ||
baseURL, | ||
src.replace(new RegExp(`^${baseURL}`, 'i'), '') + | ||
(operations ? (joinOperator + operations) : '') | ||
) | ||
) | ||
|
||
// Remove duplicated keys, prioritizing override from developers | ||
Object.entries(url.query).forEach(([k, v]) => { | ||
lihbr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if (Array.isArray(v)) { | ||
url.query[k] = v.pop() | ||
} | ||
}) | ||
|
||
return { | ||
url: url.toString() | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Something along the lines of: