@estiva-app/ui 0.119.0 → 0.121.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/CollapsibleSection.d.ts.map +1 -1
- package/dist/ListColumn.d.ts +6 -0
- package/dist/ListColumn.d.ts.map +1 -1
- package/dist/NavItem.d.ts.map +1 -1
- package/dist/NavTree.d.ts +7 -1
- package/dist/NavTree.d.ts.map +1 -1
- package/dist/SectionHeader.d.ts.map +1 -1
- package/dist/Skeleton.d.ts +1 -1
- package/dist/Skeleton.d.ts.map +1 -1
- package/dist/index.js +163 -93
- package/dist/index.js.map +3 -3
- package/dist/revealCurrentRow.d.ts +16 -3
- package/dist/revealCurrentRow.d.ts.map +1 -1
- package/package.json +1 -1
- package/registry.json +15 -3
- package/src/CollapsibleSection.mdx +6 -3
- package/src/CollapsibleSection.test.tsx +22 -0
- package/src/CollapsibleSection.tsx +2 -1
- package/src/ListColumn.mdx +5 -0
- package/src/ListColumn.stories.tsx +26 -1
- package/src/ListColumn.tsx +12 -4
- package/src/NavItem.mdx +2 -2
- package/src/NavItem.test.tsx +10 -1
- package/src/NavItem.tsx +9 -4
- package/src/NavTree.mdx +10 -0
- package/src/NavTree.stories.tsx +33 -0
- package/src/NavTree.test.tsx +26 -0
- package/src/NavTree.tsx +9 -2
- package/src/SectionHeader.mdx +3 -3
- package/src/SectionHeader.tsx +2 -1
- package/src/Skeleton.mdx +2 -2
- package/src/Skeleton.tsx +2 -2
- package/src/heights.test.tsx +8 -1
- package/src/revealCurrentRow.test.tsx +118 -2
- package/src/revealCurrentRow.ts +116 -7
|
@@ -20,9 +20,22 @@ export declare const REVEAL_MS = 200;
|
|
|
20
20
|
* `block: 'nearest'` does (a row is never that tall).
|
|
21
21
|
*/
|
|
22
22
|
export declare function scrollToRow(row: HTMLElement): void;
|
|
23
|
+
/** For tests: every list forgets where it was. */
|
|
24
|
+
export declare function forgetListPlaces(): void;
|
|
25
|
+
/** How long a list drawn again keeps trying to reach where it was left, while its rows are still being drawn. */
|
|
26
|
+
export declare const RESTORE_MS = 2000;
|
|
27
|
+
/** A named list's place, for the reveal inside it: its name, and whether it is still going back to where it was. */
|
|
28
|
+
export interface ListPlace {
|
|
29
|
+
name?: string;
|
|
30
|
+
restoring: RefObject<boolean>;
|
|
31
|
+
}
|
|
32
|
+
/** The list a row is revealed in: a `ListColumn` gives its name to the tree inside it, which reveals nothing itself. */
|
|
33
|
+
export declare const ListPlaceContext: import("react").Context<ListPlace | null>;
|
|
23
34
|
/**
|
|
24
|
-
*
|
|
25
|
-
* (
|
|
35
|
+
* Goes back to where the named list was left, and keeps note of where the reader leaves it. Its rows may still be
|
|
36
|
+
* drawing (a skeleton, a fold that reads its own rows): it tries again as the list grows, until it is there, the reader
|
|
37
|
+
* scrolls, something else moves it (a row brought into sight), or `RESTORE_MS` has passed.
|
|
26
38
|
*/
|
|
27
|
-
export declare function
|
|
39
|
+
export declare function useListPlace(box: RefObject<HTMLElement | null>, name: string | undefined): ListPlace;
|
|
40
|
+
export declare function useRevealCurrentRow(box: RefObject<HTMLElement | null>, current?: string, place?: ListPlace): void;
|
|
28
41
|
//# sourceMappingURL=revealCurrentRow.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"revealCurrentRow.d.ts","sourceRoot":"","sources":["../src/revealCurrentRow.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"revealCurrentRow.d.ts","sourceRoot":"","sources":["../src/revealCurrentRow.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0E,KAAK,SAAS,EAAE,MAAM,OAAO,CAAA;AAE9G;;;;;;;;;;;GAWG;AAEH,qGAAqG;AACrG,eAAO,MAAM,SAAS,MAAM,CAAA;AAE5B;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,WAAW,QAK3C;AAyBD,kDAAkD;AAClD,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC;AAED,iHAAiH;AACjH,eAAO,MAAM,UAAU,OAAO,CAAA;AAE9B,oHAAoH;AACpH,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;CAC9B;AAED,wHAAwH;AACxH,eAAO,MAAM,gBAAgB,2CAAwC,CAAA;AAErE;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAwDpG;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,GAAG,IAAI,CA0CjH"}
|
package/package.json
CHANGED
package/registry.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"kind": "package",
|
|
5
5
|
"repo": "estiva-ui",
|
|
6
6
|
"package": "@estiva-app/ui",
|
|
7
|
-
"packageVersion": "0.
|
|
7
|
+
"packageVersion": "0.121.0",
|
|
8
8
|
"exports": 256,
|
|
9
9
|
"typeExports": 270,
|
|
10
10
|
"files": null
|
|
@@ -6709,6 +6709,12 @@
|
|
|
6709
6709
|
"required": true,
|
|
6710
6710
|
"note": "The rows, 2px apart. Groups are headed by a `CollapsibleSection` or a `SectionHeader`."
|
|
6711
6711
|
},
|
|
6712
|
+
{
|
|
6713
|
+
"name": "rememberAs",
|
|
6714
|
+
"takes": "text",
|
|
6715
|
+
"required": false,
|
|
6716
|
+
"note": "The list's name in the app (`teams`, `dms`): where it was scrolled is remembered by it in this tab, and the same column drawn again (on another page) goes back there, its open row still brought into sight when it is a new one."
|
|
6717
|
+
},
|
|
6712
6718
|
{
|
|
6713
6719
|
"name": "className",
|
|
6714
6720
|
"takes": "text",
|
|
@@ -8054,6 +8060,12 @@
|
|
|
8054
8060
|
"takes": "text",
|
|
8055
8061
|
"required": false,
|
|
8056
8062
|
"note": "Remember each group open or closed in this browser, under this key and the group's id."
|
|
8063
|
+
},
|
|
8064
|
+
{
|
|
8065
|
+
"name": "spaced",
|
|
8066
|
+
"takes": "true/false",
|
|
8067
|
+
"required": false,
|
|
8068
|
+
"note": "8px between the items an app draws as `children`, none above the first: a tree whose items are each a place with rows under it — Peek's teams (Katerina, 17 November: \"a bit more spacing between the parent expandable items\")."
|
|
8057
8069
|
}
|
|
8058
8070
|
],
|
|
8059
8071
|
"variants": [],
|
|
@@ -10431,7 +10443,7 @@
|
|
|
10431
10443
|
"kind": "component",
|
|
10432
10444
|
"importPath": "@estiva-app/ui",
|
|
10433
10445
|
"sourceFile": "src/SectionHeader.tsx",
|
|
10434
|
-
"purpose": "The
|
|
10446
|
+
"purpose": "The 28px row a section starts with, a list row's height: a SectionLabel, and actions that appear while the row is hovered or keyboard-focused, as IconButtons with tooltips — always, on a screen with no hover.",
|
|
10435
10447
|
"purposeFrom": "page",
|
|
10436
10448
|
"props": [
|
|
10437
10449
|
{
|
|
@@ -11200,7 +11212,7 @@
|
|
|
11200
11212
|
"kind": "component",
|
|
11201
11213
|
"importPath": "@estiva-app/ui",
|
|
11202
11214
|
"sourceFile": "src/Skeleton.tsx",
|
|
11203
|
-
"purpose": "A
|
|
11215
|
+
"purpose": "A 28px row, a list row's height: a 16px square and a bar, like a row with a face and a name.",
|
|
11204
11216
|
"purposeFrom": "comment",
|
|
11205
11217
|
"props": [
|
|
11206
11218
|
{
|
|
@@ -46,13 +46,16 @@ toggle, and the rows under it, sliding shut and open.
|
|
|
46
46
|
revealed while the row is hovered or keyboard-focused.
|
|
47
47
|
- `look="row"` when the section is a row among rows — a folder in a
|
|
48
48
|
sidebar, under a quiet label: the title at a row's weight, and its rows
|
|
49
|
-
indented under it, past the chevron
|
|
49
|
+
indented under it, past the chevron, the tree's line beside them, 1px
|
|
50
|
+
down from the chevron's middle (Katerina, 17 November), as a **NavItem**'s
|
|
51
|
+
rows have it.
|
|
50
52
|
|
|
51
53
|
<Canvas of={CollapsibleSectionStories.AsARow} />
|
|
52
54
|
|
|
53
55
|
- `indent` with the standard heading: its rows start under its title, past
|
|
54
|
-
the chevron — a group in a sidebar whose rows
|
|
55
|
-
draws its groups this way.
|
|
56
|
+
the chevron, the tree's line beside them — a group in a sidebar whose rows
|
|
57
|
+
read as inside it. **NavTree** draws its groups this way. The standard
|
|
58
|
+
heading without `indent` has no line: its rows are level with its title.
|
|
56
59
|
|
|
57
60
|
<Canvas of={CollapsibleSectionStories.Indented} />
|
|
58
61
|
|
|
@@ -93,6 +93,28 @@ describe('CollapsibleSection', () => {
|
|
|
93
93
|
})
|
|
94
94
|
|
|
95
95
|
/** Opened before its rows are in (0.65.1, OPT-11): the title says open, the panel waits. */
|
|
96
|
+
// The tree's line, as a row's (Katerina, 17 November).
|
|
97
|
+
describe('CollapsibleSection, its rows', () => {
|
|
98
|
+
it('a row-look fold draws the tree’s line beside its rows, 24px in', () => {
|
|
99
|
+
render(
|
|
100
|
+
<CollapsibleSection look="row" title="Files">
|
|
101
|
+
<a href="#one">One</a>
|
|
102
|
+
</CollapsibleSection>,
|
|
103
|
+
)
|
|
104
|
+
const classes = screen.getByRole('link', { name: 'One' }).parentElement!.className.split(' ')
|
|
105
|
+
expect(classes).toEqual(expect.arrayContaining(['border-l', 'border-border-default', 'ml-[15px]', 'pl-2']))
|
|
106
|
+
})
|
|
107
|
+
|
|
108
|
+
it('a heading draws no line: its rows are level with its title', () => {
|
|
109
|
+
render(
|
|
110
|
+
<CollapsibleSection title="Starred">
|
|
111
|
+
<a href="#one">One</a>
|
|
112
|
+
</CollapsibleSection>,
|
|
113
|
+
)
|
|
114
|
+
expect(screen.getByRole('link', { name: 'One' }).parentElement!.className.split(' ')).not.toContain('border-l')
|
|
115
|
+
})
|
|
116
|
+
})
|
|
117
|
+
|
|
96
118
|
describe('CollapsibleSection, pending', () => {
|
|
97
119
|
it('the title says open and busy while the rows stay shut, then they open', () => {
|
|
98
120
|
const { rerender } = render(<CollapsibleSection title="Section" open pending>{rows}</CollapsibleSection>)
|
|
@@ -191,7 +191,8 @@ export function CollapsibleSection({ title, defaultOpen = true, open: openProp,
|
|
|
191
191
|
>
|
|
192
192
|
{/* A row's rows start under its title: the 16px chevron and its 8px gap
|
|
193
193
|
(pl-6). An indented heading's: the same — its arrow is a row's now (5 October). */}
|
|
194
|
-
|
|
194
|
+
{/* The tree's line, as NavItem's (Katerina, 17 November): under the arrow's middle, the rows 24px in as before. */}
|
|
195
|
+
<div className={cn('flex flex-col', look === 'row' || indent ? 'ml-[15px] mt-0.5 border-l border-border-default pl-2' : 'pt-0.5', contentClassName)}>{children}</div>
|
|
195
196
|
</Collapsible.Panel>
|
|
196
197
|
</Collapsible.Root>
|
|
197
198
|
)
|
package/src/ListColumn.mdx
CHANGED
|
@@ -65,6 +65,11 @@ import { ListColumn, Toolbar, ToolbarButton } from '@estiva-app/ui'
|
|
|
65
65
|
side.
|
|
66
66
|
- The rows are yours. It scrolls them, so a list that grows with its data is
|
|
67
67
|
never cut off at the fold, even when today's data fits.
|
|
68
|
+
- Give the column its name in the app, `rememberAs` (`teams`, `dms`): where it
|
|
69
|
+
was scrolled is remembered by it in this tab, and the same column drawn again
|
|
70
|
+
on another page opens where the reader left it, not at the top. An open row it
|
|
71
|
+
already brought into sight is not brought back; a new one is. Without a name,
|
|
72
|
+
it opens at the top each time it is drawn.
|
|
68
73
|
- **Planned:** dragging its edge to resize it, with `SplitLayout` in
|
|
69
74
|
`@estiva-app/ui/layout` (migration stage 8). The 380px column beside a
|
|
70
75
|
conversation gets the same treatment then.
|
|
@@ -132,7 +132,8 @@ function OpenRows({ open: first, late = false }: { open: number; late?: boolean
|
|
|
132
132
|
{Array.from({ length: 80 }, (_, i) => (
|
|
133
133
|
<NavItem
|
|
134
134
|
key={i}
|
|
135
|
-
|
|
135
|
+
// Each its own address, as an app's rows are: a list knows its open row by it.
|
|
136
|
+
href={`#item-${i + 1}`}
|
|
136
137
|
label={`Item ${i + 1}`}
|
|
137
138
|
icon={icon}
|
|
138
139
|
active={i === open}
|
|
@@ -169,6 +170,30 @@ export const OpenRowDrawnLate: Story = {
|
|
|
169
170
|
),
|
|
170
171
|
}
|
|
171
172
|
|
|
173
|
+
/**
|
|
174
|
+
* Drawn again where it was left (`rememberAs`): scroll down, then "Another page" draws the column anew, as an app does
|
|
175
|
+
* when it moves to another page that shows the same column. It opens where you left it, not at the top, and its open
|
|
176
|
+
* row, already brought into sight once, is not brought back.
|
|
177
|
+
*/
|
|
178
|
+
export const DrawnAgainWhereItWasLeft: Story = {
|
|
179
|
+
args: { title: 'Items' },
|
|
180
|
+
render: function Render(args) {
|
|
181
|
+
const [page, setPage] = useState(0)
|
|
182
|
+
return (
|
|
183
|
+
<div className="flex h-full">
|
|
184
|
+
<ListColumn key={page} {...args} rememberAs="story-items">
|
|
185
|
+
<OpenRows open={5} />
|
|
186
|
+
</ListColumn>
|
|
187
|
+
<div className="p-4">
|
|
188
|
+
<Button size="small" onClick={() => setPage((n) => n + 1)}>
|
|
189
|
+
Another page
|
|
190
|
+
</Button>
|
|
191
|
+
</div>
|
|
192
|
+
</div>
|
|
193
|
+
)
|
|
194
|
+
},
|
|
195
|
+
}
|
|
196
|
+
|
|
172
197
|
/** While the list is on its way: a skeleton shaped like the rows. */
|
|
173
198
|
export const Loading: Story = {
|
|
174
199
|
args: { title: 'Items' },
|
package/src/ListColumn.tsx
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { useRef, type ReactNode } from 'react'
|
|
2
2
|
import { cn } from './cn'
|
|
3
|
-
import { useRevealCurrentRow } from './revealCurrentRow'
|
|
3
|
+
import { ListPlaceContext, useListPlace, useRevealCurrentRow } from './revealCurrentRow'
|
|
4
4
|
import { ContainerHeader } from './ContainerHeader'
|
|
5
5
|
import { ErrorBoundary } from './ErrorBoundary'
|
|
6
6
|
import { FOLDED_CLASSES, FOLD_MOTION_CLASSES, UNFOLDED_CLASSES } from './looks'
|
|
@@ -51,13 +51,20 @@ export interface ListColumnProps {
|
|
|
51
51
|
collapsed?: boolean
|
|
52
52
|
/** The rows, 2px apart. Groups are headed by a `CollapsibleSection` or a `SectionHeader`. */
|
|
53
53
|
children: ReactNode
|
|
54
|
+
/**
|
|
55
|
+
* The list's name in the app (`teams`, `dms`): where it was scrolled is remembered by it in this tab, and the same
|
|
56
|
+
* column drawn again (on another page) goes back there, its open row still brought into sight when it is a new one.
|
|
57
|
+
* Without it, it opens at the top each time it is drawn.
|
|
58
|
+
*/
|
|
59
|
+
rememberAs?: string
|
|
54
60
|
/** Placement only. */
|
|
55
61
|
className?: string
|
|
56
62
|
}
|
|
57
63
|
|
|
58
|
-
function Column({ title, chevron = false, titleMenu, actions, above, collapsed = false, children, className, broken = false }: ListColumnProps & { broken?: boolean }) {
|
|
64
|
+
function Column({ title, chevron = false, titleMenu, actions, above, collapsed = false, children, rememberAs, className, broken = false }: ListColumnProps & { broken?: boolean }) {
|
|
59
65
|
const rows = useRef<HTMLDivElement>(null)
|
|
60
|
-
|
|
66
|
+
const place = useListPlace(rows, broken ? undefined : rememberAs)
|
|
67
|
+
useRevealCurrentRow(rows, undefined, place)
|
|
61
68
|
return (
|
|
62
69
|
<div
|
|
63
70
|
className={cn(
|
|
@@ -78,7 +85,8 @@ function Column({ title, chevron = false, titleMenu, actions, above, collapsed =
|
|
|
78
85
|
<div className="flex min-h-0 flex-1 flex-col px-3">{children}</div>
|
|
79
86
|
) : (
|
|
80
87
|
<ScrollArea className="flex-1" viewportRef={rows} contentClassName="flex flex-col gap-0.5 px-3 pt-4 pb-3">
|
|
81
|
-
{
|
|
88
|
+
{/* A tree in it leaves bringing its open row into sight to the column, which knows where it was left. */}
|
|
89
|
+
<ListPlaceContext.Provider value={place}>{children}</ListPlaceContext.Provider>
|
|
82
90
|
</ScrollArea>
|
|
83
91
|
)}
|
|
84
92
|
</div>
|
package/src/NavItem.mdx
CHANGED
|
@@ -142,7 +142,7 @@ import { NavItem } from '@estiva-app/ui'
|
|
|
142
142
|
place for that row; another site's address, a `target` and a `download` stay
|
|
143
143
|
the browser's.
|
|
144
144
|
|
|
145
|
-
- A row is 32px
|
|
145
|
+
- A row is 28px tall (32px until 17 November), 8px in on each side, 8px between the icon and the label,
|
|
146
146
|
the label 14px regular (medium when unread), 8px corners as a **MenuItem**'s.
|
|
147
147
|
|
|
148
148
|
## What it owns
|
|
@@ -152,7 +152,7 @@ It does these by itself. Write none of them around it.
|
|
|
152
152
|
| It does | So you never write | Refused when written by hand |
|
|
153
153
|
|---|---|---|
|
|
154
154
|
| Marks the current place for assistive technology when `active` | `aria-current` | |
|
|
155
|
-
| Keeps its
|
|
155
|
+
| Keeps its 28px in a scrolling column | `shrink-0` | |
|
|
156
156
|
| Shows a ⋮ over the count while pointed at, focused or open, and keeps the row's hover look under it | a positioned `IconButton` + `Menu` over the row, `group-hover` reveals | |
|
|
157
157
|
| Turns its icon into the arrow that folds `children` while pointed at or focused, and slides them | a positioned `IconButton` over the icon, open state, `group-hover` reveals, an indented box | |
|
|
158
158
|
| Tells assistive technology whether its rows are open | `aria-expanded`, `aria-controls` | |
|
package/src/NavItem.test.tsx
CHANGED
|
@@ -85,6 +85,14 @@ describe('NavItem with rows under it', () => {
|
|
|
85
85
|
</NavItem>
|
|
86
86
|
)
|
|
87
87
|
|
|
88
|
+
// "Show some vertical line for the tree", "a little stronger just a bit"; the indent kept (Katerina, 17 November).
|
|
89
|
+
it('draws the tree’s line beside its rows: 1px, a step above the quietest border, under the middle of its icon, the rows 24px in', () => {
|
|
90
|
+
render(tree())
|
|
91
|
+
const rows = screen.getByText('Item two').closest('a')!.parentElement!.closest('div[class*="border-l"]')!
|
|
92
|
+
const classes = rows.className.split(' ')
|
|
93
|
+
expect(classes).toEqual(expect.arrayContaining(['border-l', 'border-border-default', 'ml-[15px]', 'pl-2']))
|
|
94
|
+
})
|
|
95
|
+
|
|
88
96
|
it('starts open: the arrow says so and names what it folds, and the rows are there', () => {
|
|
89
97
|
render(tree())
|
|
90
98
|
const button = arrow(/Hide what is under Item one/)
|
|
@@ -288,7 +296,8 @@ describe('NavItem with a tooltip', () => {
|
|
|
288
296
|
render(<NavItem href="#" label="Item one" tooltip="A sentence about item one." />)
|
|
289
297
|
const link = screen.getByRole('link', { name: 'Item one' })
|
|
290
298
|
expect(link.contains(screen.getByText('Item one'))).toBe(true)
|
|
291
|
-
|
|
299
|
+
// 28px (Katerina, 17 November); 32px until then.
|
|
300
|
+
expect(link.className.split(' ')).toContain('h-7')
|
|
292
301
|
expect(screen.getByText('Item one').className.split(' ')).toContain('truncate')
|
|
293
302
|
})
|
|
294
303
|
|
package/src/NavItem.tsx
CHANGED
|
@@ -177,10 +177,11 @@ export function NavItem({
|
|
|
177
177
|
href={href}
|
|
178
178
|
aria-current={active ? 'page' : undefined}
|
|
179
179
|
className={cn(
|
|
180
|
-
// shrink-0: the row keeps its
|
|
180
|
+
// shrink-0: the row keeps its 28px inside an overflowing flex column
|
|
181
181
|
// — without it the list compresses instead of scrolling (the missing-
|
|
182
182
|
// shrink-0 family; Katerina, 2026-09-02).
|
|
183
|
-
|
|
183
|
+
// 28px (Katerina, 17 November: "what if we make the height of the items 28px"); 32px until then.
|
|
184
|
+
'flex h-7 min-w-0 shrink-0 items-center gap-2 px-2 text-body-2',
|
|
184
185
|
SIDEBAR_ROW_CLASSES,
|
|
185
186
|
active ? 'bg-bg-nav-active text-text-primary' : cn(unread ? 'text-text-primary' : SIDEBAR_ROW_TEXT_CLASSES, 'hover:bg-bg-hover'),
|
|
186
187
|
// With a menu the ⋮ sits beside the link, so the row keeps its hover
|
|
@@ -330,8 +331,12 @@ export function NavItem({
|
|
|
330
331
|
hiddenUntilFound
|
|
331
332
|
className={COLLAPSIBLE_PANEL_CLASSES}
|
|
332
333
|
>
|
|
333
|
-
{/*
|
|
334
|
-
|
|
334
|
+
{/*
|
|
335
|
+
The tree's line (Katerina, 17 November: "show some vertical line for the tree", "a little stronger just a
|
|
336
|
+
bit"): 1px down from the middle of this row's icon (8px in, 16px wide), and the rows past it 24px in, as
|
|
337
|
+
before, their icons under this row's label (the indent she kept: "i dont like the indentation change").
|
|
338
|
+
*/}
|
|
339
|
+
<div className="ml-[15px] mt-0.5 flex flex-col gap-0.5 border-l border-border-default pl-2">{children}</div>
|
|
335
340
|
</Collapsible.Panel>
|
|
336
341
|
</Collapsible.Root>
|
|
337
342
|
)
|
package/src/NavTree.mdx
CHANGED
|
@@ -81,6 +81,16 @@ rows to any depth.
|
|
|
81
81
|
- A group folds with a row's arrow, 16px — every folding heading does — so a
|
|
82
82
|
group and the rows under it fold with the same arrow; its title starts 8px
|
|
83
83
|
after it, as a row's label.
|
|
84
|
+
- Rows under a row, or under a group, have the tree's line beside them: 1px,
|
|
85
|
+
a step above the quietest border, down from the middle of the icon or the
|
|
86
|
+
arrow above them; the rows stay 24px in (Katerina, 17 November).
|
|
87
|
+
- `spaced` puts 8px between the items the app draws as `children`, none
|
|
88
|
+
above the first: a tree whose items are each a place with rows under it,
|
|
89
|
+
as Peek's teams are ("a bit more spacing between the parent expandable
|
|
90
|
+
items", Katerina, 17 November). Groups from `groups` keep their 4px.
|
|
91
|
+
|
|
92
|
+
<Canvas of={NavTreeStories.Spaced} />
|
|
93
|
+
|
|
84
94
|
- A group's `icon` sits before its title — a folder's — and the arrow takes
|
|
85
95
|
its place under the pointer, as a row's icon turns into its arrow. Its rows
|
|
86
96
|
then start under the title, past the icon.
|
package/src/NavTree.stories.tsx
CHANGED
|
@@ -4,6 +4,7 @@ import { useEffect, useState, type ReactNode } from 'react'
|
|
|
4
4
|
import { IconArrowUpRight, IconFolder, IconPlus } from '@tabler/icons-react'
|
|
5
5
|
import { Button } from './Button'
|
|
6
6
|
import { Chip } from './Chip'
|
|
7
|
+
import { CollapsibleSection } from './CollapsibleSection'
|
|
7
8
|
import { UnreadDot } from './UnreadDot'
|
|
8
9
|
import { MenuItem, MenuSeparator } from './Menu'
|
|
9
10
|
import { NavItem } from './NavItem'
|
|
@@ -201,6 +202,38 @@ export const AppDrawnGroups: Story = {
|
|
|
201
202
|
},
|
|
202
203
|
}
|
|
203
204
|
|
|
205
|
+
/**
|
|
206
|
+
* `spaced`: 8px between the items the app draws, none above the first — a tree whose items are each a place with rows
|
|
207
|
+
* under it, as Peek's teams are (Katerina, 17 November). The tree's line runs beside each one's rows.
|
|
208
|
+
*/
|
|
209
|
+
export const Spaced: Story = {
|
|
210
|
+
args: { groups: undefined },
|
|
211
|
+
render: function Render() {
|
|
212
|
+
return (
|
|
213
|
+
<div className="flex h-screen bg-bg-base">
|
|
214
|
+
<Sidebar>
|
|
215
|
+
<NavTree spaced>
|
|
216
|
+
<NavItem href="#" label="Team one" icon={placeholder}>
|
|
217
|
+
<NavItem href="#" label="Item one" icon={placeholder} />
|
|
218
|
+
<NavItem href="#" label="Item two" icon={placeholder} active />
|
|
219
|
+
<CollapsibleSection look="row" title="A fold" icon={placeholder} defaultOpen>
|
|
220
|
+
<NavItem href="#" label="Item three" icon={placeholder} />
|
|
221
|
+
</CollapsibleSection>
|
|
222
|
+
</NavItem>
|
|
223
|
+
<NavItem href="#" label="Team two" icon={placeholder}>
|
|
224
|
+
<NavItem href="#" label="Item four" icon={placeholder} />
|
|
225
|
+
</NavItem>
|
|
226
|
+
<CollapsibleSection look="row" title="The rest" count={2} defaultOpen={false}>
|
|
227
|
+
<NavItem href="#" label="Team three" icon={placeholder} />
|
|
228
|
+
<NavItem href="#" label="Team four" icon={placeholder} />
|
|
229
|
+
</CollapsibleSection>
|
|
230
|
+
</NavTree>
|
|
231
|
+
</Sidebar>
|
|
232
|
+
</div>
|
|
233
|
+
)
|
|
234
|
+
},
|
|
235
|
+
}
|
|
236
|
+
|
|
204
237
|
/** A group the app draws, its rows read when it opens: pending while the read is out, and once it has taken `NAV_TREE_PENDING_MS` the skeleton. */
|
|
205
238
|
function ReadOnOpen({ title, ms }: { title: string; ms: number }) {
|
|
206
239
|
const [open, setOpen] = useState(false)
|
package/src/NavTree.test.tsx
CHANGED
|
@@ -9,6 +9,7 @@ import { act, cleanup, render, screen } from '@testing-library/react'
|
|
|
9
9
|
import userEvent from '@testing-library/user-event'
|
|
10
10
|
import { MenuItem } from './Menu'
|
|
11
11
|
import { NAV_TREE_PENDING_MS, NavTree, NavTreeSection, type NavTreeGroup } from './NavTree'
|
|
12
|
+
import { NavItem } from './NavItem'
|
|
12
13
|
|
|
13
14
|
afterEach(cleanup)
|
|
14
15
|
|
|
@@ -179,6 +180,31 @@ describe('NavTree spaces its groups', () => {
|
|
|
179
180
|
})
|
|
180
181
|
})
|
|
181
182
|
|
|
183
|
+
// "A bit more spacing between the parent expandable items" (Katerina, 17 November): Peek's teams.
|
|
184
|
+
describe('NavTree spaced', () => {
|
|
185
|
+
it('puts 8px above each item the app draws but the first', () => {
|
|
186
|
+
const { container } = render(
|
|
187
|
+
<NavTree spaced>
|
|
188
|
+
<NavItem href="#one" label="One" />
|
|
189
|
+
<NavItem href="#two" label="Two" />
|
|
190
|
+
</NavTree>,
|
|
191
|
+
)
|
|
192
|
+
const box = screen.getByRole('link', { name: 'One' }).closest('div[class*="mt-2"]')
|
|
193
|
+
expect(box?.className.split(' ')).toEqual(expect.arrayContaining(['contents', '[&>*+*]:mt-2']))
|
|
194
|
+
expect(container.querySelectorAll('[class*="[&>*+*]:mt-2"]')).toHaveLength(1)
|
|
195
|
+
})
|
|
196
|
+
|
|
197
|
+
it('without it, nothing is put between them, as before', () => {
|
|
198
|
+
const { container } = render(
|
|
199
|
+
<NavTree>
|
|
200
|
+
<NavItem href="#one" label="One" />
|
|
201
|
+
<NavItem href="#two" label="Two" />
|
|
202
|
+
</NavTree>,
|
|
203
|
+
)
|
|
204
|
+
expect(container.querySelector('[class*="[&>*+*]:mt-2"]')).toBeNull()
|
|
205
|
+
})
|
|
206
|
+
})
|
|
207
|
+
|
|
182
208
|
describe('NavTree with no groups and no words', () => {
|
|
183
209
|
it('draws no line at all', () => {
|
|
184
210
|
const { container } = render(<NavTree groups={[]} />)
|
package/src/NavTree.tsx
CHANGED
|
@@ -118,6 +118,12 @@ export interface NavTreeProps {
|
|
|
118
118
|
emptyMessage?: string
|
|
119
119
|
/** Remember each group open or closed in this browser, under this key and the group's id. The app prefixes it. */
|
|
120
120
|
storageKey?: string
|
|
121
|
+
/**
|
|
122
|
+
* 8px between the items an app draws as `children`, none above the first: a tree whose items are each a place with
|
|
123
|
+
* rows under it — Peek's teams (Katerina, 17 November: "a bit more spacing between the parent expandable items").
|
|
124
|
+
* Groups drawn from `groups` keep their own 4px.
|
|
125
|
+
*/
|
|
126
|
+
spaced?: boolean
|
|
121
127
|
}
|
|
122
128
|
|
|
123
129
|
/** How long the pointer rests on a group before `onIntent` (Peek's FolderTree, 150ms). */
|
|
@@ -364,7 +370,7 @@ export function NavTreeSection({ id, title, message, loading = false, pending =
|
|
|
364
370
|
* and the column scrolls to it. Groups the app draws itself take `openFor`
|
|
365
371
|
* for that; the scroll is the tree's either way.
|
|
366
372
|
*/
|
|
367
|
-
export function NavTree({ title, titleActions, groups, children, selected, selectedParent, selectedGroup, onSelect, emptyMessage = '', storageKey }: NavTreeProps) {
|
|
373
|
+
export function NavTree({ title, titleActions, groups, children, selected, selectedParent, selectedGroup, onSelect, emptyMessage = '', storageKey, spaced = false }: NavTreeProps) {
|
|
368
374
|
const opening = groups ? openingFor(groups, selected, selectedParent) : null
|
|
369
375
|
/*
|
|
370
376
|
Once per current row, when it is drawn and shown, however late: a row a part inside the tree draws itself (a fold
|
|
@@ -391,7 +397,8 @@ export function NavTree({ title, titleActions, groups, children, selected, selec
|
|
|
391
397
|
<groupLinked.Provider value={selectedGroup}>
|
|
392
398
|
{title && <SectionHeader title={title} look="quiet" showActions="always" actions={titleActions} className="mt-4 shrink-0" />}
|
|
393
399
|
{groups === undefined ? (
|
|
394
|
-
|
|
400
|
+
// `contents` again: the items stay the column's own; the margin is on each one that follows another.
|
|
401
|
+
spaced ? <div className="contents [&>*+*]:mt-2">{children}</div> : children
|
|
395
402
|
) : groups === null ? (
|
|
396
403
|
<SkeletonList rows={5} />
|
|
397
404
|
) : groups.length === 0 ? (
|
package/src/SectionHeader.mdx
CHANGED
|
@@ -5,7 +5,7 @@ import * as SectionHeaderStories from './SectionHeader.stories'
|
|
|
5
5
|
|
|
6
6
|
# SectionHeader
|
|
7
7
|
|
|
8
|
-
The
|
|
8
|
+
The 28px row a section starts with, a list row's height: a SectionLabel, and actions that
|
|
9
9
|
appear while the row is hovered or keyboard-focused, as IconButtons with
|
|
10
10
|
tooltips — always, on a screen with no hover. It is also the
|
|
11
11
|
header of a **CollapsibleSection**, which draws the chevron and makes the
|
|
@@ -83,7 +83,7 @@ import { IconPlus } from '@tabler/icons-react'
|
|
|
83
83
|
actions are always shown (`showActions="always"`), where the buttons light up
|
|
84
84
|
on their own. The default, `fill`, lights a row that toggles or has actions.
|
|
85
85
|
|
|
86
|
-
- The row is 32px
|
|
86
|
+
- The row is 28px tall (32px until 17 November), 8px in on each side, 4px between the title and the
|
|
87
87
|
actions, with 8px corners.
|
|
88
88
|
|
|
89
89
|
## What it owns
|
|
@@ -94,7 +94,7 @@ It does these by itself. Write none of them around it.
|
|
|
94
94
|
|---|---|---|
|
|
95
95
|
| With `chevron`, its title is a button that calls `onToggle` on a click, Enter or Space, and says whether it is open | a button of your own, or `aria-expanded` | |
|
|
96
96
|
| Shows its actions while the keyboard is in the row — on the title or on one of them — and always on a screen with no hover | a focus style of your own | |
|
|
97
|
-
| Keeps its
|
|
97
|
+
| Keeps its 28px in a scrolling column | `shrink-0` | |
|
|
98
98
|
| Keeps a long title on one line, cut short with "…", in every look | `truncate` around the title | |
|
|
99
99
|
|
|
100
100
|
## Keys
|
package/src/SectionHeader.tsx
CHANGED
|
@@ -205,7 +205,8 @@ export function SectionHeader({ title, chevron = false, icon, isExpanded = true,
|
|
|
205
205
|
<div
|
|
206
206
|
className={cn(
|
|
207
207
|
// `relative`: a dot in the last button's place is placed against the row.
|
|
208
|
-
'
|
|
208
|
+
// 28px, a row's height (Katerina, 17 November); 32px until then.
|
|
209
|
+
'group relative flex h-[28px] shrink-0 items-center gap-1 px-2',
|
|
209
210
|
!row && 'transition-colors',
|
|
210
211
|
// A row is NavItem's shape and colour: 6px corners, secondary words that brighten on hover.
|
|
211
212
|
row ? cn(SIDEBAR_ROW_CLASSES, SIDEBAR_ROW_TEXT_CLASSES) : 'rounded-lg',
|
package/src/Skeleton.mdx
CHANGED
|
@@ -6,7 +6,7 @@ import * as SkeletonStories from './Skeleton.stories'
|
|
|
6
6
|
# Skeleton
|
|
7
7
|
|
|
8
8
|
The loading placeholder, in generic parts: **SkeletonBar** (the pulsing
|
|
9
|
-
block), **SkeletonRow** (a
|
|
9
|
+
block), **SkeletonRow** (a 28px row, a list row's height — a 16px square and a bar, like a row
|
|
10
10
|
with a face and a name), and **SkeletonList** (rows of varied widths, so
|
|
11
11
|
the placeholder does not read as a pattern).
|
|
12
12
|
|
|
@@ -44,4 +44,4 @@ It does these by itself. Write none of them around it.
|
|
|
44
44
|
|
|
45
45
|
| It does | So you never write | Refused when written by hand |
|
|
46
46
|
|---|---|---|
|
|
47
|
-
| Keeps each row's
|
|
47
|
+
| Keeps each row's 28px in a scrolling column | `shrink-0` | |
|
package/src/Skeleton.tsx
CHANGED
|
@@ -22,10 +22,10 @@ export function SkeletonBar({ className, style, on = 'surface', shape = 'bar' }:
|
|
|
22
22
|
|
|
23
23
|
const ROW_BAR_WIDTHS = [150, 100, 170, 120, 90, 140, 110, 160]
|
|
24
24
|
|
|
25
|
-
/** A
|
|
25
|
+
/** A 28px row, a list row's height: a 16px square and a bar, like a row with a face and a name. */
|
|
26
26
|
export function SkeletonRow({ barWidth = 130 }: { barWidth?: number }) {
|
|
27
27
|
return (
|
|
28
|
-
<div className="flex shrink-0 items-center gap-2 px-2 h-[
|
|
28
|
+
<div className="flex shrink-0 items-center gap-2 px-2 h-[28px] rounded-lg">
|
|
29
29
|
<SkeletonBar className="w-4 h-4 shrink-0" />
|
|
30
30
|
<SkeletonBar className="h-3.5" style={{ width: barWidth }} />
|
|
31
31
|
</div>
|
package/src/heights.test.tsx
CHANGED
|
@@ -28,7 +28,7 @@ const classes = (el: Element | null) => (el?.getAttribute('class') ?? '').split(
|
|
|
28
28
|
describe('a part with a set height keeps it in a scrolling column', () => {
|
|
29
29
|
it('SectionHeader: shrink-0', () => {
|
|
30
30
|
const { container } = render(<SectionHeader title="Group" />)
|
|
31
|
-
expect(classes(container.querySelector('[class*="h-[
|
|
31
|
+
expect(classes(container.querySelector('[class*="h-[28px]"]'))).toContain('shrink-0')
|
|
32
32
|
})
|
|
33
33
|
|
|
34
34
|
it('SkeletonRow: shrink-0', () => {
|
|
@@ -36,6 +36,13 @@ describe('a part with a set height keeps it in a scrolling column', () => {
|
|
|
36
36
|
expect(classes(container.firstElementChild)).toContain('shrink-0')
|
|
37
37
|
})
|
|
38
38
|
|
|
39
|
+
// 28px, a list row's height, for the three that stand in one list (Katerina, 17 November): 32px until then.
|
|
40
|
+
it('a row, a heading and a loading row are each 28px', () => {
|
|
41
|
+
const row = render(<SectionHeader title="Group" />).container
|
|
42
|
+
expect(classes(row.firstElementChild)).toContain('h-[28px]')
|
|
43
|
+
expect(classes(render(<SkeletonRow />).container.firstElementChild)).toContain('h-[28px]')
|
|
44
|
+
})
|
|
45
|
+
|
|
39
46
|
it('RailItem: a set 48px, and shrink-0', () => {
|
|
40
47
|
render(<RailItem href="#" label="Item" icon={<span />} />)
|
|
41
48
|
const tile = classes(screen.getByRole('link'))
|