mirror of
https://github.com/gethomepage/homepage.git
synced 2026-09-23 04:25:51 -07:00
Feature: Plex mono font support, card + block styles (#7169)
Docker CI / Docker Build & Push (push) Waiting to run
Lint / Linting Checks (push) Waiting to run
Release Drafter / Update Release Draft (push) Waiting to run
Release Drafter / Auto Label PR (push) Waiting to run
Tests / vitest (1) (push) Waiting to run
Tests / vitest (2) (push) Waiting to run
Tests / vitest (3) (push) Waiting to run
Tests / vitest (4) (push) Waiting to run
Docker CI / Docker Build & Push (push) Waiting to run
Lint / Linting Checks (push) Waiting to run
Release Drafter / Update Release Draft (push) Waiting to run
Release Drafter / Auto Label PR (push) Waiting to run
Tests / vitest (1) (push) Waiting to run
Tests / vitest (2) (push) Waiting to run
Tests / vitest (3) (push) Waiting to run
Tests / vitest (4) (push) Waiting to run
This commit is contained in:
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
@@ -430,6 +430,64 @@ headerStyle: clean
|
||||
headerStyle: boxedWidgets
|
||||
```
|
||||
|
||||
## Card Style
|
||||
|
||||
Service and bookmark cards use a drop shadow by default. The `hairline` style replaces it with a thin border that brightens on hover.
|
||||
|
||||
<img width="896" alt="default cards" src="../../assets/style-default.webp">
|
||||
|
||||
```yaml
|
||||
# default, shadowed cards
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
<img width="896" alt="hairline cards" src="../../assets/card-style-hairline.webp">
|
||||
|
||||
```yaml
|
||||
cardStyle: hairline
|
||||
```
|
||||
|
||||
## Block Style
|
||||
|
||||
Widget blocks (the value / label pairs inside a service card) can use the `refined` style to make values heavier and easier to read.
|
||||
|
||||
<img width="896" alt="default blocks" src="../../assets/style-default.webp">
|
||||
|
||||
```yaml
|
||||
# default, standard blocks
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
<img width="896" alt="refined blocks" src="../../assets/block-style-refined.webp">
|
||||
|
||||
```yaml
|
||||
blockStyle: refined
|
||||
```
|
||||
|
||||
## Font
|
||||
|
||||
Homepage uses Manrope by default. You can switch to IBM Plex Mono instead, either everywhere or for data only.
|
||||
|
||||
<img width="896" alt="IBM Plex Mono everywhere" src="../../assets/font-plex.webp">
|
||||
|
||||
```yaml
|
||||
font: plex # the whole dashboard
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
<img width="896" alt="IBM Plex Mono for data only" src="../../assets/font-plex-data.webp">
|
||||
|
||||
```yaml
|
||||
font: plexData # only values, stats, the clock and status tags
|
||||
```
|
||||
|
||||
With `plexData`, labels and names stay in Manrope while numbers line up in columns.
|
||||
|
||||
Both fonts are bundled with Homepage, so no external requests are made.
|
||||
|
||||
## Base URL
|
||||
|
||||
In some proxy configurations, it may be necessary to set the documents base URL. You can do this by providing a `base` value, like so:
|
||||
|
||||
@@ -7,6 +7,10 @@ import { SettingsContext } from "utils/contexts/settings";
|
||||
export default function Item({ bookmark, iconOnly = false }) {
|
||||
const description = bookmark.description ?? new URL(bookmark.href).hostname;
|
||||
const { settings } = useContext(SettingsContext);
|
||||
const cardStyle =
|
||||
settings.cardStyle === "hairline"
|
||||
? "shadow-xs inset-ring inset-ring-black/5 dark:inset-ring-white/5 hover:inset-ring-black/10 dark:hover:inset-ring-white/10"
|
||||
: "shadow-md shadow-theme-900/10 dark:shadow-theme-900/20";
|
||||
|
||||
return (
|
||||
<li
|
||||
@@ -22,7 +26,8 @@ export default function Item({ bookmark, iconOnly = false }) {
|
||||
target={bookmark.target ?? settings.target ?? "_blank"}
|
||||
className={classNames(
|
||||
settings.cardBlur !== undefined && `backdrop-blur${settings.cardBlur.length ? "-" : ""}${settings.cardBlur}`,
|
||||
"text-left cursor-pointer transition-all rounded-md font-medium text-theme-700 dark:text-theme-200 dark:hover:text-theme-300 shadow-md shadow-theme-900/10 dark:shadow-theme-900/20 bg-theme-100/20 hover:bg-theme-300/20 dark:bg-white/5 dark:hover:bg-white/10",
|
||||
cardStyle,
|
||||
"text-left cursor-pointer transition-all rounded-md font-medium text-theme-700 dark:text-theme-200 dark:hover:text-theme-300 bg-theme-100/20 hover:bg-theme-300/20 dark:bg-white/5 dark:hover:bg-white/10",
|
||||
iconOnly ? "h-[60px] w-[60px] grid" : "block w-full mb-3",
|
||||
)}
|
||||
>
|
||||
|
||||
@@ -21,6 +21,16 @@ describe("components/bookmarks/item", () => {
|
||||
expect(screen.getByRole("link").getAttribute("target")).toBe("_self");
|
||||
});
|
||||
|
||||
it("applies hairline card styles when cardStyle is set", () => {
|
||||
renderWithProviders(<Item bookmark={{ name: "A", href: "http://example.com/x", abbr: "A" }} iconOnly={false} />, {
|
||||
settings: { cardStyle: "hairline" },
|
||||
});
|
||||
|
||||
const className = screen.getByRole("link").className;
|
||||
expect(className).toContain("inset-ring");
|
||||
expect(className).not.toContain("shadow-md");
|
||||
});
|
||||
|
||||
it("renders icon-only layout with icon when provided", () => {
|
||||
renderWithProviders(
|
||||
<Item bookmark={{ name: "A", href: "http://example.com/x", abbr: "A", icon: "mdi-home" }} iconOnly />,
|
||||
|
||||
@@ -19,6 +19,10 @@ export default function Item({ service, groupName, useEqualHeights }) {
|
||||
const { settings } = useContext(SettingsContext);
|
||||
const showStats = service.showStats === false ? false : settings.showStats;
|
||||
const statusStyle = service.statusStyle !== undefined ? service.statusStyle : settings.statusStyle;
|
||||
const cardStyle =
|
||||
settings.cardStyle === "hairline"
|
||||
? "shadow-xs inset-ring inset-ring-black/5 dark:inset-ring-white/5 hover:inset-ring-black/10 dark:hover:inset-ring-white/10"
|
||||
: "shadow-md shadow-theme-900/10 dark:shadow-theme-900/20";
|
||||
const [statsOpen, setStatsOpen] = useState(service.showStats);
|
||||
const [statsClosing, setStatsClosing] = useState(false);
|
||||
|
||||
@@ -39,7 +43,8 @@ export default function Item({ service, groupName, useEqualHeights }) {
|
||||
className={classNames(
|
||||
settings.cardBlur !== undefined && `backdrop-blur${settings.cardBlur.length ? "-" : ""}${settings.cardBlur}`,
|
||||
useEqualHeights && "h-[calc(100%-0.5rem)]",
|
||||
"transition-all mb-2 p-1 rounded-md font-medium text-theme-700 dark:text-theme-200 dark:hover:text-theme-300 shadow-md shadow-theme-900/10 dark:shadow-theme-900/20 bg-theme-100/20 hover:bg-theme-300/20 dark:bg-white/5 dark:hover:bg-white/10 relative overflow-clip service-card",
|
||||
cardStyle,
|
||||
"transition-all mb-2 p-1 rounded-md font-medium text-theme-700 dark:text-theme-200 dark:hover:text-theme-300 bg-theme-100/20 hover:bg-theme-300/20 dark:bg-white/5 dark:hover:bg-white/10 relative overflow-clip service-card",
|
||||
)}
|
||||
>
|
||||
<div className="flex select-none z-0 service-title">
|
||||
|
||||
@@ -4,11 +4,14 @@ import { useContext, useMemo } from "react";
|
||||
|
||||
import { BlockHighlightContext } from "./highlight-context";
|
||||
|
||||
import { SettingsContext } from "utils/contexts/settings";
|
||||
import { evaluateHighlight, getHighlightClass } from "utils/highlights";
|
||||
|
||||
export default function Block({ value, highlightValue, label, field }) {
|
||||
const { t } = useTranslation();
|
||||
const highlightConfig = useContext(BlockHighlightContext);
|
||||
const { settings } = useContext(SettingsContext);
|
||||
const refined = settings?.blockStyle === "refined";
|
||||
|
||||
const highlight = useMemo(() => {
|
||||
if (!highlightConfig) return null;
|
||||
@@ -45,9 +48,20 @@ export default function Block({ value, highlightValue, label, field }) {
|
||||
data-highlight-level={highlight?.level}
|
||||
data-highlight-source={highlight?.source}
|
||||
>
|
||||
<div className="font-thin text-sm">{value === undefined || value === null ? "-" : value}</div>
|
||||
<div
|
||||
className={classNames("font-bold text-xs uppercase", applyToValueOnly && "text-theme-700 dark:text-theme-200")}
|
||||
className={classNames(
|
||||
refined ? "text-[13px] font-medium tabular-nums" : "font-thin text-sm",
|
||||
"service-block-value",
|
||||
)}
|
||||
>
|
||||
{value === undefined || value === null ? "-" : value}
|
||||
</div>
|
||||
<div
|
||||
className={classNames(
|
||||
refined ? "text-[10px] font-semibold uppercase tracking-wider opacity-60" : "font-bold text-xs uppercase",
|
||||
applyToValueOnly && "text-theme-700 dark:text-theme-200",
|
||||
"service-block-label",
|
||||
)}
|
||||
>
|
||||
{t(label)}
|
||||
</div>
|
||||
|
||||
@@ -39,6 +39,24 @@ describe("components/services/widget/block", () => {
|
||||
expect(el.className).toContain("danger-class");
|
||||
});
|
||||
|
||||
it("uses the standard block styles by default", () => {
|
||||
const { container } = renderWithProviders(<Block label="some.label" value="1" />, { settings: {} });
|
||||
|
||||
expect(container.querySelector(".service-block-value").className).toContain("font-thin");
|
||||
expect(container.querySelector(".service-block-label").className).toContain("font-bold");
|
||||
});
|
||||
|
||||
it("applies refined block styles when blockStyle is set", () => {
|
||||
const { container } = renderWithProviders(<Block label="some.label" value="1" />, {
|
||||
settings: { blockStyle: "refined" },
|
||||
});
|
||||
|
||||
const value = container.querySelector(".service-block-value");
|
||||
expect(value.className).toContain("tabular-nums");
|
||||
expect(value.className).not.toContain("font-thin");
|
||||
expect(container.querySelector(".service-block-label").className).toContain("tracking-wider");
|
||||
});
|
||||
|
||||
it("prefers highlightValue over the rendered value for numeric highlighting", () => {
|
||||
const highlightConfig = {
|
||||
levels: { warn: "warn-class" },
|
||||
|
||||
@@ -25,12 +25,12 @@ export default function Resource({
|
||||
}`}
|
||||
>
|
||||
<div className="text-theme-800 dark:text-theme-200 text-xs flex flex-row justify-between gap-2">
|
||||
<div className="pl-0.5">{value}</div>
|
||||
<div className="pl-0.5 resource-value">{value}</div>
|
||||
<div className="pr-1">{label}</div>
|
||||
</div>
|
||||
{expanded && (
|
||||
<div className="text-theme-800 dark:text-theme-200 text-xs flex flex-row justify-between gap-2">
|
||||
<div className="pl-0.5">{expandedValue}</div>
|
||||
<div className="pl-0.5 resource-value">{expandedValue}</div>
|
||||
<div className="pr-1">{expandedLabel}</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
@@ -3,6 +3,7 @@ import { appWithTranslation } from "next-i18next/pages";
|
||||
import Head from "next/head";
|
||||
import "styles/globals.css";
|
||||
import "styles/manrope.css";
|
||||
import "styles/plex-mono.css";
|
||||
import "styles/theme.css";
|
||||
import { SWRConfig } from "swr";
|
||||
|
||||
|
||||
+4
-2
@@ -552,7 +552,9 @@ export default function Wrapper({ initialSettings, fallback }) {
|
||||
const html = document.documentElement;
|
||||
const body = document.body;
|
||||
|
||||
html.classList.remove("dark", "scheme-dark", "scheme-light");
|
||||
html.classList.remove("dark", "scheme-dark", "scheme-light", "font-plex", "font-plex-data");
|
||||
if (initialSettings.font === "plex") html.classList.add("font-plex");
|
||||
if (initialSettings.font === "plexData") html.classList.add("font-plex-data");
|
||||
html.classList.toggle("dark", theme === "dark");
|
||||
html.classList.add(theme === "dark" ? "scheme-dark" : "scheme-light");
|
||||
|
||||
@@ -571,7 +573,7 @@ export default function Wrapper({ initialSettings, fallback }) {
|
||||
body.style.backgroundImage = "";
|
||||
body.style.backgroundColor = "";
|
||||
body.style.backgroundAttachment = "";
|
||||
}, [backgroundImage, opacity, theme, color, initialSettings.color]);
|
||||
}, [backgroundImage, opacity, theme, color, initialSettings.color, initialSettings.font]);
|
||||
|
||||
return (
|
||||
<>
|
||||
|
||||
Binary file not shown.
@@ -0,0 +1,93 @@
|
||||
Copyright © 2017 IBM Corp. with Reserved Font Name "Plex"
|
||||
|
||||
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
||||
|
||||
This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL
|
||||
|
||||
|
||||
-----------------------------------------------------------
|
||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||||
-----------------------------------------------------------
|
||||
|
||||
PREAMBLE
|
||||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
||||
development of collaborative font projects, to support the font creation
|
||||
efforts of academic and linguistic communities, and to provide a free and
|
||||
open framework in which fonts may be shared and improved in partnership
|
||||
with others.
|
||||
|
||||
The OFL allows the licensed fonts to be used, studied, modified and
|
||||
redistributed freely as long as they are not sold by themselves. The
|
||||
fonts, including any derivative works, can be bundled, embedded,
|
||||
redistributed and/or sold with any software provided that any reserved
|
||||
names are not used by derivative works. The fonts and derivatives,
|
||||
however, cannot be released under any other type of license. The
|
||||
requirement for fonts to remain under this license does not apply
|
||||
to any document created using the fonts or their derivatives.
|
||||
|
||||
DEFINITIONS
|
||||
"Font Software" refers to the set of files released by the Copyright
|
||||
Holder(s) under this license and clearly marked as such. This may
|
||||
include source files, build scripts and documentation.
|
||||
|
||||
"Reserved Font Name" refers to any names specified as such after the
|
||||
copyright statement(s).
|
||||
|
||||
"Original Version" refers to the collection of Font Software components as
|
||||
distributed by the Copyright Holder(s).
|
||||
|
||||
"Modified Version" refers to any derivative made by adding to, deleting,
|
||||
or substituting -- in part or in whole -- any of the components of the
|
||||
Original Version, by changing formats or by porting the Font Software to a
|
||||
new environment.
|
||||
|
||||
"Author" refers to any designer, engineer, programmer, technical
|
||||
writer or other person who contributed to the Font Software.
|
||||
|
||||
PERMISSION & CONDITIONS
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
||||
redistribute, and sell modified and unmodified copies of the Font
|
||||
Software, subject to the following conditions:
|
||||
|
||||
1) Neither the Font Software nor any of its individual components,
|
||||
in Original or Modified Versions, may be sold by itself.
|
||||
|
||||
2) Original or Modified Versions of the Font Software may be bundled,
|
||||
redistributed and/or sold with any software, provided that each copy
|
||||
contains the above copyright notice and this license. These can be
|
||||
included either as stand-alone text files, human-readable headers or
|
||||
in the appropriate machine-readable metadata fields within text or
|
||||
binary files as long as those fields can be easily viewed by the user.
|
||||
|
||||
3) No Modified Version of the Font Software may use the Reserved Font
|
||||
Name(s) unless explicit written permission is granted by the corresponding
|
||||
Copyright Holder. This restriction only applies to the primary font name as
|
||||
presented to the users.
|
||||
|
||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||||
Software shall not be used to promote, endorse or advertise any
|
||||
Modified Version, except to acknowledge the contribution(s) of the
|
||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
||||
permission.
|
||||
|
||||
5) The Font Software, modified or unmodified, in part or in whole,
|
||||
must be distributed entirely under this license, and must not be
|
||||
distributed under any other license. The requirement for fonts to
|
||||
remain under this license does not apply to any document created
|
||||
using the Font Software.
|
||||
|
||||
TERMINATION
|
||||
This license becomes null and void if any of the above conditions are
|
||||
not met.
|
||||
|
||||
DISCLAIMER
|
||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
||||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,56 @@
|
||||
@font-face {
|
||||
font-family: "IBM Plex Mono";
|
||||
font-weight: 400;
|
||||
font-style: normal;
|
||||
src:
|
||||
local("IBM Plex Mono"),
|
||||
url("./font/IBMPlexMono-Regular.woff2") format("woff2");
|
||||
font-display: swap;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: "IBM Plex Mono";
|
||||
font-weight: 500;
|
||||
font-style: normal;
|
||||
src:
|
||||
local("IBM Plex Mono Medium"),
|
||||
url("./font/IBMPlexMono-Medium.woff2") format("woff2");
|
||||
font-display: swap;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: "IBM Plex Mono";
|
||||
font-weight: 600;
|
||||
font-style: normal;
|
||||
src:
|
||||
local("IBM Plex Mono SemiBold"),
|
||||
url("./font/IBMPlexMono-SemiBold.woff2") format("woff2");
|
||||
font-display: swap;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: "IBM Plex Mono";
|
||||
font-weight: 700;
|
||||
font-style: normal;
|
||||
src:
|
||||
local("IBM Plex Mono Bold"),
|
||||
url("./font/IBMPlexMono-Bold.woff2") format("woff2");
|
||||
font-display: swap;
|
||||
}
|
||||
|
||||
/* font-size-adjust keeps mono from reading larger than Manrope at the same size */
|
||||
.font-plex,
|
||||
.font-plex body {
|
||||
font-family: "IBM Plex Mono", ui-monospace, SFMono-Regular, Menlo, monospace;
|
||||
font-size-adjust: 0.5;
|
||||
letter-spacing: -0.01em;
|
||||
}
|
||||
|
||||
.font-plex-data .service-block-value,
|
||||
.font-plex-data .service-tags,
|
||||
.font-plex-data .tabular-nums,
|
||||
.font-plex-data .information-widget-resource .resource-value,
|
||||
.font-plex-data .service-container {
|
||||
font-family: "IBM Plex Mono", ui-monospace, SFMono-Regular, Menlo, monospace;
|
||||
font-size-adjust: 0.5;
|
||||
}
|
||||
Reference in New Issue
Block a user