Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SelectPanel: Update SelectPanel to use modern ActionList #4794

Merged
merged 68 commits into from
Sep 10, 2024
Merged
Changes from 6 commits
Commits
Show all changes
68 commits
Select commit Hold shift + click to select a range
9cee0a4
super wip
broccolinisoup Jul 30, 2024
c7aa5de
just use the actionlist component and revert the type updates
broccolinisoup Jul 30, 2024
40a0c45
Update packages/react/src/FilteredActionList/FilteredActionList.tsx
broccolinisoup Jul 30, 2024
344f6ce
Some more progress
broccolinisoup Jul 31, 2024
fa5f5a6
revert the type changes and cast it :/
broccolinisoup Jul 31, 2024
3cd9ecc
clean
broccolinisoup Jul 31, 2024
0003e59
wip
broccolinisoup Aug 2, 2024
713b5ad
wip wip
broccolinisoup Aug 5, 2024
6fc7f2b
add stories
broccolinisoup Aug 8, 2024
a246981
fix linting
broccolinisoup Aug 8, 2024
e209f47
add tests for groups
broccolinisoup Aug 8, 2024
26cddc1
Merge branch 'main' into select-panel-action-list
broccolinisoup Aug 8, 2024
b1199fb
Merge branch 'select-panel-story-and-tests' into select-panel-action-…
broccolinisoup Aug 8, 2024
b669cff
Map groups
broccolinisoup Aug 8, 2024
1012662
Merge branch 'main' into select-panel-story-and-tests
broccolinisoup Aug 12, 2024
67dc5c9
Update story names for e2e tests
broccolinisoup Aug 12, 2024
c66feb5
oops remove unintended file
broccolinisoup Aug 12, 2024
4fbb3c5
update story name
broccolinisoup Aug 12, 2024
2d5e2b2
same - update story name
broccolinisoup Aug 12, 2024
cee7737
disable animations
broccolinisoup Aug 12, 2024
9c972c3
test(vrt): update snapshots
broccolinisoup Aug 12, 2024
17e4ca8
Merge branch 'select-panel-story-and-tests' into select-panel-action-…
broccolinisoup Aug 12, 2024
26b6fe6
Update tests since new action list has different semantics for group …
broccolinisoup Aug 12, 2024
42c50c0
Merge branch 'main' into select-panel-action-list
broccolinisoup Aug 13, 2024
0d0004f
logging
broccolinisoup Aug 14, 2024
3ba9bc7
pass the rest
broccolinisoup Aug 14, 2024
92ab9c2
extract children and use before text
broccolinisoup Aug 14, 2024
7b3d5e6
remove logging
broccolinisoup Aug 14, 2024
1cf1e09
Merge branch 'main' into select-panel-action-list
siddharthkp Aug 20, 2024
92303d0
test(vrt): update snapshots
siddharthkp Aug 20, 2024
4dc3b41
add active styles to ActionList
siddharthkp Aug 21, 2024
f673034
rename component name to be clearer
siddharthkp Aug 21, 2024
3a7d490
remove variant full from examples
siddharthkp Aug 21, 2024
ab3ea9c
tiny clean up
siddharthkp Aug 21, 2024
44ff862
fix showItemDividers
siddharthkp Aug 21, 2024
46c94e6
another tiny cleanup
siddharthkp Aug 21, 2024
ff8379b
pull MappedActionListItem to make it stable
siddharthkp Aug 22, 2024
9353d71
Merge branch 'main' into select-panel-action-list
siddharthkp Aug 22, 2024
0a126ad
test(vrt): update snapshots
siddharthkp Aug 22, 2024
91cd5a3
show active styles only when used with keyboard
siddharthkp Aug 22, 2024
40322c5
backward compat: expose id as data-id
siddharthkp Aug 22, 2024
f0150e4
Merge branch 'select-panel-action-list' of github.com:primer/react in…
siddharthkp Aug 22, 2024
f72b9d4
update snapshots
siddharthkp Aug 22, 2024
85d0237
add story for long strings
siddharthkp Aug 26, 2024
2eca9fa
fishing for errors
siddharthkp Aug 26, 2024
c875223
backward compatibility for renderItem
siddharthkp Aug 26, 2024
02a6dc9
remove todo now
siddharthkp Aug 26, 2024
25c574a
add a feature flag
siddharthkp Aug 26, 2024
5dc6adb
clean up dual filter list setup
siddharthkp Aug 27, 2024
85e0bb4
run jests test with both states of feature flags
siddharthkp Aug 27, 2024
0ee74e1
refactor snapshot tests with scenarios
siddharthkp Aug 27, 2024
798008e
remove feature flag for main
siddharthkp Aug 27, 2024
beca8db
Merge branch 'main' into select-panel-action-list
siddharthkp Aug 27, 2024
14fd206
Merge branch 'selectpanel-prepare-scenarios' into select-panel-action…
siddharthkp Aug 27, 2024
185eb17
test(vrt): update snapshots
siddharthkp Aug 28, 2024
318aa99
add feature flag to e2e matrix
siddharthkp Aug 28, 2024
e9c523c
test(vrt): update snapshots
siddharthkp Aug 28, 2024
efd1216
backward compat: allow groupMetadata to be empty array
siddharthkp Aug 28, 2024
cd9a931
Merge branch 'select-panel-action-list' of github.com:primer/react in…
siddharthkp Aug 28, 2024
619ff96
Merge branch 'main' into select-panel-action-list
siddharthkp Aug 29, 2024
e3fe7b8
sigh newline
siddharthkp Aug 29, 2024
ebac341
Create sour-cooks-dress.md
siddharthkp Aug 30, 2024
0513474
Merge branch 'main' into select-panel-action-list
siddharthkp Aug 30, 2024
2afa236
copy SelectPanel snapshots from main
siddharthkp Sep 2, 2024
0f38bf4
remove unrelated changes in this PR
siddharthkp Sep 3, 2024
f72aa55
test(vrt): update snapshots
siddharthkp Sep 3, 2024
6e9d706
set active styles for both active-descendant types
siddharthkp Sep 5, 2024
0b57206
test(vrt): update snapshots
siddharthkp Sep 5, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 65 additions & 4 deletions packages/react/src/FilteredActionList/FilteredActionList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import Spinner from '../Spinner'
import type {TextInputProps} from '../TextInput'
import TextInput from '../TextInput'
import {get} from '../constants'
import {ActionList} from '../deprecated/ActionList'
import type {GroupedListProps, ListPropsBase} from '../deprecated/ActionList/List'
import {ActionList} from '../ActionList'
import type {GroupedListProps, ListPropsBase, ItemInput} from '../deprecated/ActionList/List'
import {useFocusZone} from '../hooks/useFocusZone'
import {useId} from '../hooks/useId'
import {useProvidedRefOrCreate} from '../hooks/useProvidedRefOrCreate'
Expand All @@ -18,6 +18,8 @@ import useScrollFlash from '../hooks/useScrollFlash'
import {VisuallyHidden} from '../internal/components/VisuallyHidden'
import type {SxProp} from '../sx'

import {isValidElementType} from 'react-is'

const menuScrollMargins: ScrollIntoViewOptions = {startMargin: 0, endMargin: 8}

export interface FilteredActionListProps
Expand Down Expand Up @@ -59,7 +61,7 @@ export function FilteredActionList({
)

const scrollContainerRef = useRef<HTMLDivElement>(null)
const listContainerRef = useRef<HTMLDivElement>(null)
const listContainerRef = useRef<HTMLUListElement>(null)
const inputRef = useProvidedRefOrCreate<HTMLInputElement>(providedInputRef)
const activeDescendantRef = useRef<HTMLElement>()
const listId = useId()
Expand Down Expand Up @@ -109,6 +111,61 @@ export function FilteredActionList({

useScrollFlash(scrollContainerRef)

function MappedActionList(item: ItemInput) {
camertron marked this conversation as resolved.
Show resolved Hide resolved
const {
description,
descriptionVariant,
sx,
text,
variant,
disabled,
trailingVisual: TrailingVisual,
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure if this is a common pattern, but I personally find it a bit confusing to use TitleCase for these renamed variables. Can we avoid renaming them, or name them something else, eg. originalTrailingVisual?

Copy link
Member

Choose a reason for hiding this comment

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

👋

the TitleCase is so that we can render them as a component in JSX

prop accepted as leadingVisual, rendered in the body as <LeadingVisual/>, it would have been nicer if the prop was already TitleCased to signal that it accepts a component (and not a string, for example), but probably not the correct time to change that here

leadingVisual: LeadingVisual,
trailingText,
trailingIcon: TrailingIcon,
onAction,
selected,
} = item

return (
<ActionList.Item
sx={sx}
role="option"
onSelect={(e: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>) => {
if (typeof onAction === 'function')
onAction(item, e as React.MouseEvent<HTMLDivElement> | React.KeyboardEvent<HTMLDivElement>)
}}
selected={selected}
variant={variant}
disabled={disabled}
>
{LeadingVisual ? (
<ActionList.LeadingVisual>
<LeadingVisual />
</ActionList.LeadingVisual>
) : null}
{text}
{description ? (
<ActionList.Description variant={descriptionVariant}>{description}</ActionList.Description>
) : null}
{TrailingVisual ? (
<ActionList.TrailingVisual>
{typeof TrailingVisual !== 'string' && isValidElementType(TrailingVisual) ? (
<TrailingVisual />
) : (
TrailingVisual
)}
</ActionList.TrailingVisual>
) : TrailingIcon || trailingText ? (
<ActionList.TrailingVisual>
{trailingText}
{TrailingIcon && <TrailingIcon />}
</ActionList.TrailingVisual>
) : null}
</ActionList.Item>
)
}

return (
<Box display="flex" flexDirection="column" overflow="hidden" sx={sx}>
<StyledHeader>
Expand All @@ -134,7 +191,11 @@ export function FilteredActionList({
<Spinner />
</Box>
) : (
<ActionList ref={listContainerRef} items={items} {...listProps} role="listbox" id={listId} />
<ActionList ref={listContainerRef} {...listProps} role="listbox" id={listId}>
{items.map((item, index) => {
return <MappedActionList key={index} {...item} />
})}
</ActionList>
)}
</Box>
</Box>
Expand Down
Loading