mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-11-22 16:06:19 -05:00
ui: Common.js and thirteen more files off Semantic
Phase 2, part 3. Baseline 63 -> 50.
Common.js is the one that mattered: 51 files import it, so its Semantic usage
was propping up the rest of the migration. Everything in it now comes from the
library -- Paginator, the two search inputs, DirectorySearch, TabLinks, the
toggles, the messages, APIButton, Breadcrumbs, SimpleAccordion, IframeViewer,
CardPoster, FileIcon, LoadStatistic, the theme menu, and the hotspot icons.
Also migrated: Placeholder, Apps, ArchivePreview, CbzViewer, AddToPlaylist,
TaggedDeleteConfirmModal, the collection edit/tag forms, and four inventory
components.
New in the library, all in the gallery and tested:
SearchBox Semantic's `<Search category>` with its grouped results shape
kept, because four call sites already build it. A real
combobox rather than a div that listens for clicks.
Pagination Semantic's prop names; onPageChange gets the page number.
TabBar the strip only -- routing stays with the caller.
IconStack Semantic's IconGroup, named once for assistive technology.
Table.HeaderCell sorted/onSort -- a real button carrying aria-sort.
Button/IconButton translate Semantic's size names.
That last one is defensive: unmigrated callers still pass size='tiny', and
Mantine drops a size it does not recognise without a word, so the button
quietly renders at the wrong size. Mapping here keeps the mixed state honest.
Three real bugs found and fixed on the way, none of them cosmetic:
* `fileSuffixIconName` returned fourteen icon names the map did not have, so
opening a folder with a PDF, a Word document or an archive in it logged an
error and drew a fallback glyph. All fourteen mapped, with a test that
walks the mapper's own return values, and another asserting every mapped
name resolves to a Tabler component that exists.
* `Statistic` relied on Semantic's `Statistic.Group` for its spacing, so on
the dashboard the load averages ran together into "1 MIN. LOAD5 MIN.
LOAD15 MIN. LOAD". It carries its own spacing now.
* Semantic's inverted stylesheet colors every descendant of an inverted
segment, so Toggle labels inherited #dddddd -- white pixels in night mode,
on the Settings page, which is exactly where someone adjusts their WROLPi
in the dark. Restated from tokens.
The baseline ratchet gained a third assertion: a migrated file may still lean
on Semantic's CSS classes without importing the library, which the import check
cannot see and which would collapse silently when Phase 4 deletes the
stylesheet. There is one such bridge today and it is now declared.
This commit is contained in:
parent
18dc90b4c2
commit
851485ef1b
35 changed files with 978 additions and 1095 deletions
|
|
@ -39,6 +39,30 @@ const renderIcon = (icon?: string | React.ComponentType<any>) => {
|
|||
return typeof icon === 'string' ? <Icon name={icon}/> : <Icon component={icon}/>;
|
||||
}
|
||||
|
||||
/*
|
||||
* Semantic's size names, mapped onto Mantine's scale.
|
||||
*
|
||||
* Unmigrated call sites still pass `size='tiny'`, and Mantine silently ignores a
|
||||
* size it does not know — the button renders at the default size and nobody sees
|
||||
* a warning. Translating here keeps those call sites looking right until they
|
||||
* migrate, and costs nothing once they have.
|
||||
*/
|
||||
const semanticSizes: Record<string, string> = {
|
||||
mini: 'xs',
|
||||
tiny: 'xs',
|
||||
small: 'sm',
|
||||
medium: 'md',
|
||||
large: 'lg',
|
||||
big: 'lg',
|
||||
huge: 'xl',
|
||||
massive: 'xl',
|
||||
};
|
||||
|
||||
// Generic so it passes each component's own size type straight through; only a
|
||||
// string that Semantic knew about is rewritten.
|
||||
export const resolveSize = <T, >(size: T): T =>
|
||||
typeof size === 'string' ? ((semanticSizes[size] ?? size) as T) : size;
|
||||
|
||||
export const Button = forwardRef<HTMLButtonElement, ButtonProps>((
|
||||
{role, icon, iconAfter, className, ...props}, ref
|
||||
) => {
|
||||
|
|
@ -52,6 +76,7 @@ export const Button = forwardRef<HTMLButtonElement, ButtonProps>((
|
|||
leftSection={renderIcon(icon)}
|
||||
rightSection={renderIcon(iconAfter)}
|
||||
{...props}
|
||||
size={resolveSize(props.size)}
|
||||
/>
|
||||
});
|
||||
Button.displayName = 'Button';
|
||||
|
|
@ -78,6 +103,7 @@ export const IconButton = forwardRef<HTMLButtonElement, IconButtonProps>((
|
|||
variant={props.variant ?? fromRole?.variant ?? 'default'}
|
||||
className={[fromRole?.className, className].filter(Boolean).join(' ') || undefined}
|
||||
{...props}
|
||||
size={resolveSize(props.size)}
|
||||
>
|
||||
{renderIcon(icon)}
|
||||
</ActionIcon>
|
||||
|
|
|
|||
|
|
@ -25,6 +25,7 @@ const sizes: Record<IconSize, number> = {small: 16, medium: 20, large: 24};
|
|||
*/
|
||||
const semanticNames: Record<string, keyof typeof Tabler> = {
|
||||
'add': 'IconPlus',
|
||||
'apple': 'IconBrandApple',
|
||||
'archive': 'IconArchive',
|
||||
'arrow alternate circle up': 'IconCircleArrowUp',
|
||||
'arrow down': 'IconArrowDown',
|
||||
|
|
@ -35,6 +36,7 @@ const semanticNames: Record<string, keyof typeof Tabler> = {
|
|||
'bug': 'IconBug',
|
||||
'calculator': 'IconCalculator',
|
||||
'calendar': 'IconCalendar',
|
||||
'certificate': 'IconCertificate',
|
||||
'charset': 'IconLanguage',
|
||||
'check': 'IconCheck',
|
||||
'check circle': 'IconCircleCheck',
|
||||
|
|
@ -46,11 +48,13 @@ const semanticNames: Record<string, keyof typeof Tabler> = {
|
|||
'circle notch': 'IconLoader2',
|
||||
'circle notched': 'IconLoader2',
|
||||
'close': 'IconX',
|
||||
'closed captioning': 'IconBadgeCc',
|
||||
'columns': 'IconColumns',
|
||||
'copy': 'IconCopy',
|
||||
'cube': 'IconCube',
|
||||
'directory': 'IconFolder',
|
||||
'disk': 'IconDatabase',
|
||||
'dot circle': 'IconCircleDot',
|
||||
'download': 'IconDownload',
|
||||
'dropdown': 'IconChevronDown',
|
||||
'edit': 'IconEdit',
|
||||
|
|
@ -63,10 +67,16 @@ const semanticNames: Record<string, keyof typeof Tabler> = {
|
|||
'file': 'IconFile',
|
||||
'file alternate': 'IconFileDescription',
|
||||
'file alternate outline': 'IconFileDescription',
|
||||
'file archive': 'IconFileZip',
|
||||
'file audio': 'IconFileMusic',
|
||||
'file code': 'IconFileCode',
|
||||
'file excel': 'IconFileSpreadsheet',
|
||||
'file pdf': 'IconFileTypePdf',
|
||||
'file pdf outline': 'IconFileTypePdf',
|
||||
'file powerpoint': 'IconPresentation',
|
||||
'file text': 'IconFileText',
|
||||
'file video': 'IconFileSmile',
|
||||
'file word': 'IconFileText',
|
||||
'film': 'IconMovie',
|
||||
'filter': 'IconFilter',
|
||||
'firefox': 'IconBrandFirefox',
|
||||
|
|
@ -74,6 +84,7 @@ const semanticNames: Record<string, keyof typeof Tabler> = {
|
|||
'folder open': 'IconFolderOpen',
|
||||
'folder open outline': 'IconFolderOpen',
|
||||
'folder outline': 'IconFolder',
|
||||
'font': 'IconTypography',
|
||||
'globe': 'IconWorld',
|
||||
'hand point right': 'IconHandFinger',
|
||||
'hdd': 'IconDeviceSdCard',
|
||||
|
|
@ -84,14 +95,16 @@ const semanticNames: Record<string, keyof typeof Tabler> = {
|
|||
'lightbulb': 'IconBulb',
|
||||
'lightbulb outline': 'IconBulb',
|
||||
'lightning': 'IconBolt',
|
||||
'moon': 'IconMoon',
|
||||
'moon outline': 'IconMoon',
|
||||
'linkify': 'IconLink',
|
||||
'linux': 'IconBrandUbuntu',
|
||||
'list': 'IconList',
|
||||
'lock': 'IconLock',
|
||||
'mail': 'IconMail',
|
||||
'map outline': 'IconMap',
|
||||
'microchip': 'IconCpu',
|
||||
'minus': 'IconMinus',
|
||||
'moon': 'IconMoon',
|
||||
'moon outline': 'IconMoon',
|
||||
'paypal': 'IconBrandPaypal',
|
||||
'play': 'IconPlayerPlay',
|
||||
'plug': 'IconPlug',
|
||||
|
|
@ -131,6 +144,7 @@ const semanticNames: Record<string, keyof typeof Tabler> = {
|
|||
'warning circle': 'IconAlertCircle',
|
||||
'warning sign': 'IconAlertTriangle',
|
||||
'wifi': 'IconWifi',
|
||||
'windows': 'IconBrandWindows',
|
||||
'wrench': 'IconTool',
|
||||
'x': 'IconX',
|
||||
};
|
||||
|
|
|
|||
|
|
@ -68,10 +68,12 @@ export interface StatisticProps {
|
|||
value: React.ReactNode;
|
||||
label: React.ReactNode;
|
||||
color?: string;
|
||||
className?: string;
|
||||
style?: React.CSSProperties;
|
||||
}
|
||||
|
||||
export function Statistic({value, label, color}: StatisticProps) {
|
||||
return <div>
|
||||
export function Statistic({value, label, color, className, style}: StatisticProps) {
|
||||
return <div className={['wrolpi-statistic', className].filter(Boolean).join(' ')} style={style}>
|
||||
<div className='wrolpi-statistic-value' style={{color: color ? `var(--${color})` : undefined}}>
|
||||
{value}
|
||||
</div>
|
||||
|
|
@ -89,6 +91,7 @@ export function StatisticGroup({children}: {children: React.ReactNode}) {
|
|||
}}>
|
||||
{items.map((child, index) => <div
|
||||
key={index}
|
||||
className='wrolpi-statistic-cell'
|
||||
style={{
|
||||
background: 'var(--panel)',
|
||||
padding: '14px 16px',
|
||||
|
|
|
|||
|
|
@ -368,6 +368,26 @@ html[data-theme="amber"] .wrolpi-searchbox-control:focus-within {
|
|||
* non-red pixel on screen in night mode. Scoped to `:not(:checked)` so the
|
||||
* checked track keeps coming from the `color` prop.
|
||||
*/
|
||||
/*
|
||||
* Semantic's inverted stylesheet colors *every* descendant of `.ui.inverted.segment`
|
||||
* (rgba(255,255,255,.9), and #dddddd on labels). Our components are mounted inside
|
||||
* unmigrated pages that still use those wrappers, so an inherited color puts white
|
||||
* pixels on screen in night mode. Restating from tokens is the fix; the rule can go
|
||||
* when the last Semantic wrapper does.
|
||||
*/
|
||||
.wrolpi-switch .mantine-Switch-label {
|
||||
color: var(--text);
|
||||
}
|
||||
|
||||
.wrolpi-switch .mantine-Switch-description {
|
||||
color: var(--muted);
|
||||
}
|
||||
|
||||
.wrolpi-switch input:disabled + * .mantine-Switch-label,
|
||||
.wrolpi-switch input:disabled ~ * .mantine-Switch-label {
|
||||
color: var(--muted);
|
||||
}
|
||||
|
||||
.wrolpi-switch input:not(:checked) + .mantine-Switch-track {
|
||||
--switch-bg: var(--border);
|
||||
}
|
||||
|
|
@ -599,7 +619,60 @@ html[data-theme="amber"] .wrolpi-progress-fill {
|
|||
border: 1.5px dashed var(--red);
|
||||
}
|
||||
|
||||
/* ----------------------------------------------------------- Card posters */
|
||||
/*
|
||||
* The icon shown when a file has no poster, and the corner mark for a tagged
|
||||
* file. Both live here rather than in Common.js so the card surface and the
|
||||
* poster area agree in every theme.
|
||||
*/
|
||||
|
||||
.wrolpi-card-icon {
|
||||
position: relative;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
min-height: 120px;
|
||||
background: var(--head);
|
||||
}
|
||||
|
||||
.wrolpi-card-tag {
|
||||
position: absolute;
|
||||
top: 0;
|
||||
left: 0;
|
||||
display: flex;
|
||||
padding: 3px 4px;
|
||||
background: var(--green);
|
||||
color: var(--btn-text);
|
||||
}
|
||||
|
||||
/* Night and amber have no green to spend; the mark reads as an outline instead. */
|
||||
html[data-theme="night"] .wrolpi-card-tag,
|
||||
html[data-theme="amber"] .wrolpi-card-tag {
|
||||
background: var(--panel);
|
||||
color: var(--text);
|
||||
border-right: 1px solid var(--border);
|
||||
border-bottom: 1px solid var(--border);
|
||||
}
|
||||
|
||||
/* ------------------------------------------------------------- Statistics */
|
||||
/*
|
||||
* A statistic carries its own spacing rather than relying on a parent to supply
|
||||
* it: unmigrated pages still drop these inside Semantic's `Statistic.Group`,
|
||||
* whose CSS only spaces elements carrying Semantic's own classes, and without
|
||||
* this the labels run together into one unreadable line.
|
||||
*/
|
||||
|
||||
.wrolpi-statistic {
|
||||
display: inline-block;
|
||||
vertical-align: top;
|
||||
margin: 0 26px 10px 0;
|
||||
}
|
||||
|
||||
/* Inside our own group the grid does the spacing, so the intrinsic margin goes. */
|
||||
.wrolpi-statistic-cell .wrolpi-statistic {
|
||||
display: block;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.wrolpi-statistic-value {
|
||||
font-size: 24px;
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import React from 'react';
|
||||
import {render, screen} from '@testing-library/react';
|
||||
import userEvent from '@testing-library/user-event';
|
||||
|
|
@ -78,6 +80,30 @@ describe('Icon', () => {
|
|||
expect(unmapped.map(c => `${c.text}: ${c.icon}`)).toEqual([]);
|
||||
});
|
||||
|
||||
it('maps every name the mimetype and file-suffix helpers can return', () => {
|
||||
// These two build icon names from arbitrary files in the user's library, so an
|
||||
// unmapped one is not hypothetical — it is a console error and a fallback glyph
|
||||
// the moment somebody opens a folder containing that file type.
|
||||
const common = fs.readFileSync(path.join(__dirname, '..', 'Common.js'), 'utf8');
|
||||
const section = common.slice(
|
||||
common.indexOf('export function mimetypeIconName'),
|
||||
common.indexOf('export function FileIcon'));
|
||||
const returned = [...new Set([...section.matchAll(/return '([^']+)'/g)].map(m => m[1]))];
|
||||
|
||||
expect(returned.length).toBeGreaterThan(10);
|
||||
expect(returned.filter(name => !resolveIconName(name))).toEqual([]);
|
||||
});
|
||||
|
||||
it('points every mapped name at a Tabler component that exists', () => {
|
||||
// A typo in the map resolves to undefined and renders the fallback glyph, which
|
||||
// looks like a design choice rather than a bug.
|
||||
const source = fs.readFileSync(path.join(__dirname, 'Icon.tsx'), 'utf8');
|
||||
const names = [...source.matchAll(/^ {4}'([^']+)': '([^']+)',$/gm)].map(m => m[1]);
|
||||
|
||||
expect(names.length).toBeGreaterThan(100);
|
||||
expect(names.filter(name => !resolveIconName(name))).toEqual([]);
|
||||
});
|
||||
|
||||
it('reports an unknown name instead of failing silently', () => {
|
||||
const error = jest.spyOn(console, 'error').mockImplementation(() => {});
|
||||
|
||||
|
|
@ -116,6 +142,16 @@ describe('Button', () => {
|
|||
expect(screen.getByRole('button', {name: 'Save'})).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('translates Semantic size names, which Mantine would otherwise ignore', () => {
|
||||
// Unmigrated call sites still pass size='tiny'. Mantine drops a size it does not
|
||||
// recognise without warning, so the button quietly renders at the default size.
|
||||
renderUI(<><Button size='tiny'>Old</Button><Button size='sm'>New</Button></>);
|
||||
|
||||
expect(screen.getByRole('button', {name: 'Old'})).toHaveAttribute('data-size', 'xs');
|
||||
// A Mantine size still passes through untouched.
|
||||
expect(screen.getByRole('button', {name: 'New'})).toHaveAttribute('data-size', 'sm');
|
||||
});
|
||||
|
||||
it('gives icon-only buttons an accessible name', () => {
|
||||
renderUI(<IconButton icon='trash' label='Delete channel'/>);
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue