Repository navigation
docs(readme): explain how to actually use the LQIP placeholders - #35
Merged
Merged
Conversation
The readme gained the two fields in the sample record but no guidance on consuming them, which leaves out the one thing an integrator has to know: `blur_data_url` is a real 16px image and is deliberately NOT pre-blurred, so dropped into an `<img>` untouched it renders as a visibly blocky postage stamp rather than a placeholder. Verified visually against real iPhone photos. Adds a "Rendering placeholders while an image loads" subsection under The Record with a copy-pasteable HTML/CSS pattern (including the `scale(1.1)` trick that hides the soft edges blur leaves at the borders), the Next.js `placeholder="blur"` equivalent, and the two behaviours that surprise people: both fields are present on private records unlike every other extra, and both are null for pre-feature and non-image records. docs/FILEMANAGER_INTEGRATION.md already covered this; the readme is where people actually start.
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Follow-up to #34. That PR added
dominant_colorandblur_data_urlto the readme's sample record and one bullet describing them — but nothing on how to consume them, which omits the single thing an integrator has to know.blur_data_urlis a real 16px image and is deliberately not pre-blurred. Dropped into an<img>untouched it renders as a visibly blocky postage stamp rather than a placeholder. Verified visually against real iPhone photos — this is not a theoretical concern, it is what the field looks like without CSS blur:filter: blur(16px)Adds a "Rendering placeholders while an image loads" subsection under The Record with:
transform: scale(1.1)— without it the blur leaves visible soft edges at the element borders.placeholder="blur"/blurDataURLequivalent.storage_key/renditions/thumbnail_url/poster_url(they carry no key and no URL, so there is nothing to withhold); and both arenullfor pre-feature and non-image records, so consumers must treat them as optional.docs/FILEMANAGER_INTEGRATION.mdalready covered this. The readme is where people actually start, and it is the document a consuming team reads before writing any integration code.Docs only — no code, no schema, no behaviour change.
ruff format --checkpasses (it formats Python blocks inside Markdown, and the readme is in scope); the added snippets are HTML/CSS/JSX and are fenced as such.