Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d347809e6e | ||
|
|
a5ffcc22e3 | ||
|
|
f18691560d | ||
|
|
c84a9069ef | ||
|
|
f967916550 | ||
|
|
3fa7c7734b | ||
|
|
cceeb40b16 |
+34
-1
@@ -3,7 +3,8 @@
|
|||||||
**Issue:** #24 (`Area/Shell-Nav`, `Priority/High`, `Reviewed/Confirmed`)
|
**Issue:** #24 (`Area/Shell-Nav`, `Priority/High`, `Reviewed/Confirmed`)
|
||||||
**Unblocks:** #55 (queue as a screen) — a real Gitea dependency
|
**Unblocks:** #55 (queue as a screen) — a real Gitea dependency
|
||||||
**Relates:** #69 (page-header overflow), #12 (mini-player), #51 (small-screen umbrella)
|
**Relates:** #69 (page-header overflow), #12 (mini-player), #51 (small-screen umbrella)
|
||||||
**Status:** in flight
|
**Status:** complete — #24 shipped as PR #132, and the matrix's last
|
||||||
|
unkept promise closed with #69.
|
||||||
|
|
||||||
#73 puts this first in Phase 2 and hangs the rest of the phase off it,
|
#73 puts this first in Phase 2 and hangs the rest of the phase off it,
|
||||||
so the decision has to be written down and arguable before any CSS
|
so the decision has to be written down and arguable before any CSS
|
||||||
@@ -269,6 +270,38 @@ leaving the navigation live means the scrim reads as "this is over the
|
|||||||
content" (which is what #24 asked for) without pretending the rest of
|
content" (which is what #24 asked for) without pretending the rest of
|
||||||
the app is unavailable.
|
the app is unavailable.
|
||||||
|
|
||||||
|
## What #69 did with the promise, and one thing this plan got wrong
|
||||||
|
|
||||||
|
#69 landed on its own branch as decision 3 said it would, and the
|
||||||
|
matrix's *no action is ever unreachable at any supported size* is now
|
||||||
|
kept rather than promised. Measured on Playlists, actions clipped:
|
||||||
|
|
||||||
|
| viewport | before #24 | after #24 | after #69 |
|
||||||
|
|---|---|---|---|
|
||||||
|
| 900×600, queue open | all three | one (114/162px) | none |
|
||||||
|
| 900×600, queue closed | one | one | none |
|
||||||
|
| 800×600, queue closed | one (158/162px) | one | none |
|
||||||
|
| 390×780 | all three | all three | none |
|
||||||
|
| 320×600 | all three | all three | none |
|
||||||
|
|
||||||
|
The shape was the one decision 3 predicted — an actions API first, an
|
||||||
|
overflow rule second — and all three hosts that slot actions migrated.
|
||||||
|
|
||||||
|
**What this document got wrong is smaller and worth keeping.** Decision
|
||||||
|
1 says the header's minimum is a *comfort* floor and that only the
|
||||||
|
queue and the actions compete for the header's width. They are not the
|
||||||
|
only two: every child of that flex row was `flex-shrink: 0`, so
|
||||||
|
whatever came last lost, and the actions come last. At 320px the sort
|
||||||
|
control alone is 172px of the header — so with every action already
|
||||||
|
collapsed into the menu, the *menu button* was 76px off the right edge.
|
||||||
|
The promise was still broken with nothing left to collapse.
|
||||||
|
|
||||||
|
That is why #69 also had to decide what gives way: the title (which the
|
||||||
|
navigation also states) and, below 600px, the word "Sort:" (which the
|
||||||
|
direction arrow implies). Neither is an action, which is the rule the
|
||||||
|
matrix actually encodes — **an action is a capability and everything
|
||||||
|
else on that row is a label.**
|
||||||
|
|
||||||
## Verification, and what each tier cannot see
|
## Verification, and what each tier cannot see
|
||||||
|
|
||||||
- `make ui-test` — the queue panel's mode logic is component-tier
|
- `make ui-test` — the queue panel's mode logic is component-tier
|
||||||
@@ -952,6 +952,50 @@ kept beside it, because two stacks is precisely how a view's own back
|
|||||||
button and the phone's gesture come to disagree about what one press
|
button and the phone's gesture come to disagree about what one press
|
||||||
means.
|
means.
|
||||||
|
|
||||||
|
**And there is one statement of which view is active**, for the same
|
||||||
|
reason: `popstate` calls `handleNavigate()` directly and dispatches no
|
||||||
|
`navigate`, so the two nav components — which learned the active view
|
||||||
|
from that event — kept highlighting the view the user had just *left*.
|
||||||
|
`store/active-view-store.ts` is the shell saying where the user is, and
|
||||||
|
both navs read it through `ActiveViewController` rather than holding an
|
||||||
|
`activeView` of their own.
|
||||||
|
|
||||||
|
Four things about it are load-bearing.
|
||||||
|
|
||||||
|
**"Please go to X" and "the active view is now X" are different
|
||||||
|
statements**, and only the first existed — dispatched from 28 call
|
||||||
|
sites across 18 files. A re-dispatch from inside `handleNavigate` is
|
||||||
|
not the fix and cannot be: that function is the `document` listener for
|
||||||
|
`navigate`, so it is an infinite loop.
|
||||||
|
|
||||||
|
**It is a store rather than an event, because a component that mounts
|
||||||
|
after a navigation still has to know.** `bottom-nav`'s "More" drawer
|
||||||
|
creates its `<app-sidebar>` on open, and that copy had heard no
|
||||||
|
`navigate` at all — standing on Albums, the drawer opened highlighting
|
||||||
|
Home. An event has no answer for a listener that was not there.
|
||||||
|
|
||||||
|
**A detail view is not a view here**, so the destination it was opened
|
||||||
|
from stays lit. `app-sidebar` did that by accident (it guarded on
|
||||||
|
`navItems.some(...)`, so an unmatched name left its highlight alone)
|
||||||
|
and `bottom-nav` had no such guard and so lit *nothing* — which is why
|
||||||
|
one looked right and the other looked broken on the same screen.
|
||||||
|
Whether a view is primary is the shell's fact: `view in VIEW_TAGS` is
|
||||||
|
passed to `setView`, never re-derived, because a second copy of that
|
||||||
|
list is a second thing to forget.
|
||||||
|
|
||||||
|
**Nothing is lit until the shell has navigated.** The store starts
|
||||||
|
empty rather than defaulting to `home`, which is what `app-sidebar`'s
|
||||||
|
field used to do to match the landing view — a default that is correct
|
||||||
|
only while `GetDefaultPage()` agrees with it.
|
||||||
|
|
||||||
|
The assertion is `aria-current="page"`, in
|
||||||
|
`e2e/specs/back-navigation.spec.ts`. That file existed throughout the
|
||||||
|
bug, covered exactly these journeys, and asserted only
|
||||||
|
`data-active-view` — the shell's own bookkeeping, which was right the
|
||||||
|
whole way through — so it was green on the broken build. Same trap as
|
||||||
|
`layout-overflow.spec.ts` and `page-header`: a spec named for the
|
||||||
|
behaviour, measuring the plumbing.
|
||||||
|
|
||||||
**A primary view is cached, not unmounted.** `index.ts` keeps every
|
**A primary view is cached, not unmounted.** `index.ts` keeps every
|
||||||
primary view in the DOM and toggles a `.view-hidden` class, because that
|
primary view in the DOM and toggles a `.view-hidden` class, because that
|
||||||
is what preserves `scrollTop` across navigation — so
|
is what preserves `scrollTop` across navigation — so
|
||||||
@@ -1980,6 +2024,79 @@ that corrects itself a moment later is worse than saying nothing. And
|
|||||||
the field, the direction and their persistence, so the control cannot
|
the field, the direction and their persistence, so the control cannot
|
||||||
disagree with the list.
|
disagree with the list.
|
||||||
|
|
||||||
|
**And an action is data, on that same rule: the header decides what
|
||||||
|
fits, the host decides what happens.** Playlists slotted three buttons
|
||||||
|
totalling 390px into a header that gets 700px at 900×600, so "New Smart
|
||||||
|
Playlist" rendered **114 of its 162px** with the queue closed — and on a
|
||||||
|
phone none of them could be reached at all, which is what #69 reported.
|
||||||
|
A host passes `PageAction[]` (`{id, label, icon, onSelect, priority,
|
||||||
|
drop?}`) and `page-header` renders each one as a button or as an item in
|
||||||
|
one "More actions" menu.
|
||||||
|
|
||||||
|
**It could not have been a rule added in one place**, and that is a fact
|
||||||
|
about the API rather than an effort estimate: actions used to arrive
|
||||||
|
through `<slot name="actions">` as arbitrary light-DOM markup, and a
|
||||||
|
component cannot move another component's light-DOM children into a
|
||||||
|
dropdown and keep their behaviour — there is nothing generic in markup
|
||||||
|
to render as a menu item. The slot survives for markup a data list
|
||||||
|
cannot express, at the stated cost that **a slotted action does not
|
||||||
|
collapse** and must therefore fit at 800×600.
|
||||||
|
|
||||||
|
Six things about it are load-bearing:
|
||||||
|
|
||||||
|
- **The fit is measured, never breakpointed.** A ResizeObserver drives
|
||||||
|
it, and each pass starts from *all visible* and hides the
|
||||||
|
lowest-priority action until it fits — so the collapsed set is a pure
|
||||||
|
function of the current width rather than of how the window got
|
||||||
|
there. A rule that only ever added to the set would never give a
|
||||||
|
button back, and one that adjusted by a step would need a hysteresis
|
||||||
|
band to stop it oscillating on the pixel where a button exactly fits.
|
||||||
|
- **"Fits" means nothing is clipped, which is not the same as the
|
||||||
|
header not overflowing.** The title can ellipsis, and the moment it
|
||||||
|
can it absorbs the pressure: `scrollWidth` reports a header that fits
|
||||||
|
perfectly while the heading reads "Playlis…". That is this bug moved
|
||||||
|
from the button to the title, invisible to the same measurement that
|
||||||
|
missed it the first time — so the heading's own truncation counts as
|
||||||
|
not fitting, and an action is collapsed before the title gives way.
|
||||||
|
Below that, at 320px, the title *is* what yields: the navigation also
|
||||||
|
says which page you are on, and an action has nowhere else to be said.
|
||||||
|
- **The measurement flips `hidden` on the rendered nodes rather than
|
||||||
|
re-rendering between steps.** Reading `scrollWidth` forces layout,
|
||||||
|
which is the point; awaiting a Lit update between steps instead lets
|
||||||
|
the intermediate all-visible state paint, so the fix would flash the
|
||||||
|
overflow it exists to prevent.
|
||||||
|
- **Priority is what a *capability* costs, not what a button is worth.**
|
||||||
|
New Playlist is highest because it is the **drop target** and a closed
|
||||||
|
menu cannot be one; that is also why `PageAction.drop` carries the
|
||||||
|
host's own `dragover`/`dragleave`/`drop` handlers rather than the
|
||||||
|
header owning a notion of dropping, and why the affordance is simply
|
||||||
|
absent from the overflow rather than approximated there.
|
||||||
|
- **`aria-controls` names a panel that is always in the DOM** —
|
||||||
|
`config-section`'s rule, and `wa-popup` hides it when inactive — and
|
||||||
|
the keyboard model is `MenuKeyboard`, shared with every other menu in
|
||||||
|
the app so this is not a second one.
|
||||||
|
- **It is checked per button, because `layout-overflow.spec.ts` cannot
|
||||||
|
see this.** That spec asserts the *shell* needs no sideways
|
||||||
|
scrolling and passed on the broken build; clipping *inside* a
|
||||||
|
component is invisible to it, which is exactly why the defect
|
||||||
|
survived a spec named for it.
|
||||||
|
`e2e/specs/header-action-overflow.spec.ts` measures each button
|
||||||
|
against its header at 900×600, 800×600, 390×780 and 320×600, and
|
||||||
|
asserts buttons **plus** menu account for every declared action —
|
||||||
|
without that half it would pass vacuously on a build that renders no
|
||||||
|
actions at all.
|
||||||
|
|
||||||
|
One thing it deliberately does **not** grow is a phone mode for the
|
||||||
|
actions. `PHONE_COLUMN_IDS` is the precedent for "what is drawn and
|
||||||
|
what can be sorted are different questions", but it exists because the
|
||||||
|
track list's columns cannot be derived from a width; these can, and a
|
||||||
|
second declaration of what a phone shows is a second thing to keep in
|
||||||
|
step. What the header *does* state at phone width is one word: below
|
||||||
|
600px the sort control's "Sort:" label is visually hidden — 172px of a
|
||||||
|
320px header for a label the adjacent direction arrow implies — and it
|
||||||
|
stays in the accessibility tree, because it is the select's accessible
|
||||||
|
name and hiding it outright is `config-field`'s bug one component over.
|
||||||
|
|
||||||
**The header search box is view-scoped, and now says so.** It sits in
|
**The header search box is view-scoped, and now says so.** It sits in
|
||||||
the app header and reads as global; typing `tide` on Playlists answered
|
the app header and reads as global; typing `tide` on Playlists answered
|
||||||
"No playlists match your search" with three *Tideline* tracks in the
|
"No playlists match your search" with three *Tideline* tracks in the
|
||||||
|
|||||||
@@ -15,12 +15,49 @@ import { test, expect } from '../support/fixtures.js';
|
|||||||
*
|
*
|
||||||
* What it cannot answer is whether Android's *gesture* reaches the
|
* What it cannot answer is whether Android's *gesture* reaches the
|
||||||
* WebView, which is between the OS and the scaffold.
|
* WebView, which is between the OS and the scaffold.
|
||||||
|
*
|
||||||
|
* **And `data-active-view` is not the behaviour.** Every assertion here
|
||||||
|
* used to be that attribute, which the shell sets on every path
|
||||||
|
* including `_isBack` — so this file was green throughout #72, in
|
||||||
|
* which both navs highlighted the view the user had just *left*. The
|
||||||
|
* shell's own bookkeeping was the one thing that was already right;
|
||||||
|
* what a person sees is `aria-current`, and that is asserted below as
|
||||||
|
* well. This is the same trap `layout-overflow.spec.ts` set for #69: a
|
||||||
|
* spec named for the behaviour, measuring the plumbing.
|
||||||
*/
|
*/
|
||||||
type Page = import('@playwright/test').Page;
|
type Page = import('@playwright/test').Page;
|
||||||
|
|
||||||
const activeView = (page: Page) =>
|
const activeView = (page: Page) =>
|
||||||
page.getByTestId('main-content');
|
page.getByTestId('main-content');
|
||||||
|
|
||||||
|
/** A common phone, where the bottom bar is the primary navigation. */
|
||||||
|
const PHONE = { width: 390, height: 844 };
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The nav item for a destination, in whichever navigation is on screen.
|
||||||
|
*
|
||||||
|
* Both navs carry a button named `Albums`, and only one of them is ever
|
||||||
|
* in the accessibility tree — the other is `display: none` — so the
|
||||||
|
* role query resolves to the one the user can see at this viewport.
|
||||||
|
* That is the point: the highlight has to be right in both, and #72 was
|
||||||
|
* two different-looking symptoms of one cause.
|
||||||
|
*/
|
||||||
|
const navItem = (page: Page, label: string) =>
|
||||||
|
page.getByRole('button', { name: label, exact: true });
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `aria-current="page"` is the accessible fact and the assertion worth
|
||||||
|
* making; `.active` is a class and could be restyled without breaking
|
||||||
|
* anything real.
|
||||||
|
*/
|
||||||
|
async function expectHighlighted(page: Page, label: string): Promise<void> {
|
||||||
|
await expect(navItem(page, label)).toHaveAttribute('aria-current', 'page');
|
||||||
|
}
|
||||||
|
|
||||||
|
async function expectNotHighlighted(page: Page, label: string): Promise<void> {
|
||||||
|
await expect(navItem(page, label)).toHaveAttribute('aria-current', 'false');
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Open an artist's detail view, which is the deepest ordinary route.
|
* Open an artist's detail view, which is the deepest ordinary route.
|
||||||
*
|
*
|
||||||
@@ -71,6 +108,105 @@ test.describe('the back gesture', () => {
|
|||||||
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('leaves the nav highlighting the view it landed on, not the one it left', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.getByTestId('nav-albums').click();
|
||||||
|
await expectHighlighted(app, 'Albums');
|
||||||
|
|
||||||
|
await app.getByTestId('nav-tracks').click();
|
||||||
|
await expectHighlighted(app, 'Tracks');
|
||||||
|
|
||||||
|
await app.goBack();
|
||||||
|
|
||||||
|
// #72, and the half of it the report did not describe: this is
|
||||||
|
// desktop, and before the shell published the active view *both*
|
||||||
|
// navs stayed on Tracks. An absent highlight reads as a glitch; a
|
||||||
|
// confident wrong one is worse, and any back across two primary
|
||||||
|
// views produced it.
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
||||||
|
await expectHighlighted(app, 'Albums');
|
||||||
|
await expectNotHighlighted(app, 'Tracks');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('keeps the parent destination lit while a detail view is open', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.getByTestId('nav-artists').click();
|
||||||
|
await expectHighlighted(app, 'Artists');
|
||||||
|
|
||||||
|
await openAnArtist(app);
|
||||||
|
|
||||||
|
// A detail view is not a destination in either nav, and the user is
|
||||||
|
// still inside Artists. `app-sidebar` did this by accident -- it
|
||||||
|
// guarded on its own item list, so an unmatched name left the
|
||||||
|
// highlight alone -- and that accident is why the sidebar looked
|
||||||
|
// right on a detail view while the tab bar lit nothing. This test
|
||||||
|
// therefore passed before the fix and is here to keep the rule from
|
||||||
|
// being lost while the others are made to pass; the *tab bar's*
|
||||||
|
// half of it is the phone test below, which did not.
|
||||||
|
await expectHighlighted(app, 'Artists');
|
||||||
|
|
||||||
|
await app.goBack();
|
||||||
|
|
||||||
|
await expectHighlighted(app, 'Artists');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('the tab bar survives the same journey on a phone', async ({ app }) => {
|
||||||
|
await app.setViewportSize(PHONE);
|
||||||
|
|
||||||
|
// The reported shape: Albums, open an album, press back. The tab
|
||||||
|
// bar had a highlight, then no highlight at all, and never got it
|
||||||
|
// back — `bottom-nav` took the detail view's name, matched it
|
||||||
|
// against no tab, and lit nothing.
|
||||||
|
await navItem(app, 'Albums').click();
|
||||||
|
await expectHighlighted(app, 'Albums');
|
||||||
|
|
||||||
|
await app.locator('cover-grid').getByText('Glass Harbour').first().click();
|
||||||
|
await expect(activeView(app)).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'explore-album-details',
|
||||||
|
);
|
||||||
|
await expectHighlighted(app, 'Albums');
|
||||||
|
|
||||||
|
await app.goBack();
|
||||||
|
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
||||||
|
await expectHighlighted(app, 'Albums');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('the drawer sidebar opens on the page you are standing on', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize(PHONE);
|
||||||
|
|
||||||
|
await navItem(app, 'Tracks').click();
|
||||||
|
await expectHighlighted(app, 'Tracks');
|
||||||
|
|
||||||
|
// A third symptom of the same cause, found while measuring #72 and
|
||||||
|
// not in the report: `bottom-nav` mounts its `<app-sidebar>` when
|
||||||
|
// the drawer opens, so that copy had heard no `navigate` at all and
|
||||||
|
// showed its own default — Home, from any page in the app. An event
|
||||||
|
// has no answer for a listener that was not there; a store does.
|
||||||
|
await navItem(app, 'More').click();
|
||||||
|
|
||||||
|
// The element carrying the testid is the `wa-drawer` host, which
|
||||||
|
// always reports hidden -- what is visible is the `<dialog>` in its
|
||||||
|
// shadow root -- so the drawer being open is asserted of the
|
||||||
|
// sidebar it holds rather than of itself.
|
||||||
|
const drawer = app.getByTestId('nav-drawer');
|
||||||
|
|
||||||
|
await expect(drawer.locator('app-sidebar')).toBeVisible();
|
||||||
|
await expect(drawer.getByTestId('nav-tracks')).toHaveAttribute(
|
||||||
|
'aria-current',
|
||||||
|
'page',
|
||||||
|
);
|
||||||
|
await expect(drawer.getByTestId('nav-home')).toHaveAttribute(
|
||||||
|
'aria-current',
|
||||||
|
'false',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
test('an in-app back button consumes exactly one entry', async ({ app }) => {
|
test('an in-app back button consumes exactly one entry', async ({ app }) => {
|
||||||
await app.getByTestId('nav-tracks').click();
|
await app.getByTestId('nav-tracks').click();
|
||||||
await openAnArtist(app);
|
await openAnArtist(app);
|
||||||
|
|||||||
@@ -0,0 +1,318 @@
|
|||||||
|
import { test, expect } from '../support/fixtures.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* #69: the Playlists header's buttons could not be reached.
|
||||||
|
*
|
||||||
|
* Three text buttons — Import (91px), New Playlist (122px), New Smart
|
||||||
|
* Playlist (162px), 390px in total — inside a header that gets 700px at
|
||||||
|
* 900×600. "New Smart Playlist" rendered **114 of its 162px**, and at
|
||||||
|
* phone width the Android report was the plain version of it: you
|
||||||
|
* cannot scroll to reach them, and scrolling is not how page controls
|
||||||
|
* should be exposed anyway.
|
||||||
|
*
|
||||||
|
* **`layout-overflow.spec.ts` passes on the broken build**, which is why
|
||||||
|
* this file exists rather than a case being added there. That spec
|
||||||
|
* asserts the *shell* needs no sideways scrolling; clipping *inside* a
|
||||||
|
* component is invisible to it. So the measurement here is per-button
|
||||||
|
* and per-header, against the widths the app promises.
|
||||||
|
*
|
||||||
|
* Plan 018's size matrix is the promise being kept: **no action is ever
|
||||||
|
* unreachable at any supported size.** These are its three bands.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const VIEWPORTS = [
|
||||||
|
// Desktop's worst case, and not the enforced minimum: the sidebar
|
||||||
|
// collapses to icons *below* 900, so the content area is 843px at 899
|
||||||
|
// and 700px at 900. Testing "the minimum" and stopping misses it.
|
||||||
|
{ name: '900×600 (widest sidebar, narrowest content)', width: 900, height: 600 },
|
||||||
|
{ name: '800×600 (the enforced minimum)', width: 800, height: 600 },
|
||||||
|
{ name: '390×780 (phone)', width: 390, height: 780 },
|
||||||
|
// WCAG 1.4.10's reflow target, which plan 018 promises the app fits.
|
||||||
|
{ name: '320×600 (400% zoom)', width: 320, height: 600 },
|
||||||
|
];
|
||||||
|
|
||||||
|
/** Every action the Playlists header can offer, in declared order. */
|
||||||
|
const ACTIONS = ['Import', 'New Playlist', 'New Smart Playlist'];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* What the header is actually rendering, measured rather than inferred.
|
||||||
|
*
|
||||||
|
* A shadow query is the wrong tool for *asserting* — that is what
|
||||||
|
* `getByRole` below is for — but it is the right one for a measurement,
|
||||||
|
* because the number this issue is about (a button 48px wider than the
|
||||||
|
* box holding it) is not in the accessibility tree at all.
|
||||||
|
*/
|
||||||
|
const headerFit = (page: import('@playwright/test').Page) =>
|
||||||
|
page.evaluate(() => {
|
||||||
|
const root = document
|
||||||
|
.querySelector('[data-testid="main-content"] playlist-view')
|
||||||
|
?.shadowRoot?.querySelector('page-header')?.shadowRoot;
|
||||||
|
|
||||||
|
if (!root) return null;
|
||||||
|
|
||||||
|
const header = root.querySelector<HTMLElement>('.page-header')!;
|
||||||
|
const box = header.getBoundingClientRect();
|
||||||
|
const title = root.querySelector<HTMLElement>('h1')!;
|
||||||
|
|
||||||
|
const clipped = [
|
||||||
|
...root.querySelectorAll<HTMLElement>('.action, .more-button'),
|
||||||
|
]
|
||||||
|
.filter((b) => !b.hidden)
|
||||||
|
.filter((b) => {
|
||||||
|
const r = b.getBoundingClientRect();
|
||||||
|
|
||||||
|
return r.right > box.right + 1 || r.left < box.left - 1;
|
||||||
|
})
|
||||||
|
.map((b) => b.dataset['actionId'] ?? 'more');
|
||||||
|
|
||||||
|
return {
|
||||||
|
overflow: header.scrollWidth - header.clientWidth,
|
||||||
|
clipped,
|
||||||
|
titleTruncated: title.scrollWidth > title.clientWidth + 1,
|
||||||
|
buttons: [...root.querySelectorAll<HTMLElement>('.action')]
|
||||||
|
.filter((b) => !b.hidden)
|
||||||
|
.map((b) => b.textContent?.trim() ?? ''),
|
||||||
|
menu: [
|
||||||
|
...root.querySelectorAll('#page-header-overflow wa-dropdown-item'),
|
||||||
|
].map((i) => i.textContent?.trim() ?? ''),
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
test.describe('the page header never clips an action', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.getByTestId('nav-playlists').click();
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'playlists',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test.afterEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 1280, height: 800 });
|
||||||
|
});
|
||||||
|
|
||||||
|
for (const vp of VIEWPORTS) {
|
||||||
|
test(`every action is reachable at ${vp.name}`, async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: vp.width, height: vp.height });
|
||||||
|
|
||||||
|
// Polled: the fit is decided by a ResizeObserver, so it settles a
|
||||||
|
// frame after the resize rather than with it.
|
||||||
|
await expect
|
||||||
|
.poll(async () => (await headerFit(app))?.clipped)
|
||||||
|
.toEqual([]);
|
||||||
|
|
||||||
|
const fit = (await headerFit(app))!;
|
||||||
|
|
||||||
|
expect(fit.overflow).toBeLessThanOrEqual(0);
|
||||||
|
|
||||||
|
// Between them, buttons and menu account for all three. This is
|
||||||
|
// the assertion the issue asks for: not "it fits" but "nothing
|
||||||
|
// was dropped to make it fit".
|
||||||
|
expect([...fit.buttons, ...fit.menu].sort()).toEqual([...ACTIONS].sort());
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The title gives way before an action does.
|
||||||
|
*
|
||||||
|
* Once the heading can ellipsis it absorbs the pressure, and
|
||||||
|
* `scrollWidth` then reports a header that fits perfectly while the
|
||||||
|
* heading reads "Playlis…" — this issue's own failure mode moved from
|
||||||
|
* the button to the title, and invisible to exactly the measurement
|
||||||
|
* that missed it the first time. At the desktop sizes there is always
|
||||||
|
* an action to collapse instead.
|
||||||
|
*/
|
||||||
|
test('does not truncate the heading to keep a button', async ({ app }) => {
|
||||||
|
for (const vp of VIEWPORTS.slice(0, 2)) {
|
||||||
|
await app.setViewportSize({ width: vp.width, height: vp.height });
|
||||||
|
|
||||||
|
await expect
|
||||||
|
.poll(async () => (await headerFit(app))?.titleTruncated)
|
||||||
|
.toBe(false);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Asserted through the accessibility tree, never a shadow query. An
|
||||||
|
* overflow menu is exactly the shape that grows a nameless control,
|
||||||
|
* and this repo has shipped one four times — most recently the
|
||||||
|
* queue's own close button.
|
||||||
|
*/
|
||||||
|
test('the overflow is a named control that opens a named menu', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize({ width: 900, height: 600 });
|
||||||
|
|
||||||
|
const more = app.getByRole('button', { name: 'More actions' });
|
||||||
|
|
||||||
|
await expect(more).toBeVisible();
|
||||||
|
await expect(more).toHaveAttribute('aria-expanded', 'false');
|
||||||
|
|
||||||
|
await more.click();
|
||||||
|
|
||||||
|
await expect(more).toHaveAttribute('aria-expanded', 'true');
|
||||||
|
|
||||||
|
const menu = app.getByRole('menu', { name: 'More actions' });
|
||||||
|
|
||||||
|
await expect(menu).toBeVisible();
|
||||||
|
|
||||||
|
// Collapsed at 900×600: Import (lowest priority) and New Smart
|
||||||
|
// Playlist. New Playlist stays a button because it is the drop
|
||||||
|
// target, and a closed menu cannot be one.
|
||||||
|
await expect(
|
||||||
|
menu.getByRole('menuitem', { name: 'Import' }),
|
||||||
|
).toBeVisible();
|
||||||
|
await expect(
|
||||||
|
app.getByRole('button', { name: 'New Playlist', exact: true }),
|
||||||
|
).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The phone case is the original report. Every action is in the menu
|
||||||
|
* at 390px, and the menu is reachable by name — which is the whole of
|
||||||
|
* "these need to be reachable in a sensible way".
|
||||||
|
*/
|
||||||
|
test('offers every action from the menu on a phone', async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 390, height: 780 });
|
||||||
|
|
||||||
|
const more = app.getByRole('button', { name: 'More actions' });
|
||||||
|
|
||||||
|
await expect(more).toBeVisible();
|
||||||
|
await more.click();
|
||||||
|
|
||||||
|
const menu = app.getByRole('menu', { name: 'More actions' });
|
||||||
|
|
||||||
|
for (const label of ACTIONS) {
|
||||||
|
await expect(menu.getByRole('menuitem', { name: label })).toBeVisible();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Escape closes it and focus goes back to the trigger — `MenuKeyboard`
|
||||||
|
* is shared with every other menu in the app precisely so this is not
|
||||||
|
* a second keyboard model, and this is what proves it was wired up
|
||||||
|
* rather than merely imported.
|
||||||
|
*/
|
||||||
|
test('takes the keyboard, and gives it back', async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 900, height: 600 });
|
||||||
|
|
||||||
|
const more = app.getByRole('button', { name: 'More actions' });
|
||||||
|
|
||||||
|
await more.click();
|
||||||
|
|
||||||
|
const menu = app.getByRole('menu', { name: 'More actions' });
|
||||||
|
|
||||||
|
await expect(menu).toBeVisible();
|
||||||
|
|
||||||
|
// The first item takes focus on open. `wa-dropdown-item` sets its
|
||||||
|
// own role in its own first update, so this is polled rather than
|
||||||
|
// read: a query at the host's updateComplete finds nothing, which
|
||||||
|
// reads exactly like a menu that refused to take focus.
|
||||||
|
await expect
|
||||||
|
.poll(async () =>
|
||||||
|
app.evaluate(() => {
|
||||||
|
// Stops where `MenuKeyboard`'s own `deepActiveElement` stops:
|
||||||
|
// on the *host* whose shadow root has no active element.
|
||||||
|
// Descending unconditionally lands inside the focused
|
||||||
|
// `wa-dropdown-item`'s own shadow root, where nothing is
|
||||||
|
// focused — which reads exactly like a menu that refused the
|
||||||
|
// keyboard, on a build where it did not.
|
||||||
|
let el = document.activeElement;
|
||||||
|
|
||||||
|
while (el?.shadowRoot?.activeElement) el = el.shadowRoot.activeElement;
|
||||||
|
|
||||||
|
return el?.textContent?.trim() ?? null;
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
.toBe('Import');
|
||||||
|
|
||||||
|
await app.keyboard.press('Escape');
|
||||||
|
|
||||||
|
await expect(more).toHaveAttribute('aria-expanded', 'false');
|
||||||
|
await expect(more).toBeFocused();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* New Playlist is a drop target, and declaring it as data must not
|
||||||
|
* take that away — which is why a `PageAction` carries the drop
|
||||||
|
* handlers rather than the header owning a notion of dropping.
|
||||||
|
*
|
||||||
|
* Nothing covered this before, in either tier, and it is the one
|
||||||
|
* behaviour the migration could plausibly have destroyed silently:
|
||||||
|
* dragging still *looks* fine against a button that no longer
|
||||||
|
* accepts anything.
|
||||||
|
*/
|
||||||
|
test('New Playlist still accepts a dropped track', async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 1280, height: 800 });
|
||||||
|
|
||||||
|
const button = app.getByRole('button', {
|
||||||
|
name: 'New Playlist',
|
||||||
|
exact: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(button).toBeVisible();
|
||||||
|
|
||||||
|
const result = await app.evaluate(async () => {
|
||||||
|
const view = document.querySelector(
|
||||||
|
'[data-testid="main-content"] playlist-view',
|
||||||
|
)!;
|
||||||
|
const target = view.shadowRoot!
|
||||||
|
.querySelector('page-header')!
|
||||||
|
.shadowRoot!.querySelector('[data-testid="page-action-new-playlist"]')!;
|
||||||
|
|
||||||
|
const data = new DataTransfer();
|
||||||
|
|
||||||
|
data.setData(
|
||||||
|
'application/x-yj-tracks',
|
||||||
|
JSON.stringify({ filePaths: ['/tmp/dropped.mp3'] }),
|
||||||
|
);
|
||||||
|
|
||||||
|
const fire = (type: string) =>
|
||||||
|
target.dispatchEvent(
|
||||||
|
new DragEvent(type, {
|
||||||
|
bubbles: true,
|
||||||
|
cancelable: true,
|
||||||
|
dataTransfer: data,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
fire('dragover');
|
||||||
|
await new Promise((r) => setTimeout(r, 50));
|
||||||
|
|
||||||
|
// The affordance is the host's state reaching the header's
|
||||||
|
// button, which is the half a plain handler call would not prove.
|
||||||
|
const highlighted = target.classList.contains('drag-over');
|
||||||
|
|
||||||
|
fire('drop');
|
||||||
|
await new Promise((r) => setTimeout(r, 200));
|
||||||
|
|
||||||
|
return {
|
||||||
|
highlighted,
|
||||||
|
opened: view.shadowRoot!.querySelector('.create-form') !== null,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toEqual({ highlighted: true, opened: true });
|
||||||
|
|
||||||
|
// Leave the view as it was found.
|
||||||
|
await app.keyboard.press('Escape');
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An action given back when the window widens again. The collapsed
|
||||||
|
* set is a function of the current width and not of how it got there
|
||||||
|
* — a rule that only ever *added* to it would never widen.
|
||||||
|
*/
|
||||||
|
test('gives the buttons back when the window grows', async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 390, height: 780 });
|
||||||
|
|
||||||
|
await expect.poll(async () => (await headerFit(app))?.buttons).toEqual([]);
|
||||||
|
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
|
||||||
|
await expect
|
||||||
|
.poll(async () => (await headerFit(app))?.buttons)
|
||||||
|
.toEqual(ACTIONS);
|
||||||
|
await expect.poll(async () => (await headerFit(app))?.menu).toEqual([]);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -40,6 +40,7 @@ import { setBasePath } from '@awesome.me/webawesome/dist/webawesome.js';
|
|||||||
import { registerBundledIcons } from './src/icons';
|
import { registerBundledIcons } from './src/icons';
|
||||||
import { queueStore } from '@store/queue-store';
|
import { queueStore } from '@store/queue-store';
|
||||||
import { searchStore } from '@store/search-store';
|
import { searchStore } from '@store/search-store';
|
||||||
|
import { activeViewStore } from '@store/active-view-store';
|
||||||
import * as Player from '@go/player/player.js';
|
import * as Player from '@go/player/player.js';
|
||||||
import * as Queue from '@go/queue/queue.js';
|
import * as Queue from '@go/queue/queue.js';
|
||||||
import { GetDefaultPage } from '@go/config/config.js';
|
import { GetDefaultPage } from '@go/config/config.js';
|
||||||
@@ -279,6 +280,20 @@ async function handleNavigate(
|
|||||||
// attribute keeps e2e selectors semantic instead of structural.
|
// attribute keeps e2e selectors semantic instead of structural.
|
||||||
mainContent.dataset.activeView = view;
|
mainContent.dataset.activeView = view;
|
||||||
|
|
||||||
|
// And publishing it as a *value* is what the nav components read.
|
||||||
|
// They used to learn the active view from the `navigate` event,
|
||||||
|
// which only the outbound path dispatches -- so a back-navigation
|
||||||
|
// left both of them highlighting the view it had just left (#72).
|
||||||
|
// Re-dispatching `navigate` here is not the fix: this file is a
|
||||||
|
// document listener for it, so that is an infinite loop, and
|
||||||
|
// "please go to X" is not the statement being made.
|
||||||
|
//
|
||||||
|
// `view in VIEW_TAGS` is the primary/detail split, and it is passed
|
||||||
|
// rather than re-derived because this table is where it is written
|
||||||
|
// down. A detail view therefore leaves the tab it was opened from
|
||||||
|
// lit, which is what the report asks for.
|
||||||
|
activeViewStore.setView(view, view in VIEW_TAGS);
|
||||||
|
|
||||||
// --- Primary (cacheable) views ----------------------------------------
|
// --- Primary (cacheable) views ----------------------------------------
|
||||||
if (view in VIEW_TAGS) {
|
if (view in VIEW_TAGS) {
|
||||||
// Remove any active detail view first
|
// Remove any active detail view first
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2026 Fonticons, Inc. --><path fill="currentColor" d="M0 256a56 56 0 1 1 112 0 56 56 0 1 1 -112 0zm168 0a56 56 0 1 1 112 0 56 56 0 1 1 -112 0zm224-56a56 56 0 1 1 0 112 56 56 0 1 1 0-112z"/></svg>
|
||||||
|
After Width: | Height: | Size: 443 B |
@@ -7,6 +7,7 @@ import { designTokens } from '../../styles/tokens.css';
|
|||||||
import '../sidebar/app-sidebar.js';
|
import '../sidebar/app-sidebar.js';
|
||||||
import { nameDialog } from '@utils/name-dialog';
|
import { nameDialog } from '@utils/name-dialog';
|
||||||
import { ICON_PLAYLIST } from '@utils/icon-language';
|
import { ICON_PLAYLIST } from '@utils/icon-language';
|
||||||
|
import { ActiveViewController } from '@store/controllers/active-view-controller';
|
||||||
|
|
||||||
type View = 'home' | 'albums' | 'tracks' | 'playlists';
|
type View = 'home' | 'albums' | 'tracks' | 'playlists';
|
||||||
|
|
||||||
@@ -114,8 +115,19 @@ export class BottomNav extends LitElement {
|
|||||||
}
|
}
|
||||||
`];
|
`];
|
||||||
|
|
||||||
@state()
|
/**
|
||||||
private activeView = 'home';
|
* Which tab is lit, read from the shell rather than tracked here.
|
||||||
|
*
|
||||||
|
* This was a `@state()` field set from the `navigate` event, which
|
||||||
|
* only the outbound path dispatches -- so backing out of a detail
|
||||||
|
* view left the highlight wherever it had been (#72). It had no
|
||||||
|
* equivalent of `app-sidebar`'s `navItems.some(...)` guard either,
|
||||||
|
* so a detail view set it to a name matching no tab and *nothing*
|
||||||
|
* was lit; that asymmetry is why one nav looked broken and the
|
||||||
|
* other looked fine. The store answers both: a detail view leaves
|
||||||
|
* the tab it was opened from lit, in both components.
|
||||||
|
*/
|
||||||
|
private activeCtrl = new ActiveViewController(this);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Whether the drawer has been asked for.
|
* Whether the drawer has been asked for.
|
||||||
@@ -167,12 +179,9 @@ export class BottomNav extends LitElement {
|
|||||||
nameDialog(this.drawer);
|
nameDialog(this.drawer);
|
||||||
}
|
}
|
||||||
|
|
||||||
private onGlobalNavigate = (e: Event) => {
|
private onGlobalNavigate = () => {
|
||||||
const detail = (e as CustomEvent<{ view?: string }>).detail;
|
|
||||||
|
|
||||||
if (detail?.view) this.activeView = detail.view;
|
|
||||||
|
|
||||||
// A navigation from inside the drawer is the drawer's job done.
|
// A navigation from inside the drawer is the drawer's job done.
|
||||||
|
// The highlight is not this listener's business any more.
|
||||||
this.drawerOpen = false;
|
this.drawerOpen = false;
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -206,9 +215,11 @@ export class BottomNav extends LitElement {
|
|||||||
<li>
|
<li>
|
||||||
<button
|
<button
|
||||||
type="button"
|
type="button"
|
||||||
class=${this.activeView === tab.id ? 'active' : ''}
|
class=${this.activeCtrl.isActive(tab.id)
|
||||||
|
? 'active'
|
||||||
|
: ''}
|
||||||
data-testid="tab-${tab.id}"
|
data-testid="tab-${tab.id}"
|
||||||
aria-current=${this.activeView === tab.id
|
aria-current=${this.activeCtrl.isActive(tab.id)
|
||||||
? 'page'
|
? 'page'
|
||||||
: 'false'}
|
: 'false'}
|
||||||
@click=${() => this.navigate(tab.id)}
|
@click=${() => this.navigate(tab.id)}
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import { customElement, state } from 'lit/decorators.js';
|
|||||||
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||||
import '@awesome.me/webawesome/dist/components/button/button.js';
|
import '@awesome.me/webawesome/dist/components/button/button.js';
|
||||||
import '@components/page-header/page-header';
|
import '@components/page-header/page-header';
|
||||||
|
import type { PageAction } from '@components/page-header/page-header';
|
||||||
import { designTokens } from '../../styles/tokens.css';
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
import { downloadStore, stateLabel } from '@store/download-store';
|
import { downloadStore, stateLabel } from '@store/download-store';
|
||||||
import type { Request, RequestSummary, DownloadView as DownloadRecord } from '@store/download-store';
|
import type { Request, RequestSummary, DownloadView as DownloadRecord } from '@store/download-store';
|
||||||
@@ -246,23 +247,23 @@ export class DownloadsView extends ViewLifecycleMixin(LitElement) {
|
|||||||
|
|
||||||
override render() {
|
override render() {
|
||||||
return html`
|
return html`
|
||||||
<page-header heading="Downloads">
|
<page-header
|
||||||
${this.tab === 'requests'
|
heading="Downloads"
|
||||||
? html`
|
.actions=${this.tab === 'requests'
|
||||||
<wa-button
|
? ([
|
||||||
slot="actions"
|
{
|
||||||
size="small"
|
id: 'check-now',
|
||||||
appearance="outlined"
|
label: this.checking
|
||||||
?disabled=${this.checking}
|
? 'Searching\u2026'
|
||||||
title="Search every download client for everything on this list right now, instead of waiting for the next scheduled check"
|
: 'Check now',
|
||||||
@click=${() => void this.checkNow()}
|
icon: 'rotate',
|
||||||
>
|
disabled: this.checking,
|
||||||
<wa-icon slot="start" name="rotate"></wa-icon>
|
title: 'Search every download client for everything on this list right now, instead of waiting for the next scheduled check',
|
||||||
${this.checking ? 'Searching…' : 'Check now'}
|
onSelect: () => void this.checkNow(),
|
||||||
</wa-button>
|
},
|
||||||
`
|
] satisfies PageAction[])
|
||||||
: nothing}
|
: []}
|
||||||
</page-header>
|
></page-header>
|
||||||
|
|
||||||
<p class="subtitle">
|
<p class="subtitle">
|
||||||
Music you have requested, and the download attempts that
|
Music you have requested, and the download attempts that
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
import { LitElement, html, css, nothing } from 'lit';
|
import { LitElement, html, css, nothing } from 'lit';
|
||||||
import { customElement, state } from 'lit/decorators.js';
|
import { customElement, state } from 'lit/decorators.js';
|
||||||
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||||
import '@awesome.me/webawesome/dist/components/button/button.js';
|
|
||||||
import { GetShelves } from '@go/home/service.js';
|
import { GetShelves } from '@go/home/service.js';
|
||||||
|
import { ICON_SHUFFLE } from '@utils/icon-language';
|
||||||
|
import type { PageAction } from '@components/page-header/page-header';
|
||||||
import { GetAlbumTracks } from '@go/library/library.js';
|
import { GetAlbumTracks } from '@go/library/library.js';
|
||||||
import type * as home from '@go/home/models.js';
|
import type * as home from '@go/home/models.js';
|
||||||
import type * as library from '@go/library/models.js';
|
import type * as library from '@go/library/models.js';
|
||||||
@@ -283,23 +284,24 @@ export class HomeView extends ViewLifecycleMixin(LitElement) {
|
|||||||
|
|
||||||
override render() {
|
override render() {
|
||||||
return html`
|
return html`
|
||||||
<page-header heading="Home">
|
<page-header
|
||||||
<!-- "Shuffle" alone was two different controls with one
|
heading="Home"
|
||||||
name: this one and the transport's shuffle mode.
|
.actions=${[
|
||||||
They were never on screen together until the app
|
{
|
||||||
started landing on Home (H-8), and a cached view is
|
// "Shuffle" alone was two different controls
|
||||||
in the accessibility tree either way. -->
|
// with one name: this one and the transport's
|
||||||
<wa-button
|
// shuffle mode. They were never on screen
|
||||||
slot="actions"
|
// together until the app started landing on
|
||||||
size="small"
|
// Home (H-8), and a cached view is in the
|
||||||
appearance="plain"
|
// accessibility tree either way.
|
||||||
title="Reshuffle the suggestions"
|
id: 'shuffle-suggestions',
|
||||||
@click=${() => void this.load()}
|
label: 'Shuffle suggestions',
|
||||||
>
|
icon: ICON_SHUFFLE,
|
||||||
<wa-icon slot="start" name="shuffle"></wa-icon>
|
title: 'Reshuffle the suggestions',
|
||||||
Shuffle suggestions
|
onSelect: () => void this.load(),
|
||||||
</wa-button>
|
},
|
||||||
</page-header>
|
] satisfies PageAction[]}
|
||||||
|
></page-header>
|
||||||
<p class="lede">Somewhere to start listening.</p>
|
<p class="lede">Somewhere to start listening.</p>
|
||||||
${this.renderBody()}
|
${this.renderBody()}
|
||||||
`;
|
`;
|
||||||
|
|||||||
@@ -1,8 +1,16 @@
|
|||||||
import { LitElement, html, css, nothing } from 'lit';
|
import { LitElement, html, css, nothing } from 'lit';
|
||||||
import { customElement, property } from 'lit/decorators.js';
|
import { customElement, property, query, state } from 'lit/decorators.js';
|
||||||
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||||
|
import '@awesome.me/webawesome/dist/components/popup/popup.js';
|
||||||
|
import '@awesome.me/webawesome/dist/components/dropdown-item/dropdown-item.js';
|
||||||
|
import type WaPopup from '@awesome.me/webawesome/dist/components/popup/popup.js';
|
||||||
|
|
||||||
import { designTokens } from '../../styles/tokens.css';
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
|
import {
|
||||||
|
MenuKeyboard,
|
||||||
|
contextMenuStyles,
|
||||||
|
} from '../../utils/context-menu-controller';
|
||||||
|
import { ICON_MORE_ACTIONS } from '../../utils/icon-language';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The one arrangement every primary view uses to say what it is.
|
* The one arrangement every primary view uses to say what it is.
|
||||||
@@ -18,6 +26,19 @@ import { designTokens } from '../../styles/tokens.css';
|
|||||||
* Title, count, sort, actions — in that order, in one component, so a
|
* Title, count, sort, actions — in that order, in one component, so a
|
||||||
* new view gets the shape by using it rather than by copying whichever
|
* new view gets the shape by using it rather than by copying whichever
|
||||||
* neighbour it happened to read.
|
* neighbour it happened to read.
|
||||||
|
*
|
||||||
|
* **Actions are data, and `<slot name="actions">` is the exception.**
|
||||||
|
* Playlists' three buttons totalled 390px inside a header that gets
|
||||||
|
* 700px at 900×600 and clipped "New Smart Playlist" to 114 of its 162
|
||||||
|
* (#69) — a live defect at a size the app promises, against plan 018's
|
||||||
|
* *no action is ever unreachable at any supported size*. The header
|
||||||
|
* cannot fix that for slotted markup: it cannot move another
|
||||||
|
* component's light-DOM children into a dropdown and keep their
|
||||||
|
* behaviour, and arbitrary markup offers nothing generic to render as
|
||||||
|
* a menu item. So a host declares `PageAction[]` and the header picks
|
||||||
|
* the rendering. The slot survives for markup a data list genuinely
|
||||||
|
* cannot express, at the stated cost that **a slotted action does not
|
||||||
|
* collapse** and must therefore fit at 800×600.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export interface SortOption {
|
export interface SortOption {
|
||||||
@@ -27,6 +48,50 @@ export interface SortOption {
|
|||||||
|
|
||||||
export type SortDirection = 'asc' | 'desc';
|
export type SortDirection = 'asc' | 'desc';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An action that only makes sense while it is a button.
|
||||||
|
*
|
||||||
|
* A drop target is the case: you cannot drag a track onto a closed
|
||||||
|
* menu, so the affordance is absent from the overflow rather than
|
||||||
|
* approximated there. The header wires these onto the button it
|
||||||
|
* renders and owns none of them — the same division the sort control
|
||||||
|
* already lives by.
|
||||||
|
*/
|
||||||
|
export interface PageActionDrop {
|
||||||
|
/** True while an acceptable payload is over the button. */
|
||||||
|
active?: boolean;
|
||||||
|
onDragOver: (e: DragEvent) => void;
|
||||||
|
onDragLeave: (e: DragEvent) => void;
|
||||||
|
onDrop: (e: DragEvent) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* One thing a view can do, as data rather than as markup.
|
||||||
|
*
|
||||||
|
* `<slot name="actions">` cannot be collapsed, and that is a fact about
|
||||||
|
* the API rather than an effort estimate (#69): a component cannot move
|
||||||
|
* another component's light-DOM children into a dropdown and keep their
|
||||||
|
* behaviour, and there is nothing generic in arbitrary markup to render
|
||||||
|
* as a menu item. Declaring an action instead is what lets the header
|
||||||
|
* choose between the two renderings.
|
||||||
|
*/
|
||||||
|
export interface PageAction {
|
||||||
|
id: string;
|
||||||
|
label: string;
|
||||||
|
/** From `utils/icon-language`, never a literal. */
|
||||||
|
icon: string;
|
||||||
|
onSelect: () => void;
|
||||||
|
/**
|
||||||
|
* Higher survives longer. The lowest collapses first, ties broken
|
||||||
|
* by declaration order from the right, so a host that says nothing
|
||||||
|
* gets "the last one written goes first".
|
||||||
|
*/
|
||||||
|
priority?: number;
|
||||||
|
disabled?: boolean;
|
||||||
|
title?: string;
|
||||||
|
drop?: PageActionDrop;
|
||||||
|
}
|
||||||
|
|
||||||
@customElement('page-header')
|
@customElement('page-header')
|
||||||
export class PageHeader extends LitElement {
|
export class PageHeader extends LitElement {
|
||||||
/**
|
/**
|
||||||
@@ -80,8 +145,82 @@ export class PageHeader extends LitElement {
|
|||||||
@property({ type: Boolean })
|
@property({ type: Boolean })
|
||||||
busy = false;
|
busy = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* What this view can do, in the order it wants them shown.
|
||||||
|
*
|
||||||
|
* The header decides what *fits*; the host decides what *happens*.
|
||||||
|
* That is the rule the sort control already lives by — it asks for
|
||||||
|
* a sort rather than performing one — and actions follow it, which
|
||||||
|
* is why an action carries a handler rather than the header
|
||||||
|
* carrying a verb it would have to interpret.
|
||||||
|
*/
|
||||||
|
@property({ attribute: false })
|
||||||
|
actions: PageAction[] = [];
|
||||||
|
|
||||||
|
/** Action ids currently in the overflow menu. Derived, never set by a host. */
|
||||||
|
@state()
|
||||||
|
private collapsed: ReadonlySet<string> = new Set();
|
||||||
|
|
||||||
|
@state()
|
||||||
|
private menuOpen = false;
|
||||||
|
|
||||||
|
@query('.page-header')
|
||||||
|
private headerEl?: HTMLElement;
|
||||||
|
|
||||||
|
@query('.more-button')
|
||||||
|
private moreButton?: HTMLButtonElement;
|
||||||
|
|
||||||
|
@query('#page-header-overflow')
|
||||||
|
private menuPanel?: HTMLElement;
|
||||||
|
|
||||||
|
@query('wa-popup')
|
||||||
|
private popup?: WaPopup;
|
||||||
|
|
||||||
|
private menuKeyboard = new MenuKeyboard(() => this.closeMenu());
|
||||||
|
|
||||||
|
private resizeObserver?: ResizeObserver;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the outside-click listener is attached.
|
||||||
|
*
|
||||||
|
* A `removeEventListener` with no matching `add` is not harmless
|
||||||
|
* here: `view-lifecycle.test.ts` counts document listeners across a
|
||||||
|
* view's life and an unconditional detach on disconnect shows up as
|
||||||
|
* `held: -1`, which is the same accounting that would hide a real
|
||||||
|
* leak in the other direction.
|
||||||
|
*/
|
||||||
|
private outsideCloseAttached = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* What the last fit was measured against.
|
||||||
|
*
|
||||||
|
* `updated()` runs on every pass, so it has to say what it depends
|
||||||
|
* on or it re-measures — and a measurement here forces synchronous
|
||||||
|
* layout. Width changes arrive through the ResizeObserver; this key
|
||||||
|
* covers everything *else* in the flex row that can change how much
|
||||||
|
* of it the actions are left.
|
||||||
|
|
||||||
|
*/
|
||||||
|
private lastFitKey = '';
|
||||||
|
|
||||||
|
override connectedCallback(): void {
|
||||||
|
super.connectedCallback();
|
||||||
|
|
||||||
|
this.resizeObserver = new ResizeObserver(() => this.measureFit());
|
||||||
|
this.resizeObserver.observe(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
override disconnectedCallback(): void {
|
||||||
|
super.disconnectedCallback();
|
||||||
|
|
||||||
|
this.resizeObserver?.disconnect();
|
||||||
|
this.resizeObserver = undefined;
|
||||||
|
this.detachOutsideClose();
|
||||||
|
}
|
||||||
|
|
||||||
static override styles = [
|
static override styles = [
|
||||||
designTokens,
|
designTokens,
|
||||||
|
contextMenuStyles,
|
||||||
css`
|
css`
|
||||||
:host {
|
:host {
|
||||||
display: block;
|
display: block;
|
||||||
@@ -96,12 +235,26 @@ export class PageHeader extends LitElement {
|
|||||||
border-bottom: 1px solid var(--yj-border-subtle, #333);
|
border-bottom: 1px solid var(--yj-border-subtle, #333);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* The title gives way before an action does.
|
||||||
|
|
||||||
|
Everything in this row was flex-shrink: 0, so whatever
|
||||||
|
came last lost — and the actions come last, which is how
|
||||||
|
the "More actions" button ended up 76px off the right
|
||||||
|
edge of a 320px viewport with every action already
|
||||||
|
collapsed into it. The title is the one thing here the
|
||||||
|
navigation also says (the sidebar item is selected, the
|
||||||
|
bottom-nav tab is current), so it is the cheapest thing
|
||||||
|
to truncate; the count, the sort and the actions are each
|
||||||
|
the only place they are said. */
|
||||||
h1 {
|
h1 {
|
||||||
margin: 0;
|
margin: 0;
|
||||||
font-size: var(--yj-text-xl, 18px);
|
font-size: var(--yj-text-xl, 18px);
|
||||||
font-weight: 600;
|
font-weight: 600;
|
||||||
color: var(--yj-text-primary, #fff);
|
color: var(--yj-text-primary, #fff);
|
||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
min-width: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.count {
|
.count {
|
||||||
@@ -191,6 +344,98 @@ export class PageHeader extends LitElement {
|
|||||||
::slotted(*) {
|
::slotted(*) {
|
||||||
flex-shrink: 0;
|
flex-shrink: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.actions {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.action,
|
||||||
|
.more-button {
|
||||||
|
background: none;
|
||||||
|
border: 1px solid var(--yj-border-subtle, #555);
|
||||||
|
border-radius: 4px;
|
||||||
|
color: var(--yj-text-primary, #fff);
|
||||||
|
padding: 6px 12px;
|
||||||
|
font-size: var(--yj-text-md, 13px);
|
||||||
|
font-family: inherit;
|
||||||
|
cursor: pointer;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 6px;
|
||||||
|
white-space: nowrap;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.more-button {
|
||||||
|
padding: 6px 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* The display: flex above outranks the UA stylesheet's
|
||||||
|
rule for [hidden], and hiding is how an action
|
||||||
|
collapses. (No backticks in here: one ends the css
|
||||||
|
literal, and what you get is "css(...) is not a
|
||||||
|
function" a long way from the cause.) */
|
||||||
|
.action[hidden],
|
||||||
|
.more-button[hidden] {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.action:hover,
|
||||||
|
.more-button:hover,
|
||||||
|
.action.drag-over {
|
||||||
|
border-color: var(--yj-accent, #ffd43b);
|
||||||
|
color: var(--yj-accent-text, #ffd43b);
|
||||||
|
}
|
||||||
|
|
||||||
|
.action.drag-over {
|
||||||
|
background-color: var(
|
||||||
|
--yj-accent-bg-strong,
|
||||||
|
rgba(255, 212, 59, 0.15)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
.action:disabled {
|
||||||
|
opacity: 0.5;
|
||||||
|
cursor: default;
|
||||||
|
}
|
||||||
|
|
||||||
|
.action:focus-visible,
|
||||||
|
.more-button:focus-visible {
|
||||||
|
outline: 2px solid var(--yj-accent, #ffd43b);
|
||||||
|
outline-offset: -1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
wa-popup {
|
||||||
|
z-index: 200;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* A component states what it drops at phone width itself,
|
||||||
|
in its own stylesheet, because a media query inside a
|
||||||
|
shadow root is answered by the viewport and the shell
|
||||||
|
cannot reach in. Here that is one word: the sort control
|
||||||
|
is 172px of a 320px header, and "Sort:" is ~40px of it
|
||||||
|
for a label the adjacent direction arrow already implies.
|
||||||
|
It stays in the accessibility tree — it is the select's
|
||||||
|
accessible name, so hiding it outright would rename the
|
||||||
|
control to nothing — which is config-field's bug, one
|
||||||
|
component over. clip-path rather than display: none for
|
||||||
|
the reason styles/sr-only.css.ts gives. */
|
||||||
|
@media (max-width: 599px) {
|
||||||
|
.sort-label {
|
||||||
|
position: absolute;
|
||||||
|
width: 1px;
|
||||||
|
height: 1px;
|
||||||
|
margin: -1px;
|
||||||
|
padding: 0;
|
||||||
|
overflow: hidden;
|
||||||
|
clip-path: inset(50%);
|
||||||
|
white-space: nowrap;
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
`,
|
`,
|
||||||
];
|
];
|
||||||
|
|
||||||
@@ -212,11 +457,293 @@ export class PageHeader extends LitElement {
|
|||||||
${this.renderCount()}
|
${this.renderCount()}
|
||||||
<div class="spacer"></div>
|
<div class="spacer"></div>
|
||||||
${this.renderScope()} ${this.renderSort()}
|
${this.renderScope()} ${this.renderSort()}
|
||||||
|
${this.renderActions()}
|
||||||
<slot name="actions"></slot>
|
<slot name="actions"></slot>
|
||||||
</header>
|
</header>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected override updated(): void {
|
||||||
|
const key = [
|
||||||
|
this.heading,
|
||||||
|
this.count,
|
||||||
|
this.countNoun,
|
||||||
|
this.countPlural,
|
||||||
|
this.searchTerm,
|
||||||
|
this.sortOptions.length,
|
||||||
|
this.sortField,
|
||||||
|
this.sortDirection,
|
||||||
|
this.busy,
|
||||||
|
this.actions.map((a) => `${a.id}:${a.label}:${a.disabled ?? false}`).join(','),
|
||||||
|
].join('|');
|
||||||
|
|
||||||
|
if (key === this.lastFitKey) return;
|
||||||
|
|
||||||
|
this.lastFitKey = key;
|
||||||
|
this.measureFit();
|
||||||
|
}
|
||||||
|
|
||||||
|
// =================================================================
|
||||||
|
// What fits
|
||||||
|
// =================================================================
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Decide which actions are buttons and which are menu items.
|
||||||
|
*
|
||||||
|
* Two things about the shape of this are load-bearing.
|
||||||
|
*
|
||||||
|
* **Every pass starts from all-visible**, so the collapsed set is a
|
||||||
|
* pure function of the current width rather than of the order the
|
||||||
|
* widths arrived in. A rule that only ever *added* to the set would
|
||||||
|
* never give an action back when the window grew, and one that
|
||||||
|
* adjusted by a step would need a hysteresis band to stop it
|
||||||
|
* oscillating on the pixel where a button exactly fits.
|
||||||
|
*
|
||||||
|
* **It flips `hidden` on the rendered nodes rather than re-rendering
|
||||||
|
* between steps.** Reading `scrollWidth` forces layout, which is the
|
||||||
|
* point; awaiting a Lit update between steps instead would let the
|
||||||
|
* intermediate all-visible state paint, so the fix would flash the
|
||||||
|
* overflow it exists to prevent. The reactive state is set once, at
|
||||||
|
* the end, and the next render agrees with what was measured.
|
||||||
|
*
|
||||||
|
* The budget is the *header's* overflow and not the actions row's,
|
||||||
|
* because the count and the sort control are `flex-shrink: 0` and
|
||||||
|
* are therefore competing for the same width — only `.scope` gives
|
||||||
|
* way, which is what it has an ellipsis for.
|
||||||
|
*/
|
||||||
|
private measureFit(): void {
|
||||||
|
const header = this.headerEl;
|
||||||
|
|
||||||
|
if (!header) return;
|
||||||
|
|
||||||
|
if (this.actions.length === 0) {
|
||||||
|
this.commitCollapsed(new Set());
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const buttons = new Map<string, HTMLElement>();
|
||||||
|
|
||||||
|
for (const el of this.renderRoot.querySelectorAll<HTMLElement>(
|
||||||
|
'[data-action-id]',
|
||||||
|
)) {
|
||||||
|
const id = el.dataset['actionId'];
|
||||||
|
|
||||||
|
if (id !== undefined) buttons.set(id, el);
|
||||||
|
}
|
||||||
|
|
||||||
|
const more = this.moreButton;
|
||||||
|
const title = this.renderRoot.querySelector('h1');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Nothing is clipped — which is not the same as the header not
|
||||||
|
* overflowing, and the difference is a trap worth naming.
|
||||||
|
*
|
||||||
|
* Once the title can ellipsis, it absorbs the pressure and
|
||||||
|
* `scrollWidth` reports a header that fits perfectly while the
|
||||||
|
* heading reads "Playlis…". That is this issue's own failure
|
||||||
|
* mode moved from the button to the title, and it is invisible
|
||||||
|
* to exactly the same measurement that missed it the first time.
|
||||||
|
* So the title's own truncation counts as not fitting, and
|
||||||
|
* collapsing an action is tried before the title gives way.
|
||||||
|
*/
|
||||||
|
const fits = () =>
|
||||||
|
header.scrollWidth <= header.clientWidth &&
|
||||||
|
(title === null || title.scrollWidth <= title.clientWidth + 1);
|
||||||
|
|
||||||
|
for (const el of buttons.values()) el.hidden = false;
|
||||||
|
|
||||||
|
if (more) more.hidden = true;
|
||||||
|
|
||||||
|
const collapsed = new Set<string>();
|
||||||
|
|
||||||
|
if (!fits()) {
|
||||||
|
if (more) more.hidden = false;
|
||||||
|
|
||||||
|
for (const action of this.collapseOrder()) {
|
||||||
|
collapsed.add(action.id);
|
||||||
|
|
||||||
|
const el = buttons.get(action.id);
|
||||||
|
|
||||||
|
if (el) el.hidden = true;
|
||||||
|
|
||||||
|
if (fits()) break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
this.commitCollapsed(collapsed);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Lowest priority first; ties broken from the right. */
|
||||||
|
private collapseOrder(): PageAction[] {
|
||||||
|
return this.actions
|
||||||
|
.map((action, index) => ({ action, index }))
|
||||||
|
.sort(
|
||||||
|
(a, b) =>
|
||||||
|
(a.action.priority ?? 0) - (b.action.priority ?? 0) ||
|
||||||
|
b.index - a.index,
|
||||||
|
)
|
||||||
|
.map(({ action }) => action);
|
||||||
|
}
|
||||||
|
|
||||||
|
private commitCollapsed(next: Set<string>): void {
|
||||||
|
const same =
|
||||||
|
next.size === this.collapsed.size &&
|
||||||
|
[...next].every((id) => this.collapsed.has(id));
|
||||||
|
|
||||||
|
if (same) return;
|
||||||
|
|
||||||
|
this.collapsed = next;
|
||||||
|
|
||||||
|
// Nothing left to show in it. Closing rather than leaving an
|
||||||
|
// empty menu open is the same rule the shelves follow.
|
||||||
|
if (next.size === 0 && this.menuOpen) this.closeMenu();
|
||||||
|
}
|
||||||
|
|
||||||
|
// =================================================================
|
||||||
|
// Rendering
|
||||||
|
// =================================================================
|
||||||
|
|
||||||
|
private renderActions() {
|
||||||
|
if (this.actions.length === 0) return nothing;
|
||||||
|
|
||||||
|
const overflowed = this.actions.filter((a) => this.collapsed.has(a.id));
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<div class="actions">
|
||||||
|
${this.actions.map((a) => this.renderActionButton(a))}
|
||||||
|
<wa-popup
|
||||||
|
placement="bottom-end"
|
||||||
|
flip
|
||||||
|
shift
|
||||||
|
.active=${this.menuOpen}
|
||||||
|
>
|
||||||
|
<button
|
||||||
|
slot="anchor"
|
||||||
|
class="more-button"
|
||||||
|
type="button"
|
||||||
|
data-testid="page-actions-more"
|
||||||
|
aria-label="More actions"
|
||||||
|
aria-haspopup="menu"
|
||||||
|
aria-expanded=${this.menuOpen ? 'true' : 'false'}
|
||||||
|
aria-controls="page-header-overflow"
|
||||||
|
?hidden=${overflowed.length === 0}
|
||||||
|
@click=${this.onMoreClick}
|
||||||
|
>
|
||||||
|
<wa-icon name=${ICON_MORE_ACTIONS}></wa-icon>
|
||||||
|
</button>
|
||||||
|
<div
|
||||||
|
id="page-header-overflow"
|
||||||
|
class="context-menu-panel"
|
||||||
|
role="menu"
|
||||||
|
aria-label="More actions"
|
||||||
|
>
|
||||||
|
${overflowed.map(
|
||||||
|
(a) => html`
|
||||||
|
<wa-dropdown-item
|
||||||
|
?disabled=${a.disabled ?? false}
|
||||||
|
@click=${() => this.onActionSelect(a)}
|
||||||
|
>
|
||||||
|
<wa-icon
|
||||||
|
slot="icon"
|
||||||
|
name=${a.icon}
|
||||||
|
></wa-icon>
|
||||||
|
${a.label}
|
||||||
|
</wa-dropdown-item>
|
||||||
|
`,
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</wa-popup>
|
||||||
|
</div>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
|
private renderActionButton(a: PageAction) {
|
||||||
|
const drop = a.drop;
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<button
|
||||||
|
class="action ${drop?.active === true ? 'drag-over' : ''}"
|
||||||
|
type="button"
|
||||||
|
data-action-id=${a.id}
|
||||||
|
data-testid=${`page-action-${a.id}`}
|
||||||
|
title=${a.title ?? nothing}
|
||||||
|
?disabled=${a.disabled ?? false}
|
||||||
|
?hidden=${this.collapsed.has(a.id)}
|
||||||
|
@click=${() => a.onSelect()}
|
||||||
|
@dragover=${(e: DragEvent) => drop?.onDragOver(e)}
|
||||||
|
@dragleave=${(e: DragEvent) => drop?.onDragLeave(e)}
|
||||||
|
@drop=${(e: DragEvent) => drop?.onDrop(e)}
|
||||||
|
>
|
||||||
|
<wa-icon name=${a.icon}></wa-icon>
|
||||||
|
${a.label}
|
||||||
|
</button>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
|
// =================================================================
|
||||||
|
// The overflow menu
|
||||||
|
// =================================================================
|
||||||
|
|
||||||
|
private onActionSelect(a: PageAction): void {
|
||||||
|
if (a.disabled === true) return;
|
||||||
|
|
||||||
|
this.closeMenu();
|
||||||
|
a.onSelect();
|
||||||
|
}
|
||||||
|
|
||||||
|
private onMoreClick = (): void => {
|
||||||
|
if (this.menuOpen) {
|
||||||
|
this.closeMenu();
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.menuOpen = true;
|
||||||
|
|
||||||
|
void this.updateComplete.then(() => {
|
||||||
|
if (!this.menuOpen) return;
|
||||||
|
|
||||||
|
this.popup?.reposition();
|
||||||
|
this.menuKeyboard.open(this.menuPanel ?? null, this.moreButton);
|
||||||
|
this.attachOutsideClose();
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
private closeMenu(): void {
|
||||||
|
if (!this.menuOpen) return;
|
||||||
|
|
||||||
|
this.detachOutsideClose();
|
||||||
|
this.menuKeyboard.close();
|
||||||
|
this.menuOpen = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A click anywhere else closes it. `composedPath` rather than
|
||||||
|
* `contains`, because the trigger and the panel are both inside
|
||||||
|
* this shadow root and a click retargets at the host.
|
||||||
|
*/
|
||||||
|
private onOutsideDown = (e: Event): void => {
|
||||||
|
if (e.composedPath().includes(this.menuPanel as EventTarget)) return;
|
||||||
|
if (e.composedPath().includes(this.moreButton as EventTarget)) return;
|
||||||
|
|
||||||
|
this.closeMenu();
|
||||||
|
};
|
||||||
|
|
||||||
|
private attachOutsideClose(): void {
|
||||||
|
if (this.outsideCloseAttached) return;
|
||||||
|
|
||||||
|
this.outsideCloseAttached = true;
|
||||||
|
document.addEventListener('mousedown', this.onOutsideDown, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
private detachOutsideClose(): void {
|
||||||
|
if (!this.outsideCloseAttached) return;
|
||||||
|
|
||||||
|
this.outsideCloseAttached = false;
|
||||||
|
document.removeEventListener('mousedown', this.onOutsideDown, true);
|
||||||
|
}
|
||||||
|
|
||||||
private renderCount() {
|
private renderCount() {
|
||||||
if (this.count === null) return nothing;
|
if (this.count === null) return nothing;
|
||||||
|
|
||||||
@@ -258,7 +785,10 @@ export class PageHeader extends LitElement {
|
|||||||
if (this.sortOptions.length === 1) {
|
if (this.sortOptions.length === 1) {
|
||||||
return html`
|
return html`
|
||||||
<div class="sort">
|
<div class="sort">
|
||||||
<span>Sort: ${this.sortOptions[0]?.label}</span>
|
<span
|
||||||
|
><span class="sort-label">Sort: </span
|
||||||
|
>${this.sortOptions[0]?.label}</span
|
||||||
|
>
|
||||||
${this.renderDirectionButton(ascending)}
|
${this.renderDirectionButton(ascending)}
|
||||||
</div>
|
</div>
|
||||||
`;
|
`;
|
||||||
@@ -267,7 +797,7 @@ export class PageHeader extends LitElement {
|
|||||||
return html`
|
return html`
|
||||||
<div class="sort">
|
<div class="sort">
|
||||||
<label>
|
<label>
|
||||||
Sort:
|
<span class="sort-label">Sort:</span>
|
||||||
<select
|
<select
|
||||||
data-testid="page-sort"
|
data-testid="page-sort"
|
||||||
.value=${this.sortField}
|
.value=${this.sortField}
|
||||||
|
|||||||
@@ -40,7 +40,10 @@ import type { DuplicateTracksDialog } from '@components/duplicate-tracks-dialog/
|
|||||||
import {
|
import {
|
||||||
ICON_NEW,
|
ICON_NEW,
|
||||||
ICON_PLAYLIST,
|
ICON_PLAYLIST,
|
||||||
|
ICON_SMART_PLAYLIST,
|
||||||
} from '@utils/icon-language';
|
} from '@utils/icon-language';
|
||||||
|
import '@components/page-header/page-header';
|
||||||
|
import type { PageAction } from '@components/page-header/page-header';
|
||||||
|
|
||||||
const SCROLL_DEBOUNCE_MS = 100;
|
const SCROLL_DEBOUNCE_MS = 100;
|
||||||
|
|
||||||
@@ -194,11 +197,6 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
contain: layout style;
|
contain: layout style;
|
||||||
}
|
}
|
||||||
|
|
||||||
.header-actions {
|
|
||||||
display: flex;
|
|
||||||
gap: 8px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.header-spinner {
|
.header-spinner {
|
||||||
display: inline-block;
|
display: inline-block;
|
||||||
width: 14px;
|
width: 14px;
|
||||||
@@ -209,33 +207,6 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
animation: spin 0.6s linear infinite;
|
animation: spin 0.6s linear infinite;
|
||||||
}
|
}
|
||||||
|
|
||||||
.new-playlist-button {
|
|
||||||
background: none;
|
|
||||||
border: 1px solid var(--yj-border-subtle, #555);
|
|
||||||
border-radius: 4px;
|
|
||||||
color: var(--yj-text-primary, #fff);
|
|
||||||
padding: 6px 12px;
|
|
||||||
font-size: 13px;
|
|
||||||
cursor: pointer;
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
gap: 6px;
|
|
||||||
font-family: inherit;
|
|
||||||
}
|
|
||||||
|
|
||||||
.new-playlist-button:hover,
|
|
||||||
.new-playlist-button.drag-over {
|
|
||||||
border-color: var(--yj-accent, #ffd43b);
|
|
||||||
color: var(--yj-accent-text, #ffd43b);
|
|
||||||
}
|
|
||||||
|
|
||||||
.new-playlist-button.drag-over {
|
|
||||||
background-color: var(
|
|
||||||
--yj-accent-bg-strong,
|
|
||||||
rgba(255, 212, 59, 0.15)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
.create-form {
|
.create-form {
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
@@ -455,25 +426,6 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
min-width: 0;
|
min-width: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.import-button {
|
|
||||||
background: none;
|
|
||||||
border: 1px solid var(--yj-border-subtle, #555);
|
|
||||||
border-radius: 4px;
|
|
||||||
color: var(--yj-text-primary, #fff);
|
|
||||||
padding: 6px 12px;
|
|
||||||
font-size: 13px;
|
|
||||||
cursor: pointer;
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
gap: 6px;
|
|
||||||
font-family: inherit;
|
|
||||||
}
|
|
||||||
|
|
||||||
.import-button:hover {
|
|
||||||
border-color: var(--yj-accent, #ffd43b);
|
|
||||||
color: var(--yj-accent-text, #ffd43b);
|
|
||||||
}
|
|
||||||
|
|
||||||
.import-error {
|
.import-error {
|
||||||
padding: 0.5em 0.75em;
|
padding: 0.5em 0.75em;
|
||||||
margin: 0.5em 16px 0;
|
margin: 0.5em 16px 0;
|
||||||
@@ -1022,10 +974,11 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
) => {
|
) => {
|
||||||
const related =
|
const related =
|
||||||
e.relatedTarget as Node | null;
|
e.relatedTarget as Node | null;
|
||||||
const btn =
|
// The button the event was bound to, rather than a selector for
|
||||||
this.shadowRoot?.querySelector(
|
// it: `page-header` renders it now, so it is not in this shadow
|
||||||
'.new-playlist-button',
|
// root at all and the old `.new-playlist-button` lookup would
|
||||||
);
|
// find nothing and leave the highlight stuck on.
|
||||||
|
const btn = e.currentTarget as Element | null;
|
||||||
|
|
||||||
if (btn && !btn.contains(related)) {
|
if (btn && !btn.contains(related)) {
|
||||||
this.dragOverNewButton = false;
|
this.dragOverNewButton = false;
|
||||||
@@ -1470,6 +1423,49 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
this.saveSortPreferences();
|
this.saveSortPreferences();
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The three things this page can do, as data.
|
||||||
|
*
|
||||||
|
* The priority order is what #69's Direction asks for and it is
|
||||||
|
* only interesting for one of them: **New Playlist is highest
|
||||||
|
* because it is the drop target**. You cannot drag a track onto a
|
||||||
|
* closed menu, so collapsing it is the one collapse here that
|
||||||
|
* removes a capability rather than relocating it. Import is lowest
|
||||||
|
* because it is the rarest, and at 900×600 it is the only one that
|
||||||
|
* has to go.
|
||||||
|
*/
|
||||||
|
private headerActions(): PageAction[] {
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
id: 'import',
|
||||||
|
label: 'Import',
|
||||||
|
icon: 'file-import',
|
||||||
|
priority: 0,
|
||||||
|
onSelect: () => void this.handleImportPlaylist(),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'new-playlist',
|
||||||
|
label: 'New Playlist',
|
||||||
|
icon: ICON_NEW,
|
||||||
|
priority: 2,
|
||||||
|
onSelect: () => this.handleNewPlaylistClick(),
|
||||||
|
drop: {
|
||||||
|
active: this.dragOverNewButton,
|
||||||
|
onDragOver: this.onNewButtonDragOver,
|
||||||
|
onDragLeave: this.onNewButtonDragLeave,
|
||||||
|
onDrop: this.onNewButtonDrop,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'new-smart-playlist',
|
||||||
|
label: 'New Smart Playlist',
|
||||||
|
icon: ICON_SMART_PLAYLIST,
|
||||||
|
priority: 1,
|
||||||
|
onSelect: () => this.handleNewSmartPlaylistClick(),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
override render() {
|
override render() {
|
||||||
return html`
|
return html`
|
||||||
<page-header
|
<page-header
|
||||||
@@ -1484,33 +1480,8 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
search-term=${this.searchCtrl.term}
|
search-term=${this.searchCtrl.term}
|
||||||
?busy=${this.refreshing}
|
?busy=${this.refreshing}
|
||||||
@sort-change=${this.onPageHeaderSort}
|
@sort-change=${this.onPageHeaderSort}
|
||||||
|
.actions=${this.headerActions()}
|
||||||
>
|
>
|
||||||
<div slot="actions" class="header-actions">
|
|
||||||
<button
|
|
||||||
class="import-button"
|
|
||||||
@click=${this.handleImportPlaylist}
|
|
||||||
>
|
|
||||||
<wa-icon name="file-import"></wa-icon>
|
|
||||||
Import
|
|
||||||
</button>
|
|
||||||
<button
|
|
||||||
class="new-playlist-button ${this.dragOverNewButton ? 'drag-over' : ''}"
|
|
||||||
@click=${this.handleNewPlaylistClick}
|
|
||||||
@dragover=${this.onNewButtonDragOver}
|
|
||||||
@dragleave=${this.onNewButtonDragLeave}
|
|
||||||
@drop=${this.onNewButtonDrop}
|
|
||||||
>
|
|
||||||
<wa-icon name=${ICON_NEW}></wa-icon>
|
|
||||||
New Playlist
|
|
||||||
</button>
|
|
||||||
<button
|
|
||||||
class="new-playlist-button"
|
|
||||||
@click=${this.handleNewSmartPlaylistClick}
|
|
||||||
>
|
|
||||||
<wa-icon name="filter"></wa-icon>
|
|
||||||
New Smart Playlist
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
</page-header>
|
</page-header>
|
||||||
|
|
||||||
${this.importError
|
${this.importError
|
||||||
@@ -1765,7 +1736,7 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
: entry.summary.IsSmart
|
: entry.summary.IsSmart
|
||||||
? html`<wa-icon
|
? html`<wa-icon
|
||||||
class="playlist-icon"
|
class="playlist-icon"
|
||||||
name="filter"
|
name=${ICON_SMART_PLAYLIST}
|
||||||
></wa-icon>`
|
></wa-icon>`
|
||||||
: nothing}
|
: nothing}
|
||||||
${isRenaming
|
${isRenaming
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
|||||||
import { designTokens } from '../../styles/tokens.css';
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
|
|
||||||
import type { DragActiveDetail } from '@utils/drag-controller';
|
import type { DragActiveDetail } from '@utils/drag-controller';
|
||||||
|
import { ActiveViewController } from '@store/controllers/active-view-controller';
|
||||||
import {
|
import {
|
||||||
ICON_PLAYLIST,
|
ICON_PLAYLIST,
|
||||||
ICON_AUTOTAG,
|
ICON_AUTOTAG,
|
||||||
@@ -159,11 +160,20 @@ export class AppSidebar extends LitElement {
|
|||||||
/** Delay in ms before a drag-hover triggers navigation. */
|
/** Delay in ms before a drag-hover triggers navigation. */
|
||||||
private static readonly HOVER_NAV_DELAY = 600;
|
private static readonly HOVER_NAV_DELAY = 600;
|
||||||
|
|
||||||
/** Home, because that is where `index.ts` now navigates on startup
|
/**
|
||||||
* (H-8). The sidebar does not hear a `navigate` it did not send,
|
* Which item is lit, read from the shell rather than tracked here.
|
||||||
* so this default is what keeps `aria-current` honest on arrival. */
|
*
|
||||||
@state()
|
* This used to be a `@state()` field defaulting to `home` -- the
|
||||||
private activeView: View = 'home';
|
* landing view -- because "the sidebar does not hear a `navigate`
|
||||||
|
* it did not send". That default was the only honest moment it
|
||||||
|
* ever had: a back-navigation dispatches no `navigate`, so the
|
||||||
|
* highlight stayed on the view the user had just left (#72), and
|
||||||
|
* the copy of this component that `bottom-nav` mounts inside its
|
||||||
|
* drawer opened on `home` from whatever page you were standing on.
|
||||||
|
* The shell publishes the active view now, so there is nothing to
|
||||||
|
* default and nothing to keep in step.
|
||||||
|
*/
|
||||||
|
private activeCtrl = new ActiveViewController(this);
|
||||||
|
|
||||||
@state()
|
@state()
|
||||||
private isDragging = false;
|
private isDragging = false;
|
||||||
@@ -237,10 +247,6 @@ export class AppSidebar extends LitElement {
|
|||||||
'yj-drag-active',
|
'yj-drag-active',
|
||||||
this.onDragActive as EventListener,
|
this.onDragActive as EventListener,
|
||||||
);
|
);
|
||||||
document.addEventListener(
|
|
||||||
'navigate',
|
|
||||||
this.onGlobalNavigate as EventListener,
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
override disconnectedCallback() {
|
override disconnectedCallback() {
|
||||||
@@ -262,10 +268,6 @@ export class AppSidebar extends LitElement {
|
|||||||
'yj-drag-active',
|
'yj-drag-active',
|
||||||
this.onDragActive as EventListener,
|
this.onDragActive as EventListener,
|
||||||
);
|
);
|
||||||
document.removeEventListener(
|
|
||||||
'navigate',
|
|
||||||
this.onGlobalNavigate as EventListener,
|
|
||||||
);
|
|
||||||
this.clearDragHoverTimer();
|
this.clearDragHoverTimer();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -282,8 +284,9 @@ export class AppSidebar extends LitElement {
|
|||||||
<nav aria-label="Main">
|
<nav aria-label="Main">
|
||||||
<ul>
|
<ul>
|
||||||
${this.navItems.map((item) => {
|
${this.navItems.map((item) => {
|
||||||
|
const active = this.activeCtrl.isActive(item.id);
|
||||||
const classes = [
|
const classes = [
|
||||||
this.activeView === item.id
|
active
|
||||||
? 'active'
|
? 'active'
|
||||||
: '',
|
: '',
|
||||||
this.dragHoverView === item.id
|
this.dragHoverView === item.id
|
||||||
@@ -299,7 +302,7 @@ export class AppSidebar extends LitElement {
|
|||||||
type="button"
|
type="button"
|
||||||
class=${classes}
|
class=${classes}
|
||||||
data-testid="nav-${item.id}"
|
data-testid="nav-${item.id}"
|
||||||
aria-current=${this.activeView === item.id
|
aria-current=${active
|
||||||
? 'page'
|
? 'page'
|
||||||
: 'false'}
|
: 'false'}
|
||||||
@click=${() =>
|
@click=${() =>
|
||||||
@@ -382,19 +385,6 @@ export class AppSidebar extends LitElement {
|
|||||||
private static readonly DROP_VIEWS: Set<View> =
|
private static readonly DROP_VIEWS: Set<View> =
|
||||||
new Set(['playlists']);
|
new Set(['playlists']);
|
||||||
|
|
||||||
/** Keeps the highlighted nav item in sync with navigation that
|
|
||||||
* originates outside the sidebar itself (e.g. the launch-page
|
|
||||||
* dispatch in index.ts). */
|
|
||||||
private onGlobalNavigate = (
|
|
||||||
e: CustomEvent<{ view?: string }>,
|
|
||||||
) => {
|
|
||||||
const view = e.detail.view;
|
|
||||||
|
|
||||||
if (view && this.navItems.some((item) => item.id === view)) {
|
|
||||||
this.activeView = view as View;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
private onDragActive = (
|
private onDragActive = (
|
||||||
e: CustomEvent<DragActiveDetail>,
|
e: CustomEvent<DragActiveDetail>,
|
||||||
) => {
|
) => {
|
||||||
@@ -460,7 +450,11 @@ export class AppSidebar extends LitElement {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private navigate(view: View) {
|
private navigate(view: View) {
|
||||||
this.activeView = view;
|
// No optimistic highlight: the shell answers, and it answers
|
||||||
|
// synchronously in `handleNavigate` before it awaits anything.
|
||||||
|
// Setting it here as well is the second opinion this fix
|
||||||
|
// removes -- it is what let a click's highlight survive a
|
||||||
|
// navigation the shell then handled differently.
|
||||||
this.dispatchEvent(new CustomEvent('navigate', {
|
this.dispatchEvent(new CustomEvent('navigate', {
|
||||||
detail: { view },
|
detail: { view },
|
||||||
bubbles: true,
|
bubbles: true,
|
||||||
|
|||||||
@@ -64,6 +64,7 @@ import { list } from '@utils/binding';
|
|||||||
import {
|
import {
|
||||||
ICON_PLAYLIST,
|
ICON_PLAYLIST,
|
||||||
ICON_QUEUE,
|
ICON_QUEUE,
|
||||||
|
ICON_SMART_PLAYLIST,
|
||||||
} from '@utils/icon-language';
|
} from '@utils/icon-language';
|
||||||
|
|
||||||
|
|
||||||
@@ -1214,7 +1215,7 @@ export class SmartPlaylistDetails
|
|||||||
<wa-icon name="arrow-left"></wa-icon>
|
<wa-icon name="arrow-left"></wa-icon>
|
||||||
</button>
|
</button>
|
||||||
<div class="playlist-avatar">
|
<div class="playlist-avatar">
|
||||||
<wa-icon name="filter"></wa-icon>
|
<wa-icon name=${ICON_SMART_PLAYLIST}></wa-icon>
|
||||||
</div>
|
</div>
|
||||||
<div class="playlist-info">
|
<div class="playlist-info">
|
||||||
<h1
|
<h1
|
||||||
|
|||||||
@@ -41,6 +41,7 @@ solid/compact-disc
|
|||||||
solid/copy
|
solid/copy
|
||||||
solid/database
|
solid/database
|
||||||
solid/download
|
solid/download
|
||||||
|
solid/ellipsis
|
||||||
solid/file-import
|
solid/file-import
|
||||||
solid/filter
|
solid/filter
|
||||||
solid/floppy-disk
|
solid/floppy-disk
|
||||||
|
|||||||
@@ -0,0 +1,90 @@
|
|||||||
|
/**
|
||||||
|
* Which primary view the app is showing.
|
||||||
|
*
|
||||||
|
* The shell has always known this -- `handleNavigate()` sets
|
||||||
|
* `#main-content`'s `data-active-view` on every path, `_isBack`
|
||||||
|
* included -- and never told anyone. The nav components learned it
|
||||||
|
* from the `navigate` CustomEvent instead, which only the *outbound*
|
||||||
|
* path dispatches: the `popstate` listener calls `handleNavigate()`
|
||||||
|
* directly. So both navs kept highlighting the view you had just left
|
||||||
|
* (#72).
|
||||||
|
*
|
||||||
|
* The fix cannot be a re-dispatch of `navigate`. `index.ts` is itself a
|
||||||
|
* document listener for it, so emitting one from inside
|
||||||
|
* `handleNavigate` is an infinite loop -- and the two statements are
|
||||||
|
* different anyway: `navigate` means *please go to X*, and 28 call
|
||||||
|
* sites across 18 files say it. This says *the active view is now X*,
|
||||||
|
* which only the shell is in a position to say and only once per
|
||||||
|
* navigation.
|
||||||
|
*
|
||||||
|
* Three things about it are load-bearing.
|
||||||
|
*
|
||||||
|
* **It is a store rather than an event**, because a component that
|
||||||
|
* mounts *after* a navigation still has to know. `bottom-nav`'s "More"
|
||||||
|
* drawer creates its `<app-sidebar>` on open, and that copy had heard
|
||||||
|
* no `navigate` at all: standing on Albums, the drawer highlighted
|
||||||
|
* Home -- its `activeView` default, which existed to match the landing
|
||||||
|
* view and matched nothing else ever after. An event has no answer for
|
||||||
|
* a listener that was not there; a value does.
|
||||||
|
*
|
||||||
|
* **A detail view is not a view here.** Opening one leaves the primary
|
||||||
|
* view it was opened from lit, which is what #72 asks for and what
|
||||||
|
* `app-sidebar` used to do by accident -- it guarded on
|
||||||
|
* `navItems.some(...)`, so a name matching no item left its highlight
|
||||||
|
* alone. `bottom-nav` had no such guard and so lit nothing on a detail
|
||||||
|
* view. Neither was correct; the sidebar was stale-but-lucky, and
|
||||||
|
* stating the rule once is what makes the two agree.
|
||||||
|
*
|
||||||
|
* **Whether a view is primary is the shell's fact, not this store's.**
|
||||||
|
* `VIEW_TAGS` in `index.ts` is the list, and a copy of it here is a
|
||||||
|
* second list to forget -- so the caller passes the answer it already
|
||||||
|
* has rather than this file re-deriving it.
|
||||||
|
*/
|
||||||
|
|
||||||
|
type Subscriber = () => void;
|
||||||
|
|
||||||
|
class ActiveViewStore {
|
||||||
|
/** Empty until the shell's first navigation, which happens at
|
||||||
|
* startup from `GetDefaultPage()`. Nothing is highlighted for that
|
||||||
|
* moment, which is honest: the alternative is a written-down
|
||||||
|
* default that is right only when the default page agrees with it. */
|
||||||
|
private activeView = '';
|
||||||
|
|
||||||
|
private subscribers = new Set<Subscriber>();
|
||||||
|
|
||||||
|
/** The active primary view, e.g. `albums`. */
|
||||||
|
get(): string {
|
||||||
|
return this.activeView;
|
||||||
|
}
|
||||||
|
|
||||||
|
isActive(view: string): boolean {
|
||||||
|
return this.activeView !== '' && this.activeView === view;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Called by the shell on every navigation, `popstate` included.
|
||||||
|
*
|
||||||
|
* `isPrimary` is `view in VIEW_TAGS` at the call site: a detail
|
||||||
|
* view reports itself and deliberately changes nothing, so the view
|
||||||
|
* it was opened from stays lit until the user picks another one.
|
||||||
|
*/
|
||||||
|
setView(view: string, isPrimary: boolean): void {
|
||||||
|
if (!isPrimary) return;
|
||||||
|
if (view === this.activeView) return;
|
||||||
|
|
||||||
|
this.activeView = view;
|
||||||
|
this.notify();
|
||||||
|
}
|
||||||
|
|
||||||
|
subscribe(fn: Subscriber): () => void {
|
||||||
|
this.subscribers.add(fn);
|
||||||
|
|
||||||
|
return () => this.subscribers.delete(fn);
|
||||||
|
}
|
||||||
|
|
||||||
|
private notify(): void {
|
||||||
|
this.subscribers.forEach((fn) => fn());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const activeViewStore = new ActiveViewStore();
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
import type {
|
||||||
|
ReactiveController,
|
||||||
|
ReactiveControllerHost,
|
||||||
|
} from 'lit';
|
||||||
|
import { activeViewStore } from '../active-view-store';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ActiveViewController connects a Lit component to the
|
||||||
|
* ActiveViewStore.
|
||||||
|
*
|
||||||
|
* Usage in a component:
|
||||||
|
*
|
||||||
|
* private activeCtrl = new ActiveViewController(this);
|
||||||
|
*
|
||||||
|
* render() {
|
||||||
|
* const lit = this.activeCtrl.isActive('albums');
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* It reads through to the store rather than copying the value into a
|
||||||
|
* `@state()` field, which is the point of #72: two components holding
|
||||||
|
* their own idea of the active view is what let them disagree with the
|
||||||
|
* shell and with each other.
|
||||||
|
*/
|
||||||
|
export class ActiveViewController implements ReactiveController {
|
||||||
|
private host: ReactiveControllerHost;
|
||||||
|
private unsubscribe?: () => void;
|
||||||
|
|
||||||
|
constructor(host: ReactiveControllerHost) {
|
||||||
|
this.host = host;
|
||||||
|
host.addController(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ===============================================================
|
||||||
|
// LIFECYCLE HOOKS
|
||||||
|
// ===============================================================
|
||||||
|
|
||||||
|
hostConnected(): void {
|
||||||
|
this.unsubscribe = activeViewStore.subscribe(() => {
|
||||||
|
this.host.requestUpdate();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
hostDisconnected(): void {
|
||||||
|
this.unsubscribe?.();
|
||||||
|
}
|
||||||
|
|
||||||
|
// ===============================================================
|
||||||
|
// DATA ACCESS
|
||||||
|
// ===============================================================
|
||||||
|
|
||||||
|
/** The active primary view, e.g. `albums`. */
|
||||||
|
get current(): string {
|
||||||
|
return activeViewStore.get();
|
||||||
|
}
|
||||||
|
|
||||||
|
isActive(view: string): boolean {
|
||||||
|
return activeViewStore.isActive(view);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -9,6 +9,8 @@ export type { ThemeState, BackgroundShade } from './theme-store';
|
|||||||
export { ThemeController } from './controllers/theme-controller';
|
export { ThemeController } from './controllers/theme-controller';
|
||||||
export { searchStore } from './search-store';
|
export { searchStore } from './search-store';
|
||||||
export { SearchController } from './controllers/search-controller';
|
export { SearchController } from './controllers/search-controller';
|
||||||
|
export { activeViewStore } from './active-view-store';
|
||||||
|
export { ActiveViewController } from './controllers/active-view-controller';
|
||||||
export { shortcutsStore } from './shortcuts-store';
|
export { shortcutsStore } from './shortcuts-store';
|
||||||
export type { ShortcutsState } from './shortcuts-store';
|
export type { ShortcutsState } from './shortcuts-store';
|
||||||
export { ShortcutsController } from './controllers/shortcuts-controller';
|
export { ShortcutsController } from './controllers/shortcuts-controller';
|
||||||
|
|||||||
@@ -54,6 +54,18 @@ export const ICON_PLAYLIST = 'list';
|
|||||||
*/
|
*/
|
||||||
export const ICON_NEW = 'plus';
|
export const ICON_NEW = 'plus';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A smart playlist — the rule, and the thing the rule makes.
|
||||||
|
*
|
||||||
|
* Governed for the reason `ICON_AUTOTAG` states: it was already at
|
||||||
|
* three call sites (the Playlists header, the row marker beside a smart
|
||||||
|
* playlist's name, and `smart-playlist-details`'s avatar), and a name
|
||||||
|
* stops being a detail of one component the moment there are two. It is
|
||||||
|
* deliberately *not* `ICON_NEW`, even on the button that makes one:
|
||||||
|
* an icon names the noun it acts on, and the noun here is the rule.
|
||||||
|
*/
|
||||||
|
export const ICON_SMART_PLAYLIST = 'filter';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The request ("want") toggle, as an outline/solid pair.
|
* The request ("want") toggle, as an outline/solid pair.
|
||||||
*
|
*
|
||||||
@@ -100,6 +112,18 @@ export const ICON_AUTOTAG = 'tag';
|
|||||||
*/
|
*/
|
||||||
export const ICON_DOWNLOADING = 'download';
|
export const ICON_DOWNLOADING = 'download';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The rest of what this thing can do.
|
||||||
|
*
|
||||||
|
* `page-header` collapses the actions that do not fit into one menu
|
||||||
|
* behind this, so the glyph has to name *more of the same nouns* rather
|
||||||
|
* than any one of them — which is what an ellipsis is and what `bars`
|
||||||
|
* (the navigation drawer, one component over in `bottom-nav`) is not.
|
||||||
|
* It is deliberately the only meaning it carries: an overflow menu that
|
||||||
|
* shared an icon with a destination would be the `list` problem again.
|
||||||
|
*/
|
||||||
|
export const ICON_MORE_ACTIONS = 'ellipsis';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Take this away.
|
* Take this away.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -3,15 +3,21 @@
|
|||||||
*
|
*
|
||||||
* Three of these are about the thing that makes a second nav dangerous:
|
* Three of these are about the thing that makes a second nav dangerous:
|
||||||
* it has to agree with the first one. `bottom-nav` emits the same
|
* it has to agree with the first one. `bottom-nav` emits the same
|
||||||
* bubbling, composed `navigate` event `app-sidebar` does and listens
|
* bubbling, composed `navigate` event `app-sidebar` does, and reads
|
||||||
* for that event globally, so a navigation from anywhere — a card, a
|
* which tab is lit from `activeViewStore` — the shell's one statement
|
||||||
* detail view, the drawer's own sidebar — moves its highlight too. A
|
* of where the user is — so it follows a navigation from anywhere: a
|
||||||
* tab bar that only tracks its own clicks looks right until the moment
|
* card, a detail view, the drawer's own sidebar, or the back gesture.
|
||||||
* the user arrives somewhere by another route.
|
*
|
||||||
|
* That last one is why the source is the store and not the `navigate`
|
||||||
|
* event these tests used to dispatch. `popstate` dispatches no
|
||||||
|
* `navigate` (index.ts calls `handleNavigate` directly), so a tab bar
|
||||||
|
* listening for the event looked right until the user pressed back —
|
||||||
|
* #72.
|
||||||
*/
|
*/
|
||||||
import { describe, expect, it, beforeEach } from 'vitest';
|
import { describe, expect, it, beforeEach } from 'vitest';
|
||||||
|
|
||||||
import '@components/bottom-nav/bottom-nav';
|
import '@components/bottom-nav/bottom-nav';
|
||||||
|
import { activeViewStore } from '@store/active-view-store';
|
||||||
import type { BottomNav } from '@components/bottom-nav/bottom-nav';
|
import type { BottomNav } from '@components/bottom-nav/bottom-nav';
|
||||||
import { fixture, shadow, shadowAll, update } from '@test/support/render';
|
import { fixture, shadow, shadowAll, update } from '@test/support/render';
|
||||||
import { resetHarness } from '@test/support/harness';
|
import { resetHarness } from '@test/support/harness';
|
||||||
@@ -21,6 +27,12 @@ type Nav = BottomNav;
|
|||||||
const tabs = (el: HTMLElement) =>
|
const tabs = (el: HTMLElement) =>
|
||||||
shadowAll<HTMLButtonElement>(el, 'nav button');
|
shadowAll<HTMLButtonElement>(el, 'nav button');
|
||||||
|
|
||||||
|
/** The testids of whatever the bar says is the current page. */
|
||||||
|
const current = (el: HTMLElement) =>
|
||||||
|
tabs(el)
|
||||||
|
.filter((b) => b.getAttribute('aria-current') === 'page')
|
||||||
|
.map((b) => b.dataset.testid);
|
||||||
|
|
||||||
/** Resolve on one occurrence of an event, or reject loudly on time. */
|
/** Resolve on one occurrence of an event, or reject loudly on time. */
|
||||||
const once = (el: Element, name: string, timeoutMs = 2000) =>
|
const once = (el: Element, name: string, timeoutMs = 2000) =>
|
||||||
new Promise<void>((resolve, reject) => {
|
new Promise<void>((resolve, reject) => {
|
||||||
@@ -70,36 +82,55 @@ describe('bottom-nav', () => {
|
|||||||
it('follows a navigation it did not send', async () => {
|
it('follows a navigation it did not send', async () => {
|
||||||
const el = await fixture<Nav>('bottom-nav');
|
const el = await fixture<Nav>('bottom-nav');
|
||||||
|
|
||||||
document.dispatchEvent(new CustomEvent('navigate', {
|
activeViewStore.setView('tracks', true);
|
||||||
detail: { view: 'tracks' },
|
|
||||||
bubbles: true,
|
|
||||||
composed: true,
|
|
||||||
}));
|
|
||||||
await update(el, {});
|
await update(el, {});
|
||||||
|
|
||||||
const current = tabs(el)
|
expect(current(el)).toEqual(['tab-tracks']);
|
||||||
.filter((b) => b.getAttribute('aria-current') === 'page')
|
|
||||||
.map((b) => b.dataset.testid);
|
|
||||||
|
|
||||||
expect(current).toEqual(['tab-tracks']);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it('marks exactly one tab current, and none for a view it has no tab for', async () => {
|
it('marks exactly one tab current, and none for a view it has no tab for', async () => {
|
||||||
const el = await fixture<Nav>('bottom-nav');
|
const el = await fixture<Nav>('bottom-nav');
|
||||||
|
|
||||||
document.dispatchEvent(new CustomEvent('navigate', {
|
activeViewStore.setView('settings', true);
|
||||||
detail: { view: 'settings' },
|
|
||||||
bubbles: true,
|
|
||||||
composed: true,
|
|
||||||
}));
|
|
||||||
await update(el, {});
|
await update(el, {});
|
||||||
|
|
||||||
// Settings lives in the drawer, so nothing in the bar is current.
|
// Settings lives in the drawer, so nothing in the bar is current.
|
||||||
// Leaving Home highlighted would be a tab bar lying about where
|
// Leaving Home highlighted would be a tab bar lying about where
|
||||||
// the user is.
|
// the user is.
|
||||||
expect(
|
expect(current(el)).toEqual([]);
|
||||||
tabs(el).filter((b) => b.getAttribute('aria-current') === 'page'),
|
});
|
||||||
).toHaveLength(0);
|
|
||||||
|
it('keeps the parent tab lit while a detail view is open', async () => {
|
||||||
|
const el = await fixture<Nav>('bottom-nav');
|
||||||
|
|
||||||
|
activeViewStore.setView('albums', true);
|
||||||
|
// A detail view reports itself and is not primary, so it changes
|
||||||
|
// nothing. This is the first half of #72: the bar used to take the
|
||||||
|
// name, match it against no tab, and light nothing at all — while
|
||||||
|
// `app-sidebar`, which guarded on its own item list, kept the
|
||||||
|
// highlight. Neither was deliberate and the two disagreed.
|
||||||
|
activeViewStore.setView('explore-album-details', false);
|
||||||
|
await update(el, {});
|
||||||
|
|
||||||
|
expect(current(el)).toEqual(['tab-albums']);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('follows the back path, which dispatches no navigate event', async () => {
|
||||||
|
const el = await fixture<Nav>('bottom-nav');
|
||||||
|
|
||||||
|
activeViewStore.setView('albums', true);
|
||||||
|
activeViewStore.setView('tracks', true);
|
||||||
|
await update(el, {});
|
||||||
|
expect(current(el)).toEqual(['tab-tracks']);
|
||||||
|
|
||||||
|
// What `popstate` does: the shell replays the entry through
|
||||||
|
// `handleNavigate` without dispatching `navigate`. A bar listening
|
||||||
|
// for the event stayed on Tracks — the view just left, confidently
|
||||||
|
// wrong rather than merely blank.
|
||||||
|
activeViewStore.setView('albums', true);
|
||||||
|
await update(el, {});
|
||||||
|
|
||||||
|
expect(current(el)).toEqual(['tab-albums']);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('closes the drawer when a navigation happens', async () => {
|
it('closes the drawer when a navigation happens', async () => {
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ import '@components/sidebar/app-sidebar';
|
|||||||
import '@components/library-filter/library-filter';
|
import '@components/library-filter/library-filter';
|
||||||
import '@components/library-status-indicator/library-status-indicator';
|
import '@components/library-status-indicator/library-status-indicator';
|
||||||
import { Events } from '../../src/events';
|
import { Events } from '../../src/events';
|
||||||
|
import { activeViewStore } from '@store/active-view-store';
|
||||||
import { emit, stub, flush, calls, lastArgs } from '@test/support/harness';
|
import { emit, stub, flush, calls, lastArgs } from '@test/support/harness';
|
||||||
import {
|
import {
|
||||||
fixture,
|
fixture,
|
||||||
@@ -49,6 +50,8 @@ describe('<app-sidebar>', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('marks exactly one item as the current page', async () => {
|
it('marks exactly one item as the current page', async () => {
|
||||||
|
activeViewStore.setView('home', true);
|
||||||
|
|
||||||
const el = await fixture('app-sidebar');
|
const el = await fixture('app-sidebar');
|
||||||
|
|
||||||
const current = shadowAll(el, 'li button').filter(
|
const current = shadowAll(el, 'li button').filter(
|
||||||
@@ -72,17 +75,49 @@ describe('<app-sidebar>', () => {
|
|||||||
expect(seen).toEqual(['artists']);
|
expect(seen).toEqual(['artists']);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('moves aria-current to the clicked destination', async () => {
|
it('moves aria-current with the shell, not with the click', async () => {
|
||||||
|
activeViewStore.setView('home', true);
|
||||||
|
|
||||||
const el = await fixture('app-sidebar');
|
const el = await fixture('app-sidebar');
|
||||||
|
|
||||||
shadow<HTMLElement>(el, '[data-testid="nav-genres"]')?.click();
|
shadow<HTMLElement>(el, '[data-testid="nav-genres"]')?.click();
|
||||||
await el.updateComplete;
|
await el.updateComplete;
|
||||||
|
|
||||||
|
// The click asks; it does not answer. The sidebar used to move its
|
||||||
|
// own highlight optimistically, which is the second opinion #72
|
||||||
|
// removed -- one component deciding where the user is, while the
|
||||||
|
// shell decided separately and `bottom-nav` decided a third way.
|
||||||
|
expect(
|
||||||
|
shadow(el, '[data-testid="nav-genres"]')?.getAttribute('aria-current'),
|
||||||
|
).toBe('false');
|
||||||
|
|
||||||
|
// What the shell does with that event, in one line.
|
||||||
|
activeViewStore.setView('genres', true);
|
||||||
|
await update(el, {});
|
||||||
|
|
||||||
expect(
|
expect(
|
||||||
shadow(el, '[data-testid="nav-genres"]')?.getAttribute('aria-current'),
|
shadow(el, '[data-testid="nav-genres"]')?.getAttribute('aria-current'),
|
||||||
).toBe('page');
|
).toBe('page');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('follows the back path, which dispatches no navigate event', async () => {
|
||||||
|
activeViewStore.setView('albums', true);
|
||||||
|
|
||||||
|
const el = await fixture('app-sidebar');
|
||||||
|
|
||||||
|
// `popstate` replays an entry through `handleNavigate` directly, so
|
||||||
|
// there is no `navigate` event to hear -- which is why the sidebar
|
||||||
|
// stayed on the view the user had just left (#72).
|
||||||
|
activeViewStore.setView('tracks', true);
|
||||||
|
await update(el, {});
|
||||||
|
|
||||||
|
expect(
|
||||||
|
shadowAll(el, 'li button')
|
||||||
|
.filter((item) => item.getAttribute('aria-current') === 'page')
|
||||||
|
.map((item) => item.getAttribute('data-testid')),
|
||||||
|
).toEqual(['nav-tracks']);
|
||||||
|
});
|
||||||
|
|
||||||
it('looks the way it did last time', async () => {
|
it('looks the way it did last time', async () => {
|
||||||
const el = await fixture('app-sidebar');
|
const el = await fixture('app-sidebar');
|
||||||
|
|
||||||
|
|||||||
@@ -7,6 +7,7 @@
|
|||||||
* opening it.
|
* opening it.
|
||||||
*/
|
*/
|
||||||
import { describe, expect, it, beforeEach } from 'vitest';
|
import { describe, expect, it, beforeEach } from 'vitest';
|
||||||
|
import type { LitElement } from 'lit';
|
||||||
|
|
||||||
import '@components/home-view/home-view';
|
import '@components/home-view/home-view';
|
||||||
import { stub, calls, lastArgs, stubFailure } from '@test/support/harness';
|
import { stub, calls, lastArgs, stubFailure } from '@test/support/harness';
|
||||||
@@ -166,7 +167,17 @@ describe('home view', () => {
|
|||||||
|
|
||||||
const before = calls('home.Service.GetShelves').length;
|
const before = calls('home.Service.GetShelves').length;
|
||||||
|
|
||||||
shadow<HTMLElement>(el, 'wa-button')!.click();
|
// The action is declared to `page-header` rather than slotted as
|
||||||
|
// markup (#69), so it is a button in *that* shadow root now.
|
||||||
|
const header = shadow<HTMLElement>(el, 'page-header')!;
|
||||||
|
|
||||||
|
await (header as LitElement).updateComplete;
|
||||||
|
|
||||||
|
header.shadowRoot!
|
||||||
|
.querySelector<HTMLButtonElement>(
|
||||||
|
'[data-testid="page-action-shuffle-suggestions"]',
|
||||||
|
)!
|
||||||
|
.click();
|
||||||
await el.updateComplete;
|
await el.updateComplete;
|
||||||
|
|
||||||
expect(calls('home.Service.GetShelves').length).toBe(before + 1);
|
expect(calls('home.Service.GetShelves').length).toBe(before + 1);
|
||||||
|
|||||||
@@ -44,6 +44,8 @@ const GOVERNED = [
|
|||||||
'regular/bookmark',
|
'regular/bookmark',
|
||||||
'bars-staggered',
|
'bars-staggered',
|
||||||
'tag',
|
'tag',
|
||||||
|
'filter',
|
||||||
|
'ellipsis',
|
||||||
];
|
];
|
||||||
|
|
||||||
/** The one file allowed to say them, plus its own test. */
|
/** The one file allowed to say them, plus its own test. */
|
||||||
|
|||||||
@@ -9,7 +9,7 @@
|
|||||||
* the thing no assertion can — the header looking wrong.
|
* the thing no assertion can — the header looking wrong.
|
||||||
*/
|
*/
|
||||||
import { describe, expect, it } from 'vitest';
|
import { describe, expect, it } from 'vitest';
|
||||||
import type { PageHeader } from '@components/page-header/page-header';
|
import type { PageAction, PageHeader } from '@components/page-header/page-header';
|
||||||
|
|
||||||
import '@components/page-header/page-header';
|
import '@components/page-header/page-header';
|
||||||
import { fixture, shadow, shadowAll, update, visual } from '@test/support/render';
|
import { fixture, shadow, shadowAll, update, visual } from '@test/support/render';
|
||||||
@@ -19,6 +19,67 @@ const SORTS = [
|
|||||||
{ id: 'tracks', label: 'Tracks' },
|
{ id: 'tracks', label: 'Tracks' },
|
||||||
];
|
];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Three actions of the shape that broke: Playlists' own, whose widths
|
||||||
|
* (91 + 122 + 162 = 390px) are what a 700px header could not hold.
|
||||||
|
*/
|
||||||
|
function playlistActions(seen: string[]): PageAction[] {
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
id: 'import',
|
||||||
|
label: 'Import',
|
||||||
|
icon: 'file-import',
|
||||||
|
priority: 0,
|
||||||
|
onSelect: () => seen.push('import'),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'new-playlist',
|
||||||
|
label: 'New Playlist',
|
||||||
|
icon: 'plus',
|
||||||
|
priority: 2,
|
||||||
|
onSelect: () => seen.push('new-playlist'),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'new-smart-playlist',
|
||||||
|
label: 'New Smart Playlist',
|
||||||
|
icon: 'filter',
|
||||||
|
priority: 1,
|
||||||
|
onSelect: () => seen.push('new-smart-playlist'),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resize and let the fit settle.
|
||||||
|
*
|
||||||
|
* The rule is driven by a ResizeObserver, which delivers before paint
|
||||||
|
* and therefore after the microtask queue an `updateComplete` drains —
|
||||||
|
* so this waits on frames rather than on promises, and then on the
|
||||||
|
* render the measurement asks for.
|
||||||
|
*/
|
||||||
|
async function widthOf(el: PageHeader, px: number): Promise<void> {
|
||||||
|
el.style.width = `${px}px`;
|
||||||
|
|
||||||
|
for (let frame = 0; frame < 3; frame += 1) {
|
||||||
|
await new Promise((r) => requestAnimationFrame(r));
|
||||||
|
await el.updateComplete;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The labels currently rendered as buttons, in order. */
|
||||||
|
function buttons(el: PageHeader): string[] {
|
||||||
|
return shadowAll<HTMLButtonElement>(el, '.action')
|
||||||
|
.filter((b) => !b.hidden)
|
||||||
|
.map((b) => b.textContent?.trim() ?? '');
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The labels currently in the overflow menu, in order. */
|
||||||
|
function menu(el: PageHeader): string[] {
|
||||||
|
return shadowAll(el, '#page-header-overflow wa-dropdown-item').map(
|
||||||
|
(i) => i.textContent?.trim() ?? '',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
describe('<page-header>', () => {
|
describe('<page-header>', () => {
|
||||||
it('renders the heading as the page\u2019s only h1', async () => {
|
it('renders the heading as the page\u2019s only h1', async () => {
|
||||||
const el = await fixture<PageHeader>('page-header', {
|
const el = await fixture<PageHeader>('page-header', {
|
||||||
@@ -153,6 +214,264 @@ describe('<page-header>', () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* #69: Playlists slotted three buttons totalling 390px into a header
|
||||||
|
* that gets 700px at 900×600, and "New Smart Playlist" rendered 114 of
|
||||||
|
* its 162. It survived a spec named `layout-overflow` because that one
|
||||||
|
* asserts the *shell* needs no sideways scrolling — clipping inside a
|
||||||
|
* component is invisible to it.
|
||||||
|
*
|
||||||
|
* The header can only fix that for actions it renders itself, which is
|
||||||
|
* why they are data now. These are the assertions about the rule; the
|
||||||
|
* e2e spec is what checks it against the real widths.
|
||||||
|
*/
|
||||||
|
describe('<page-header> actions', () => {
|
||||||
|
it('renders a declared action, and asks the host to perform it', async () => {
|
||||||
|
// Same division the sort control already lives by: the header
|
||||||
|
// decides what fits, the host decides what happens.
|
||||||
|
const seen: string[] = [];
|
||||||
|
const el = await fixture<PageHeader>('page-header', {
|
||||||
|
heading: 'Playlists',
|
||||||
|
actions: playlistActions(seen),
|
||||||
|
});
|
||||||
|
|
||||||
|
await widthOf(el, 1200);
|
||||||
|
|
||||||
|
expect(buttons(el)).toEqual([
|
||||||
|
'Import',
|
||||||
|
'New Playlist',
|
||||||
|
'New Smart Playlist',
|
||||||
|
]);
|
||||||
|
|
||||||
|
shadow<HTMLButtonElement>(el, '[data-testid="page-action-import"]')!.click();
|
||||||
|
|
||||||
|
expect(seen).toEqual(['import']);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('hides the overflow trigger while everything fits', async () => {
|
||||||
|
const el = await fixture<PageHeader>('page-header', {
|
||||||
|
heading: 'Playlists',
|
||||||
|
actions: playlistActions([]),
|
||||||
|
});
|
||||||
|
|
||||||
|
await widthOf(el, 1200);
|
||||||
|
|
||||||
|
expect(shadow<HTMLButtonElement>(el, '.more-button')!.hidden).toBe(true);
|
||||||
|
expect(menu(el)).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('collapses the lowest priority first', async () => {
|
||||||
|
// Import is lowest because it is rarest; New Playlist is highest
|
||||||
|
// because it is the drop target, and a closed menu cannot be one.
|
||||||
|
const el = await fixture<PageHeader>('page-header', {
|
||||||
|
heading: 'Playlists',
|
||||||
|
count: 4,
|
||||||
|
countNoun: 'playlist',
|
||||||
|
sortOptions: SORTS,
|
||||||
|
sortField: 'name',
|
||||||
|
actions: playlistActions([]),
|
||||||
|
});
|
||||||
|
|
||||||
|
// Asserted as the *order* rather than at two chosen widths: which
|
||||||
|
// pixel drops which button depends on the font and on the shell
|
||||||
|
// this tier does not have, and pinning those numbers here would be
|
||||||
|
// a test of the fixture. What the host declares is a sequence.
|
||||||
|
const states: string[][] = [];
|
||||||
|
|
||||||
|
for (let width = 1200; width >= 300; width -= 40) {
|
||||||
|
await widthOf(el, width);
|
||||||
|
|
||||||
|
const now = menu(el);
|
||||||
|
const last = states[states.length - 1];
|
||||||
|
|
||||||
|
if (last === undefined || last.join() !== now.join()) states.push(now);
|
||||||
|
}
|
||||||
|
|
||||||
|
expect(states).toEqual([
|
||||||
|
[],
|
||||||
|
['Import'],
|
||||||
|
['Import', 'New Smart Playlist'],
|
||||||
|
['Import', 'New Playlist', 'New Smart Playlist'],
|
||||||
|
]);
|
||||||
|
|
||||||
|
// The menu lists them in the host's declared order, not in the
|
||||||
|
// order they happened to collapse — a menu that reshuffles itself
|
||||||
|
// as the window narrows is a menu nobody can learn.
|
||||||
|
expect(buttons(el)).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('gives an action back when the width returns', async () => {
|
||||||
|
// Every pass starts from all-visible, so the collapsed set is a
|
||||||
|
// function of the current width and not of how it got there. A rule
|
||||||
|
// that only ever added to the set would never widen again.
|
||||||
|
const el = await fixture<PageHeader>('page-header', {
|
||||||
|
heading: 'Playlists',
|
||||||
|
count: 4,
|
||||||
|
countNoun: 'playlist',
|
||||||
|
sortOptions: SORTS,
|
||||||
|
sortField: 'name',
|
||||||
|
actions: playlistActions([]),
|
||||||
|
});
|
||||||
|
|
||||||
|
await widthOf(el, 420);
|
||||||
|
|
||||||
|
expect(buttons(el)).toEqual([]);
|
||||||
|
|
||||||
|
await widthOf(el, 1200);
|
||||||
|
|
||||||
|
expect(menu(el)).toEqual([]);
|
||||||
|
expect(buttons(el)).toEqual([
|
||||||
|
'Import',
|
||||||
|
'New Playlist',
|
||||||
|
'New Smart Playlist',
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('collapses an action before it truncates the title', async () => {
|
||||||
|
// The title can ellipsis, which means `scrollWidth` reports a
|
||||||
|
// header that fits perfectly while the heading reads "Playlis…" —
|
||||||
|
// this issue's failure mode moved from the button to the title, and
|
||||||
|
// invisible to the same measurement that missed it the first time.
|
||||||
|
const el = await fixture<PageHeader>('page-header', {
|
||||||
|
heading: 'Playlists',
|
||||||
|
count: 4,
|
||||||
|
countNoun: 'playlist',
|
||||||
|
sortOptions: SORTS,
|
||||||
|
sortField: 'name',
|
||||||
|
actions: playlistActions([]),
|
||||||
|
});
|
||||||
|
|
||||||
|
await widthOf(el, 700);
|
||||||
|
|
||||||
|
const h1 = shadow<HTMLElement>(el, 'h1')!;
|
||||||
|
|
||||||
|
expect(h1.scrollWidth).toBeLessThanOrEqual(h1.clientWidth + 1);
|
||||||
|
expect(menu(el).length).toBeGreaterThan(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('names the overflow trigger and says what it controls', async () => {
|
||||||
|
// An overflow menu is exactly the shape that grows a nameless
|
||||||
|
// control, and `aria-controls` cannot name an element that is not
|
||||||
|
// in the DOM — which is why the panel renders unconditionally and
|
||||||
|
// `wa-popup` hides it, the same rule `config-section` follows.
|
||||||
|
const el = await fixture<PageHeader>('page-header', {
|
||||||
|
heading: 'Playlists',
|
||||||
|
count: 4,
|
||||||
|
countNoun: 'playlist',
|
||||||
|
sortOptions: SORTS,
|
||||||
|
sortField: 'name',
|
||||||
|
actions: playlistActions([]),
|
||||||
|
});
|
||||||
|
|
||||||
|
await widthOf(el, 480);
|
||||||
|
|
||||||
|
const more = shadow<HTMLButtonElement>(el, '.more-button')!;
|
||||||
|
|
||||||
|
expect(more.hidden).toBe(false);
|
||||||
|
expect(more.getAttribute('aria-label')).toBe('More actions');
|
||||||
|
expect(more.getAttribute('aria-expanded')).toBe('false');
|
||||||
|
expect(more.getAttribute('aria-haspopup')).toBe('menu');
|
||||||
|
|
||||||
|
const panel = shadow<HTMLElement>(el, '#page-header-overflow')!;
|
||||||
|
|
||||||
|
expect(more.getAttribute('aria-controls')).toBe(panel.id);
|
||||||
|
expect(panel.getAttribute('role')).toBe('menu');
|
||||||
|
|
||||||
|
more.click();
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
expect(
|
||||||
|
shadow<HTMLButtonElement>(el, '.more-button')!.getAttribute(
|
||||||
|
'aria-expanded',
|
||||||
|
),
|
||||||
|
).toBe('true');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('runs a collapsed action from the menu, and closes it', async () => {
|
||||||
|
const seen: string[] = [];
|
||||||
|
const el = await fixture<PageHeader>('page-header', {
|
||||||
|
heading: 'Playlists',
|
||||||
|
count: 4,
|
||||||
|
countNoun: 'playlist',
|
||||||
|
sortOptions: SORTS,
|
||||||
|
sortField: 'name',
|
||||||
|
actions: playlistActions(seen),
|
||||||
|
});
|
||||||
|
|
||||||
|
await widthOf(el, 700);
|
||||||
|
shadow<HTMLButtonElement>(el, '.more-button')!.click();
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
shadowAll<HTMLElement>(el, '#page-header-overflow wa-dropdown-item')[0]!.click();
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
expect(seen).toEqual(['import']);
|
||||||
|
expect(
|
||||||
|
shadow<HTMLButtonElement>(el, '.more-button')!.getAttribute(
|
||||||
|
'aria-expanded',
|
||||||
|
),
|
||||||
|
).toBe('false');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('keeps a drop target a drop target, and does not fake one in the menu', async () => {
|
||||||
|
// You cannot drag a track onto a closed menu, so the affordance is
|
||||||
|
// absent from the overflow rather than approximated there. The
|
||||||
|
// header wires the handlers onto the button and owns none of them.
|
||||||
|
const dropped: string[] = [];
|
||||||
|
const actions: PageAction[] = [
|
||||||
|
{
|
||||||
|
id: 'new-playlist',
|
||||||
|
label: 'New Playlist',
|
||||||
|
icon: 'plus',
|
||||||
|
onSelect: () => undefined,
|
||||||
|
drop: {
|
||||||
|
active: true,
|
||||||
|
onDragOver: () => dropped.push('over'),
|
||||||
|
onDragLeave: () => dropped.push('leave'),
|
||||||
|
onDrop: () => dropped.push('drop'),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
const el = await fixture<PageHeader>('page-header', {
|
||||||
|
heading: 'Playlists',
|
||||||
|
actions,
|
||||||
|
});
|
||||||
|
|
||||||
|
await widthOf(el, 1200);
|
||||||
|
|
||||||
|
const button = shadow<HTMLElement>(
|
||||||
|
el,
|
||||||
|
'[data-testid="page-action-new-playlist"]',
|
||||||
|
)!;
|
||||||
|
|
||||||
|
expect(button.classList.contains('drag-over')).toBe(true);
|
||||||
|
|
||||||
|
button.dispatchEvent(new DragEvent('dragover', { bubbles: true }));
|
||||||
|
button.dispatchEvent(new DragEvent('drop', { bubbles: true }));
|
||||||
|
|
||||||
|
expect(dropped).toEqual(['over', 'drop']);
|
||||||
|
|
||||||
|
// …and collapsed, it is a menu item with no drop wiring at all.
|
||||||
|
await widthOf(el, 120);
|
||||||
|
|
||||||
|
expect(menu(el)).toEqual(['New Playlist']);
|
||||||
|
expect(
|
||||||
|
shadow<HTMLElement>(el, '[data-testid="page-action-new-playlist"]')
|
||||||
|
?.hidden,
|
||||||
|
).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('renders nothing at all for a view with no actions', async () => {
|
||||||
|
// Two of the three hosts have one action and one has none while its
|
||||||
|
// other tab is up; an empty actions row is not a mode.
|
||||||
|
const el = await fixture<PageHeader>('page-header', { heading: 'Albums' });
|
||||||
|
|
||||||
|
await widthOf(el, 900);
|
||||||
|
|
||||||
|
expect(shadow(el, '.actions')).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe('<page-header> as each view wears it', () => {
|
describe('<page-header> as each view wears it', () => {
|
||||||
// One baseline per arrangement rather than per view: the point is
|
// One baseline per arrangement rather than per view: the point is
|
||||||
// that eight views produce four shapes, not eight.
|
// that eight views produce four shapes, not eight.
|
||||||
|
|||||||
@@ -1,11 +1,13 @@
|
|||||||
/**
|
/**
|
||||||
* The three small stores behind view chrome: the global search term,
|
* The small stores behind view chrome: the global search term, the
|
||||||
* the track list's column set, and the explore cache that keeps detail
|
* active view both navs highlight, the track list's column set, and
|
||||||
* pages from re-fetching what a search already returned.
|
* the explore cache that keeps detail pages from re-fetching what a
|
||||||
|
* search already returned.
|
||||||
*/
|
*/
|
||||||
import { describe, expect, it, beforeEach } from 'vitest';
|
import { describe, expect, it, beforeEach } from 'vitest';
|
||||||
|
|
||||||
import { searchStore } from '@store/search-store';
|
import { searchStore } from '@store/search-store';
|
||||||
|
import { activeViewStore } from '@store/active-view-store';
|
||||||
import { trackListStore } from '@store/tracklist-store';
|
import { trackListStore } from '@store/tracklist-store';
|
||||||
import { exploreCache, ARTIST_IMAGE_CACHE_LIMIT } from '@store/explore-cache';
|
import { exploreCache, ARTIST_IMAGE_CACHE_LIMIT } from '@store/explore-cache';
|
||||||
import { Events } from '../../src/events';
|
import { Events } from '../../src/events';
|
||||||
@@ -80,6 +82,57 @@ describe('search store', () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('active view store', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
activeViewStore.setView('home', true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('holds the primary view the shell navigated to', () => {
|
||||||
|
activeViewStore.setView('albums', true);
|
||||||
|
|
||||||
|
expect(activeViewStore.get()).toBe('albums');
|
||||||
|
expect(activeViewStore.isActive('albums')).toBe(true);
|
||||||
|
expect(activeViewStore.isActive('tracks')).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('leaves the primary view lit while a detail view is open', () => {
|
||||||
|
activeViewStore.setView('albums', true);
|
||||||
|
activeViewStore.setView('explore-album-details', false);
|
||||||
|
|
||||||
|
// #72's third finding, made deliberate: a detail view is not a
|
||||||
|
// destination in either nav, and the tab it was opened from is
|
||||||
|
// where the user still is. `app-sidebar` did this by accident (it
|
||||||
|
// guarded on its own item list) and `bottom-nav` did not do it at
|
||||||
|
// all, which is why one looked right and the other looked broken.
|
||||||
|
expect(activeViewStore.get()).toBe('albums');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not notify when the view is unchanged', () => {
|
||||||
|
let notifications = 0;
|
||||||
|
const off = activeViewStore.subscribe(() => {
|
||||||
|
notifications += 1;
|
||||||
|
});
|
||||||
|
|
||||||
|
activeViewStore.setView('albums', true);
|
||||||
|
activeViewStore.setView('albums', true);
|
||||||
|
activeViewStore.setView('explore-album-details', false);
|
||||||
|
off();
|
||||||
|
|
||||||
|
expect(notifications).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('lights nothing for a view with no name', () => {
|
||||||
|
// The store starts empty rather than defaulting to a view, because
|
||||||
|
// a written-down default is right only while `GetDefaultPage()`
|
||||||
|
// agrees with it. That is only safe if the empty value matches
|
||||||
|
// nothing: `isActive` compares strings, and a component asking
|
||||||
|
// about an id it does not have must not light up.
|
||||||
|
activeViewStore.setView('', true);
|
||||||
|
|
||||||
|
expect(activeViewStore.isActive('')).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe('track list store', () => {
|
describe('track list store', () => {
|
||||||
it('starts from the default column set', () => {
|
it('starts from the default column set', () => {
|
||||||
expect(trackListStore.getState().columnIds.length).toBeGreaterThan(0);
|
expect(trackListStore.getState().columnIds.length).toBeGreaterThan(0);
|
||||||
|
|||||||
Reference in New Issue
Block a user