Skip to content

Commit

Permalink
adding GQL feature
Browse files Browse the repository at this point in the history
  • Loading branch information
emran-alhaddad committed Jan 17, 2025
0 parents commit 67c4985
Show file tree
Hide file tree
Showing 29 changed files with 10,132 additions and 0 deletions.
Binary file added .DS_Store
Binary file not shown.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
node_modules
vendor
mix-manifest.json
.vscode
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
16.8.0
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Darin Larimore

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
137 changes: 137 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
Here’s the updated README in plain text using Markdown format:

```markdown
# ![Icon](src/icon.svg) Statamic Imagehotspots

> Statamic Imagehotspots is a Statamic addon that allows you to add hotspots to images.

## Features
This addon provides the following features:
- Save hotspot positions in percentages for absolute positioning usage
- Supports SVG images
- Antlers tag to access hotspots in your templates
- **GraphQL support** for querying image hotspots data

## How to Install
You can search for this addon in the `Tools > Addons` section of the Statamic control panel and click **install**, or run the following command from your project root:

```bash
composer require emran-alhaddad/statamic-imagehotspots
```

## How to Use

### Setup Fields
Add an `Image Hot Spots` field and configure the required asset `Container` setting.

![Image Hot Spots Field](fieldType.png)

### Usage
1. Add an image to the `Assets` field.
2. Click the `Refresh Image` button.
3. Click the `Add Hotspot` button.
4. Click and drag the hotspot to the desired position.
5. Add a description for the hotspot.

![Image Hot Spots Field](fields.png)
**Note:** Hotspots cannot be placed in the red border area to prevent breaking the page bounds at certain sizes.

### Front End Templating Example
This example uses Tailwind, Alpine.js, and the X-anchor Alpine.js plugin. The `{{ image_hot_spots }}{{ /image_hot_spots }}` tag pair is used to loop through the hotspots, and the `{{ hotspots }}{{ /hotspots }}` tag pair is used to access the hotspot data.

```html
<section>
{{ image_hot_spots field="image_hot_spots_field" }}
<div class="relative">
<img src="{{glide :src="image.url" w=1280}}" class="w-full" alt="{{image.alt}}">

{{ hotspots }}
<div
x-data="{ open: false }"
class="absolute"
style="top: {{y}}%; left: {{x}}%; transform: translate(-12px, -12px);"
@mouseOver="open = true"
@mouseLeave="open = false"
>
<div
class="w-8 h-8 bg-blue-500 border-white border-2 rounded-full
flex justify-center items-center text-xs text-white font-bold cursor-pointer"
x-ref="button"
>
{{svg src="heroicons/solid/plus.svg" class="size-6"}}
</div>

{{# tooltip #}}
<div
class="bg-black p-4 shadow-lg w-64 text-white z-10"
x-cloak
x-show="open"
x-anchor.offset.5="$refs.button"
>
{{ content }}
</div>
</div>
{{ /hotspots }}
</div>
{{ /image_hot_spots }}
</section>
```

**Note:** The `-translate-x` and `-translate-y` classes are used to center the hotspots accurately and help prevent the hotspots from breaking the page bounds.

![Image Hot Spots Front End Example](imageHotspots.png)

## GraphQL Support
This addon includes GraphQL support, allowing you to query image hotspot data dynamically.

### Example GraphQL Query
Here’s an example of a GraphQL query to fetch hotspot data:

```graphql
{
imageHotspots {
imageFile {
url
id
fileName
alt
}
hotspots {
x
y
content
}
}
}
```

### Example Response
```json
{
"data": {
"imageHotspots": {
"imageFile": {
"url": "https://example.com/image.png",
"id": "assets::example/image.png",
"fileName": "image.png",
"alt": "An example image"
},
"hotspots": [
{
"x": 54.97,
"y": 49.47,
"content": "Example content 1"
},
{
"x": 26.66,
"y": 69.66,
"content": "Example content 2"
}
]
}
}
}
```

With this feature, you can easily integrate your image hotspots into dynamic GraphQL-based frontends or APIs.
```
30 changes: 30 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"name": "emran-alhaddad/statamic-imagehotspots",
"autoload": {
"psr-4": {
"EmranAlhaddad\\StatamicImagehotspots\\": "src"
}
},
"require": {
"statamic/cms": "^5.0",
"php": "^8.2"
},
"config": {
"allow-plugins": {
"pixelfear/composer-dist-plugin": true
}
},
"extra": {
"statamic": {
"name": "Statamic Imagehotspots",
"description": "Statamic Imagehotspots addon"
},
"laravel": {
"providers": [
"EmranAlhaddad\\StatamicImagehotspots\\ServiceProvider"
]
}
},
"minimum-stability": "dev",
"prefer-stable": true
}
Loading

0 comments on commit 67c4985

Please sign in to comment.