Skip to content

minor: fix label and title on docs popover button #2804

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
david-crespo merged 2 commits into from
Apr 15, 2025
Merged

minor: fix label and title on docs popover button #2804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0863143
minor: fix label and title on docs popover button
david-crespo Apr 14, 2025
e65fcd3
fix e2e test
david-crespo Apr 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions app/components/DocsPopover.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,21 @@ export const DocsPopoverLink = ({ href, linkText }: DocsPopoverLinkProps) => (
)

type DocsPopoverProps = {
heading: React.ReactNode
heading: string
icon: JSX.Element
links: Array<DocsPopoverLinkProps>
summary: string
}

export const DocsPopover = ({ heading, icon, summary, links }: DocsPopoverProps) => {
const title = `Learn about ${heading}`
return (
<Popover>
<PopoverButton className={cn(buttonStyle({ size: 'sm', variant: 'ghost' }), 'w-8')}>
<Info16Icon aria-label="Links to docs" className="shrink-0" />
<PopoverButton
className={cn(buttonStyle({ size: 'sm', variant: 'ghost' }), 'w-8')}
title={title}
>
<Info16Icon aria-hidden className="shrink-0" />
Copy link
Collaborator Author

@david-crespo david-crespo Apr 14, 2025

Choose a reason for hiding this comment

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

Confirmed this is sufficient for a11y and, indeed, likely preferable. There's no need to have the label on the icon.

image

</PopoverButton>
<PopoverPanel
// popover-panel needed for enter animation
Expand All @@ -56,7 +60,7 @@ export const DocsPopover = ({ heading, icon, summary, links }: DocsPopoverProps)
<div className="px-4">
<h2 className="mt-4 flex items-center gap-1 text-sans-md">
<div className="mr-1 flex items-center text-accent-secondary">{icon}</div>
Learn about {heading}
{title}
</h2>
<p className="mb-3 mt-2 text-sans-md text-default">{summary}</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions test/e2e/docs-popover.e2e.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import { expect, test } from './utils'

test('Show / hide contextual help docs links', async ({ page }) => {
const learnAbout = page.getByText('Learn about disks')
const learnAbout = page.getByRole('heading', { name: 'Learn about disks' })
const managingDisksLink = page.getByRole('link', { name: 'Disks and Snapshots' })

await page.goto('/projects/mock-project/disks')
Expand All @@ -17,7 +17,7 @@ test('Show / hide contextual help docs links', async ({ page }) => {
await expect(managingDisksLink).toBeHidden()

// open the contextual help docs links
await page.getByLabel('Links to docs').click()
await page.getByRole('button', { name: 'Learn about disks' }).click()
await expect(learnAbout).toBeVisible()
await expect(managingDisksLink).toBeVisible()

Expand Down
2 changes: 1 addition & 1 deletion test/e2e/images.e2e.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ test('can promote an image from silo', async ({ page }) => {
await page.getByRole('option', { name: 'mock-project' }).click()

// Select an image in that project
const imageListbox = page.locator('role=button[name*="Image"]')
const imageListbox = page.getByRole('button', { name: 'Image', exact: true })
await expect(imageListbox).toBeEnabled()
await imageListbox.click()
await page.locator('role=option >> text="image-1"').click()
Expand Down
Loading