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 styles based on the documentation tool #473

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Add styles based on the documentation tool #473

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
00f72e0
Add styles based on the documentation tool
humitos Dec 16, 2024
24d7869
Use a reactive property to add specific classes
humitos Dec 17, 2024
f3477b7
Use `tool=sphinx` `tool-theme=furo` to add CSS rules
humitos Dec 18, 2024
053d931
Remove unused code
humitos Dec 18, 2024
8c337ea
Update furo font size
humitos Dec 18, 2024
9d08961
Update MkDocs Material font size
humitos Dec 18, 2024
12057bf
Useful for Jupyter Book and others
humitos Dec 18, 2024
28bb43c
Style for Antora
humitos Dec 18, 2024
434f187
Update snapshots to match `tool=` and `tool-theme=` attrs
humitos Dec 18, 2024
718b52a
Better comment
humitos Dec 18, 2024
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
9 changes: 9 additions & 0 deletions src/flyout.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,3 +155,12 @@ small a {
text-decoration: none;
color: var(--readthedocs-flyout-link-color, rgb(42, 128, 185));
}

/* Specific styles */
.mkdocs-material {
--addons-flyout-font-size: 0.6rem;
}

.sphinx-furo {
--addons-flyout-font-size: 0.75rem;
}
33 changes: 29 additions & 4 deletions src/flyout.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@ import { classMap } from "lit/directives/class-map.js";
import { default as objectPath } from "object-path";

import styleSheet from "./flyout.css";
import { AddonBase, addUtmParameters, getLinkWithFilename } from "./utils";
import {
AddonBase,
addUtmParameters,
getLinkWithFilename,
docTool,
} from "./utils";
import { SPHINX, MKDOCS_MATERIAL } from "./constants";
import {
EVENT_READTHEDOCS_SEARCH_SHOW,
EVENT_READTHEDOCS_FLYOUT_HIDE,
Expand All @@ -20,6 +26,7 @@ export class FlyoutElement extends LitElement {

static properties = {
config: { state: true },
classes: { state: true, type: Object },
humitos marked this conversation as resolved.
Show resolved Hide resolved
opened: { type: Boolean },
floating: { type: Boolean },
position: { type: String },
Expand All @@ -31,6 +38,7 @@ export class FlyoutElement extends LitElement {
super();

this.config = null;
this.classes = {};
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems we're setting this, and then overriding it on line 44?

this.opened = false;
this.floating = true;
this.position = "bottom-right";
Expand Down Expand Up @@ -67,6 +75,22 @@ export class FlyoutElement extends LitElement {
}
};

firstUpdated() {
console.log("Flyout first update.");
const doctool = docTool.documentationTool;
if (doctool === MKDOCS_MATERIAL) {
console.log("MkDocs Material custom style.");
this.classes["mkdocs-material"] = true;
} else if (doctool == SPHINX && docTool.isSphinxFuroLikeTheme()) {
console.log("Sphinx Furo custom style.");
this.classes["sphinx-furo"] = true;
}

// FIXME: I don't understand why this doesn't trigger an update
// automatically, since `this.classes` is a reactive property.
this.requestUpdate();
}

renderHeader() {
library.add(faCodeBranch);
library.add(faLanguage);
Expand Down Expand Up @@ -310,11 +334,12 @@ export class FlyoutElement extends LitElement {
return nothing;
}

const classes = { floating: this.floating, container: true };
classes[this.position] = true;
Object.assign(this.classes, { floating: this.floating, container: true });
this.classes[this.position] = true;
console.log(this.classes);

return html`
<div class=${classMap(classes)}>
<div class=${classMap(this.classes)}>
${this.renderHeader()}
<main class=${classMap({ closed: !this.opened })}>
${this.renderLanguages()} ${this.renderVersions()}
Expand Down