Skip to content

Upgrade dartdoc (and page template) #8807

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

Merged
merged 2 commits into from
Jun 3, 2025
Merged

Upgrade dartdoc (and page template) #8807

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7f4e22
Upgrade dartdoc (and page template)
isoos Jun 3, 2025
78b71e4
Updated CSS selector to fix reference.
isoos Jun 3, 2025
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ Important changes to data models, configuration, and migrations between each
AppEngine version, listed here to ease deployment and troubleshooting.

## Next Release (replace with git tag when deployed)
* Bump runtimeVersion to `2025.06.03`.
* Upgraded dartdoc to `8.3.4`.

## `20250603t091500-all`
* Bump runtimeVersion to `2025.06.02`.
Expand Down
33 changes: 17 additions & 16 deletions app/lib/dartdoc/dartdoc_page.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,24 +190,25 @@ extension DartDocPageRender on DartDocPage {
placeholder: 'Loading search...',
),
),
d.div(
d.button(
id: 'theme-button',
classes: ['toggle'],
attributes: {'title': 'Toggle brightness'},
child: d.label(
attributes: {'for': 'theme'},
children: [
d.input(id: 'theme', type: 'checkbox', value: 'light-theme'),
d.span(
id: 'dark-theme-button',
classes: ['material-symbols-outlined'],
text: 'dark_mode'),
d.span(
id: 'light-theme-button',
classes: ['material-symbols-outlined'],
text: 'light_mode'),
],
),
ariaLabel: 'Light and dark mode toggle',
attributes: {'title': 'Toggle between light and dark mode'},
children: [
d.span(
id: 'dark-theme-button',
classes: ['material-symbols-outlined'],
attributes: {'aria-hidden': 'true'},
text: 'dark_mode',
),
d.span(
id: 'light-theme-button',
classes: ['material-symbols-outlined'],
attributes: {'aria-hidden': 'true'},
text: 'light_mode',
),
],
),
]);

Expand Down
6 changes: 3 additions & 3 deletions app/lib/shared/versions.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ final RegExp runtimeVersionPattern = RegExp(r'^\d{4}\.\d{2}\.\d{2}$');
/// when the version switch happens.
const _acceptedRuntimeVersions = <String>[
// The current [runtimeVersion].
'2025.06.02',
'2025.06.03',
// Fallback runtime versions.
'2025.06.02',
'2025.05.21',
'2025.05.15',
];

/// Sets the current runtime versions.
Expand Down Expand Up @@ -74,4 +74,4 @@ final semanticToolStableFlutterSdkVersion =
final String panaVersion = pana.packageVersion;

// keep in-sync with pkg/pub-worker/lib/src/bin/pana_wrapper.dart
final String dartdocVersion = '8.3.3';
final String dartdocVersion = '8.3.4';
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/1.0.0/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content">
Expand Down
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass-class.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content" data-above-sidebar="oxygen/oxygen-library-sidebar.html" data-below-sidebar="oxygen/MainClass-class-sidebar.html">
Expand Down
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/MainClass.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content" data-above-sidebar="oxygen/MainClass-class-sidebar.html" data-below-sidebar="">
Expand Down
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/text.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content" data-above-sidebar="oxygen/MainClass-class-sidebar.html" data-below-sidebar="">
Expand Down
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/toLowerCase.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content" data-above-sidebar="oxygen/MainClass-class-sidebar.html" data-below-sidebar="">
Expand Down
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/toString.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content" data-above-sidebar="oxygen/MainClass-class-sidebar.html" data-below-sidebar="">
Expand Down
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/TypeEnum.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content" data-above-sidebar="oxygen/oxygen-library-sidebar.html" data-below-sidebar="oxygen/TypeEnum-enum-sidebar.html">
Expand Down
11 changes: 4 additions & 7 deletions ...est/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/TypeEnum/values-constant.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content" data-above-sidebar="oxygen/TypeEnum-enum-sidebar.html" data-below-sidebar="">
Expand Down
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content" data-above-sidebar="" data-below-sidebar="oxygen/oxygen-library-sidebar.html">
Expand Down
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/main.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content" data-above-sidebar="oxygen/oxygen-library-sidebar.html" data-below-sidebar="">
Expand Down
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/2.0.0/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content">
Expand Down
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass-class.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content" data-above-sidebar="oxygen/oxygen-library-sidebar.html" data-below-sidebar="oxygen/MainClass-class-sidebar.html">
Expand Down
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass/MainClass.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content" data-above-sidebar="oxygen/MainClass-class-sidebar.html" data-below-sidebar="">
Expand Down
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass/text.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content" data-above-sidebar="oxygen/MainClass-class-sidebar.html" data-below-sidebar="">
Expand Down
11 changes: 4 additions & 7 deletions app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass/toLowerCase.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,10 @@
<form class="search navbar-right" role="search">
<input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
</form>
<div id="theme-button" class="toggle" title="Toggle brightness">
<label for="theme">
<input id="theme" type="checkbox" value="light-theme"/>
<span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined">light_mode</span>
</label>
</div>
<button id="theme-button" class="toggle" aria-label="Light and dark mode toggle" title="Toggle between light and dark mode">
<span id="dark-theme-button" class="material-symbols-outlined" aria-hidden="true">dark_mode</span>
<span id="light-theme-button" class="material-symbols-outlined" aria-hidden="true">light_mode</span>
</button>
</header>
<main>
<div id="dartdoc-main-content" class="main-content" data-above-sidebar="oxygen/MainClass-class-sidebar.html" data-below-sidebar="">
Expand Down
Loading
Loading