Skip to content
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.

Sign up for GitHub

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

Add option for thumbs overlay: none|hidden|always #2079

Merged
merged 1 commit into from
Dec 25, 2023
Merged

Add option for thumbs overlay: none|hidden|always #2079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions app/Enum/ThumbOverlayVisibilityType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

namespace App\Enum;

/**
* Enum ThumbOverlayVisibilityType.
*
* All the allowed display possibilities of the overlay on thumbs
*/
enum ThumbOverlayVisibilityType: string
{
case NEVER = 'never';
case ALWAYS = 'always';
case HOVER = 'hover';
}
10 changes: 10 additions & 0 deletions app/View/Components/Gallery/Album/Thumbs/Album.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
use App\Contracts\Models\AbstractAlbum;
use App\DTO\AlbumProtectionPolicy;
use App\Enum\ThumbAlbumSubtitleType;
use App\Enum\ThumbOverlayVisibilityType;
use App\Models\Album as AlbumModel;
use App\Models\Configs;
use App\Models\Extensions\BaseAlbum;
Expand All @@ -30,6 +31,8 @@ class Album extends Component
public bool $is_cover_id;
public bool $has_subalbum;

public string $css_overlay;

public string $created_at = '';
public ?string $min_taken_at = null;
public ?string $max_taken_at = null;
Expand All @@ -38,6 +41,7 @@ public function __construct(AbstractAlbum $data)
{
$date_format = Configs::getValueAsString('date_format_album_thumb');

$displayOverlay = Configs::getValueAsEnum('display_thumb_album_overlay', ThumbOverlayVisibilityType::class);
$this->subType = Configs::getValueAsEnum('album_subtitle_type', ThumbAlbumSubtitleType::class)->value;

$this->id = $data->id;
Expand All @@ -54,6 +58,12 @@ public function __construct(AbstractAlbum $data)
$policy = AlbumProtectionPolicy::ofBaseAlbum($data);
}

$this->css_overlay = match ($displayOverlay) {
ThumbOverlayVisibilityType::NEVER => 'hidden',
ThumbOverlayVisibilityType::HOVER => 'opacity-0 group-hover:opacity-100 transition-all ease-out',
default => '',
};

$this->is_nsfw = $policy->is_nsfw;
$this->is_nsfw_blurred = $this->is_nsfw && Configs::getValueAsBool('nsfw_blur');
$this->is_public = $policy->is_public;
Expand Down
10 changes: 10 additions & 0 deletions app/View/Components/Gallery/Album/Thumbs/Photo.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace App\View\Components\Gallery\Album\Thumbs;

use App\Enum\SizeVariantType;
use App\Enum\ThumbOverlayVisibilityType;
use App\Exceptions\ConfigurationKeyMissingException;
use App\Exceptions\Internal\InvalidSizeVariantException;
use App\Models\Configs;
Expand All @@ -28,6 +29,8 @@ class Photo extends Component
public string $created_at;
public bool $is_cover_id = false;

public string $css_overlay;

public string $src = '';
public string $srcset = '';
public string $srcset2x = '';
Expand All @@ -46,6 +49,7 @@ public function __construct(ModelsPhoto $data, string $albumId, int $idx)
{
$this->idx = $idx;
$date_format = Configs::getValueAsString('date_format_photo_thumb');
$displayOverlay = Configs::getValueAsEnum('display_thumb_photo_overlay', ThumbOverlayVisibilityType::class);

$this->album_id = $albumId;
$this->photo_id = $data->id;
Expand All @@ -57,6 +61,12 @@ public function __construct(ModelsPhoto $data, string $albumId, int $idx)
$this->is_livephoto = $data->live_photo_url !== null;
$this->is_cover_id = $data->album?->cover_id === $data->id;

$this->css_overlay = match ($displayOverlay) {
ThumbOverlayVisibilityType::NEVER => 'hidden',
ThumbOverlayVisibilityType::HOVER => 'opacity-0 group-hover:opacity-100 transition-all ease-out',
default => '',
};

$thumb = $data->size_variants->getSizeVariant(SizeVariantType::THUMB);
$thumb2x = $data->size_variants->getSizeVariant(SizeVariantType::THUMB2X);

Expand Down
31 changes: 31 additions & 0 deletions database/migrations/2023_12_25_115454_add_setting_display_thumb_overlay.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php

use App\Models\Extensions\BaseConfigMigration;

return new class() extends BaseConfigMigration {
public const GALLERY = 'Gallery';
public const POSITIVE = 'positive';
public const BOOL = 'bool';

public function getConfigs(): array
{
return [
[
'key' => 'display_thumb_album_overlay',
'value' => 'always',
'confidentiality' => '0',
'cat' => self::GALLERY,
'type_range' => 'always|hover|never',
'description' => 'Display the title and metadata on album thumbs (always|hover|never)',
],
[
'key' => 'display_thumb_photo_overlay',
'value' => 'hover',
'confidentiality' => '0',
'cat' => self::GALLERY,
'type_range' => 'always|hover|never',
'description' => 'Display the title and metadata on album thumbs (always|hover|never)',
],
];
}
};
5 changes: 3 additions & 2 deletions resources/views/components/gallery/album/thumbs/album.blade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@
type="{{ $thumb?->type ?? '' }}" thumb="{{ $thumb?->thumbUrl ?? '' }}" thumb2x="{{ $thumb?->thumb2xUrl ?? '' }}" />
<x-gallery.album.thumbs.album-thumb class="group-hover:border-primary-500"
type="{{ $thumb?->type ?? '' }}" thumb="{{ $thumb?->thumbUrl ?? '' }}" thumb2x="{{ $thumb?->thumb2xUrl ?? '' }}" />
<div class='overlay absolute mb-[1px] mx-[1px] p-0 border-0 w-[calc(100%-2px)] bottom-0 bg-gradient-to-t from-[#00000099] text-shadow-sm'>
<h1 class="w-full pt-3 pb-1 pr-1 pl-4 text-sm text-text-main-0 font-bold text-ellipsis whitespace-nowrap overflow-x-hidden" title='{{ $title }}'>{{ $title }}</h1>
<div class="overlay absolute mb-[1px] mx-[1px] p-0 border-0 w-[calc(100%-2px)] bottom-0 bg-gradient-to-t from-[#00000099] text-shadow-sm {{ $css_overlay }}">
<h1 class="w-full pt-3 pb-1 pr-1 pl-4 text-sm text-text-main-0 font-bold text-ellipsis whitespace-nowrap overflow-x-hidden"
title='{{ $title }}'>{{ $title }}</h1>
<span class="block mt-0 mr-0 mb-3 ml-4 text-2xs text-neutral-300">
@switch($subType)
@case('description')
Expand Down
4 changes: 2 additions & 2 deletions resources/views/components/gallery/album/thumbs/photo.blade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ class="h-full w-full border-none object-cover object-center {{ $is_lazyload ? 'l
draggable='false'
/>
</span>
<div class='overlay w-full absolute bottom-0 m-0 opacity-0 bg-gradient-to-t from-[#00000066] group-hover:opacity-100 transition-opacity ease-out
text-shadow-sm'>
<div class='overlay w-full absolute bottom-0 m-0 bg-gradient-to-t from-[#00000066]
{{ $css_overlay }} text-shadow-sm'>
<h1 class=" min-h-[19px] mt-3 mb-1 ml-3 text-text-main-0 text-base font-bold overflow-hidden whitespace-nowrap text-ellipsis">{{ $title }}</h1>
<span class="block mt-0 mr-0 mb-2 ml-3 text-2xs text-neutral-300">
@if($taken_at !== "")
Expand Down
8 changes: 8 additions & 0 deletions tailwind.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
/** @type {import('tailwindcss').Config} */
module.exports = {
safelist: [
'opacity-0',
'group-hover:opacity-100',
'transition-all',
'ease-out',
'hidden',

],
content: [
"./resources/**/*.blade.php",
"./resources/**/*.js",
Expand Down