github-mirror/BookStack
2
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-06-28 18:01:48 +08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

PWA Manifest: Tweaks during review of PR #4430

Browse Source 
- Updated to go through HomeController with the builder as a helper
  class.
- Extracted some reapeated items into variables in manifest.
- Updated background color to match those used by BookStack.
- Removed reference of icon.ico since its not intended to be used.
- Added tests to cover functionality.

Review of #4430
This commit is contained in:
Dan Brown
2023-10-02 15:54:39 +01:00
parent 287ed4ff3b
commit 1d91b4d8a6
5 changed files with 98 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
app/App/HomeController.php
View File

@ -140,4 +140,12 @@ class HomeController extends Controller
$exists = $favicons->restoreOriginalIfNotExists();
return response()->file($exists ? $favicons->getPath() : $favicons->getOriginalPath());
}
/**
* Serve a PWA application manifest.
*/
public function pwaManifest(PwaManifestBuilder $manifestBuilder)
{
return response()->json($manifestBuilder->build());
}
}

43
app/App/PwaManifestBuilder.php
View File

@ -2,34 +2,35 @@
namespace BookStack\App;
use BookStack\Http\Controller;
class PwaManifestBuilder extends Controller
class PwaManifestBuilder
{
private function GenerateManifest()
public function build(): array
{
$darkMode = (bool) setting()->getForCurrentUser('dark-mode-enabled');
$appName = setting('app-name');
return [
"name" => setting('app-name'),
"short_name" => setting('app-name'),
"name" => $appName,
"short_name" => $appName,
"start_url" => "./",
"scope" => "/",
"display" => "standalone",
"background_color" => (setting()->getForCurrentUser('dark-mode-enabled') ? setting('app-color-dark') : setting('app-color')),
"description" => setting('app-name'),
"theme_color" => (setting()->getForCurrentUser('dark-mode-enabled') ? setting('app-color-dark') : setting('app-color')),
"background_color" => $darkMode ? '#111111' : '#F2F2F2',
"description" => $appName,
"theme_color" => ($darkMode ? setting('app-color-dark') : setting('app-color')),
"launch_handler" => [
"client_mode" => "focus-existing"
],
"orientation" => "portrait",
"icons" => [
[
"src" => setting('app-icon-64') ?: url('/icon-64.png'),
"sizes" => "64x64",
"src" => setting('app-icon-32') ?: url('/icon-32.png'),
"sizes" => "32x32",
"type" => "image/png"
],
[
"src" => setting('app-icon-32') ?: url('/icon-32.png'),
"sizes" => "32x32",
"src" => setting('app-icon-64') ?: url('/icon-64.png'),
"sizes" => "64x64",
"type" => "image/png"
],
[
@ -48,25 +49,11 @@ class PwaManifestBuilder extends Controller
"type" => "image/png"
],
[
"src" => public_path('icon.ico'),
"sizes" => "48x48",
"type" => "image/vnd.microsoft.icon"
],
[
"src" => public_path('favicon.ico'),
"src" => url('favicon.ico'),
"sizes" => "48x48",
"type" => "image/vnd.microsoft.icon"
],
],
];
}
/**
* Serve the application manifest.
* Ensures a 'manifest.json'
*/
public function manifest()
{
return response()->json($this->GenerateManifest());
}
}