Feat/sat image snapshot#18
Open
jdromero88 wants to merge 51 commits into
Open
Conversation
969df25 to
694a9b5
Compare
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
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.
Satellite Snapshot Timeline
The Satellite Snapshot Timeline is an interactive image slider. It lets visitors move through a set of dated images using a timeline and previous/next buttons.
Each item can show:
an image
a title
a date
a short description
a point on the timeline
The timeline is powered by a spreadsheet or CSV file. Once the data is connected, the component automatically builds the image slider and timeline.
Basic Example
To add the timeline to a page, copy and paste this:
The only required setting is
data-url.Replace:
with the link to your published CSV file.
Example with Magnifier Turned On
The magnifier is optional. By default, it is turned off.
To turn it on, add:
Example:
The magnifier only works on larger screens. On screens that are
1024pxwide or smaller, the magnifier turns off automatically so the timeline is easier to use on tablets and phones.What the Visitor Can Do
Visitors can:
click Prev to see the previous image
click Next to see the next image
click a point on the timeline
hover over timeline points to preview dates
read the title, date, and description for the selected image
use the magnifier on desktop, when it is enabled
Required Setting
data-urlThis connects the component to your data.
Example:
Without
data-url, the timeline will not have any content to display.Turning the Magnifier On or Off
Magnifier Off
This is the default behavior:
You can also write it explicitly like this:
Magnifier On
Use this when you want visitors on desktop screens to zoom into the image:
Magnifier Zoom Amount
Use
magnifier-zoomto control how zoomed-in the magnifier appears.A larger number means more zoom.
Recommended values:
Magnifier Border Color
Use
magnifier-border-colorto change the outline color of the magnifier circle.Full Example
Styling the Timeline
You can customize the look of the timeline without editing the component code. Add any of these settings directly inside the component tag.
Timeline Line Color
Changes the horizontal line behind the timeline points.
Example:
Timeline Circle Size
Changes the size of the timeline dots.
Example:
Timeline Circle Color
Changes the inside color of the timeline dots.
Timeline Circle Border Color
Changes the border color around the timeline dots.
Selected Timeline Circle Border Color
Changes the border color of the active timeline dot.
Timeline Year Color
Changes the color of the year labels under the timeline.
Styling the Timeline Box
The timeline box is the outer container around the image, timeline, and text.
Background Color
Border Thickness
Border Color
Rounded Corners
Padding
Padding controls the amount of space inside the outer box.
Gap Between Sections
This controls the space between the image, timeline, and text content.
Styling the Buttons
The component has Prev and Next buttons.
Button Text Color
Button Background Color
Button Border Color
Button Border Thickness
Button Icon Color
Button Hover Text Color
This changes the text/icon color when someone hovers over the button.
Button Hover Background Color
Space Between Button Text and Icon
Styling the Image
Image Fit
Use
img-object-fitto control how the image fits inside its space.Recommended options:
Use
containwhen you want the full image to always be visible.Use
coverwhen you want the image to fill the space, even if part of the image may be cropped.Styling the Text Area
The text area includes the title, date, and description.
Text Box Background Color
Text Box Border Thickness
Text Box Border Color
Text Box Rounded Corners
Styling the Title
Title Color
Title Alignment
Other options:
Title Font Size
Styling the Date
Date Color
Date Font Size
Date Alignment
Other options:
Styling the Description
Description Color
Description Font Size
Description Alignment
Other options:
Using a Custom Font
You can use a custom web font by adding a font link and font family.
Font Link
Font Family
Example:
Styled Example
Styled Example with Magnifier
Quick Reference
Notes for Editors
Use quotation marks around every setting value:
Do not use this:
Colors can be written as hex values:
Sizes can be written as:
The safest values to edit are colors, font sizes, borders, and spacing.
Troubleshooting
Nothing appears on the page
Check that
data-urlis present and points to a valid CSV file.The magnifier does not appear
Check that the component includes:
Also remember that the magnifier is automatically disabled on screens
1024pxwide or smaller. The slider and timeline will still work on those screens.The image looks cropped
Try using:
The title or description is too small
Increase the font size:
The timeline dots are too small
Increase the circle size:
Recommended Starter Version
For most pages, start with this:
For pages where image details are important and the audience is likely to use desktop screens, use this: