Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
swashbuck committed Oct 3, 2024
1 parent 2dc6cd9 commit 99c00b5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ If enabled, on mobile, text and images will be stacked vertically. No interactio
If set to `true`, the pin icons will be replaced with the item number. Useful if you want pins to be visited in a set order or show steps in a process. The default is `false`.

### \_useGraphicsAsPins (boolean):
If set to `true`, the image specified by `_graphic.src` will be ignored and the popup images specified in `_items[n]._graphic.src` will instead be laid out in a 2 item width grid system. See [example.json](example.json#L79-L115) for a working example. The default is `false`.
If set to `true`, the image specified by `_graphic.src` will be ignored and the popup images specified in `_items[n]._graphic.src` will instead be laid out in a 2 column grid system. See [example.json](example.json) for a working example. The default is `false`.

### \_hasStaticTooltips (boolean):
If set to `true`, tooltips (if enabled) will always be shown rather than only on hover.
Expand Down
15 changes: 8 additions & 7 deletions example.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Regular hotgraphic
// Standard Hot Graphic
// --------------------------------------------------
{
"_id": "c-05",
Expand Down Expand Up @@ -101,9 +101,9 @@
}
}

// Example using graphics as pins
// The following example lays out the item graphics (_items._graphic)
// in a 2x2 grid.
// Tile / grid layout
// This layout uses graphics as pin "tiles" and lays out the
// item graphics (_items._graphic) in a 2 column grid.
// --------------------------------------------------
{
"_useGraphicsAsPins": true,
Expand Down Expand Up @@ -149,11 +149,12 @@
]
}

// Example using graphic pins
// In the following example there is a background image and each pin
// is an image rather than a pin icon
// Graphic pins
// This layout uses a background image where each pin item
// is an image rather than a pin icon.
// --------------------------------------------------
{
"_useGraphicsAsPins": false,
"_items": [
{
"_left": 25,
Expand Down

0 comments on commit 99c00b5

Please sign in to comment.