2025-06-11 20:52:07 +02:00

198 lines
5.6 KiB
Markdown
Vendored
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Reference
## Detecting mobile vs. desktop
The mobile layout is different than the one on the desktop. Use `body.mobile` and `body.desktop` to differentiate between them.
```css
body.mobile #root-widget {
/* Do something on mobile */
}
body.desktop #root-widget {
/* Do something on desktop */
}
```
Do note that there is also a “tablet mode” in the mobile layout. For that particular case media queries are required:
```css
@media (max-width: 991px) {
#launcher-pane {
/* Do something on mobile layout */
}
}
@media (min-width: 992px) {
#launcher-pane {
/* Do something on mobile tablet + desktop layout */
}
}
```
## Detecting horizontal vs. vertical layout
The user can select between vertical layout (the classical one, where the launcher bar is on the left) and a horizontal layout (where the launcher bar is on the top and tabs are full-width).
Different styles can be applied by using classes at `body` level:
```
body.layout-vertical #left-pane {
/* Do something */
}
body.layout-horizontal #center-pane {
/* Do something else */
}
```
The two different layouts use different containers (but they are present in the DOM regardless of the user's choice), for example `#horizontal-main-container` and `#vertical-main-container` can be used to customize the background of the content section.
## Detecting platform (Windows, macOS) or Electron
It is possible to add particular styles that only apply to a given platform by using the classes in `body`:
| Windows | macOS |
| --- | --- |
| `<br>body.platform-win32 {<br> background: red;<br>}<br>` | `<br>body.platform-darwin {<br> background: red;<br>}<br>` |
It is also possible to only apply a style if running under Electron (desktop application):
```
body.electron {
background: blue;
}
```
### Native title bar
It's possible to detect if the user has selected the native title bar or the custom title bar by querying against `body`:
```
body.electron.native-titlebar {
/* Do something */
}
body.electron:not(.native-titlebar) {
/* Do something else */
}
```
### Native window buttons
When running under Electron with native title bar off, a feature was introduced to use the platform-specific window buttons such as the semaphore on macOS.
See [Native title bar buttons by eliandoran · Pull Request #702 · TriliumNext/Notes](https://github.com/TriliumNext/Notes/pull/702) for the original implementation of this feature, including screenshots.
#### On Windows
The colors of the native window button area can be adjusted using a RGB hex color:
```
body {
--native-titlebar-foreground: #ffffff;
--native-titlebar-background: #ff0000;
}
```
It is also possible to use transparency at the cost of reduced hover colors using a RGBA hex color:
```
body {
--native-titlebar-background: #ff0000aa;
}
```
Note that the value is read when the window is initialized and then it is refreshed only when the user changes their light/dark mode preference.
#### On macOS
On macOS the semaphore window buttons are enabled by default when the native title bar is disabled. The offset of the buttons can be adjusted using:
```css
body {
--native-titlebar-darwin-x-offset: 12;
--native-titlebar-darwin-y-offset: 14 !important;
}
```
### Background/transparency effects on Windows (Mica)
Windows 11 offers a special background/transparency effect called Mica, which can be enabled by themes by setting the `--background-material` variable at `body` level:
```css
body.electron.platform-win32 {
--background-material: tabbed;
}
```
The value can be either `tabbed` (especially useful for the horizontal layout) or `mica` (ideal for the vertical layout).
Do note that the Mica effect is applied at `body` level and the theme needs to make the entire hierarchy (semi-)transparent in order for it to be visible. Use the TrilumNext theme as an inspiration.
## Note icons, tab workspace accent color
Theme capabilities are small adjustments done through CSS variables that can affect the layout or the visual aspect of the application.
In the tab bar, to display the icons of notes instead of the icon of the workspace:
```css
:root {
--tab-note-icons: true;
}
```
When a workspace is hoisted for a given tab, it is possible to get the background color of that workspace, for example to apply a small strip on the tab instead of the whole background color:
```css
.note-tab .note-tab-wrapper {
--tab-background-color: initial !important;
}
.note-tab .note-tab-wrapper::after {
content: "";
position: absolute;
top: 0;
left: 0;
right: 0;
height: 3px;
background-color: var(--workspace-tab-background-color);
}
```
## Custom fonts
Currently the only way to include a custom font is to use [Custom resource providers](../Advanced%20Usage/Custom%20Resource%20Providers.md). Basically import a font into Trilium and assign it `#customResourceProvider=fonts/myfont.ttf` and then import the font in CSS via `/custom/fonts/myfont.ttf`. Use `../../../custom/fonts/myfont.ttf` if you run your Trilium server on a different path than `/`.
## Dark and light themes
A light theme needs to have the following CSS:
```css
:root {
--theme-style: light;
}
```
if the theme is dark, then `--theme-style` needs to be `dark`.
If the theme is auto (e.g. supports both light or dark based on `prefers-color-scheme`) it must also declare (in addition to setting `--theme-style` to either `light` or `dark`):
```css
:root {
--theme-style-auto: true;
}
```
This will affect the behavior of the Electron application by informing the operating system of the color preference (e.g. background effects will appear correct on Windows).