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.

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

Jump to bottom

chore(tooltip): extend tooltip self-managed documentation #3815

Merged
merged 1 commit into from
Nov 30, 2023
Merged

chore(tooltip): extend tooltip self-managed documentation #3815

merged 1 commit into from
Nov 30, 2023

Conversation

TarunAdobe
Copy link
Contributor

Expand https://opensource.adobe.com/spectrum-web-components/components/tooltip/#self-managed-overlays to include information about a focusable element, as per the Dev Mode warning and the discussion in #3781 (reply in thread)

Description

Extended self-managed tooltip documentation to include an example of how to use tooltip for non-interactive elements by wrapping them with an interactive element and added notes about why the current pattern is supported the way it is.

Related issue(s)

Motivation and context

How has this been tested?

  • Test case 1
    1. Go here
    2. Do this
  • Test case 2
    1. Go here
    2. Do this

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

Checklist

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • If my change required a change to the documentation, I have updated the documentation in this pull request.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices

Best practices

This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against main.

@TarunAdobe TarunAdobe self-assigned this Nov 20, 2023
@TarunAdobe TarunAdobe linked an issue Nov 20, 2023 that may be closed by this pull request
[Tooltip] Expand self-managed documentation #3787
Closed
1 task
@github-actions GitHub Actions
Copy link

Branch Preview

Visual regression test results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Westbrook
Westbrook reviewed Nov 20, 2023
View reviewed changes
Copy link
Contributor

@Westbrook Westbrook left a comment

Choose a reason for hiding this comment

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

We should probably define “interactive element” inline with what the code is looking for here, there’s a long CSS selector to base this off of for consumers.

packages/tooltip/README.md Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 28, 2023 •
edited
Loading

Tachometer results

Chrome

action-menu permalink

Version Bytes Avg Time vs remote vs branch
npm latest 640 kB 182.14ms - 185.38ms - unsure 🔍
-1% - +1%
-2.56ms - +2.41ms
branch 621 kB 181.95ms - 185.72ms unsure 🔍
-1% - +1%
-2.41ms - +2.56ms		 -

menu permalink

Version Bytes Avg Time vs remote vs branch
npm latest 462 kB 242.03ms - 245.20ms - unsure 🔍
-2% - +0%
-4.28ms - +1.21ms
branch 449 kB 242.90ms - 247.39ms unsure 🔍
-0% - +2%
-1.21ms - +4.28ms		 -

picker permalink

Version Bytes Avg Time vs remote vs branch
npm latest 506 kB 638.19ms - 651.15ms - unsure 🔍
-1% - +2%
-5.24ms - +12.90ms
branch 491 kB 634.50ms - 647.19ms unsure 🔍
-2% - +1%
-12.90ms - +5.24ms		 -

sidenav permalink

Version Bytes Avg Time vs remote vs branch
npm latest 428 kB 333.05ms - 338.76ms - unsure 🔍
-1% - +1%
-2.98ms - +4.16ms
branch 416 kB 333.17ms - 337.46ms unsure 🔍
-1% - +1%
-4.16ms - +2.98ms		 -

split-button permalink

Version Bytes Avg Time vs remote vs branch
npm latest 712 kB 1852.56ms - 1855.60ms - unsure 🔍
-0% - +0%
-1.56ms - +2.68ms
branch 696 kB 1852.04ms - 1855.00ms unsure 🔍
-0% - +0%
-2.68ms - +1.56ms		 -

switch permalink

Version Bytes Avg Time vs remote vs branch
npm latest 401 kB 27.13ms - 27.31ms - unsure 🔍
-1% - +1%
-0.29ms - +0.27ms
branch 386 kB 26.96ms - 27.49ms unsure 🔍
-1% - +1%
-0.27ms - +0.29ms		 -

tooltip permalink

Version Bytes Avg Time vs remote vs branch
npm latest 552 kB 51.52ms - 52.36ms - unsure 🔍
-1% - +1%
-0.55ms - +0.53ms
branch 536 kB 51.60ms - 52.29ms unsure 🔍
-1% - +1%
-0.53ms - +0.55ms		 -
Firefox

action-menu permalink

Version Bytes Avg Time vs remote vs branch
npm latest 640 kB 332.00ms - 341.48ms - unsure 🔍
-2% - +2%
-5.54ms - +7.34ms
branch 621 kB 331.48ms - 340.20ms unsure 🔍
-2% - +2%
-7.34ms - +5.54ms		 -

menu permalink

Version Bytes Avg Time vs remote vs branch
npm latest 462 kB 428.63ms - 436.21ms - unsure 🔍
-2% - +2%
-8.62ms - +7.02ms
branch 449 kB 426.38ms - 440.06ms unsure 🔍
-2% - +2%
-7.02ms - +8.62ms		 -

picker permalink

Version Bytes Avg Time vs remote vs branch
npm latest 506 kB 974.62ms - 1004.86ms - unsure 🔍
-1% - +2%
-10.20ms - +20.72ms
branch 491 kB 981.29ms - 987.67ms unsure 🔍
-2% - +1%
-20.72ms - +10.20ms		 -

sidenav permalink

Version Bytes Avg Time vs remote vs branch
npm latest 428 kB 540.01ms - 554.99ms - unsure 🔍
-2% - +1%
-8.75ms - +7.91ms
branch 416 kB 544.27ms - 551.57ms unsure 🔍
-1% - +2%
-7.91ms - +8.75ms		 -

split-button permalink

Version Bytes Avg Time vs remote vs branch
npm latest 712 kB 1569.01ms - 1573.83ms - unsure 🔍
-0% - +0%
-4.44ms - +1.76ms
branch 696 kB 1570.82ms - 1574.70ms unsure 🔍
-0% - +0%
-1.76ms - +4.44ms		 -

switch permalink

Version Bytes Avg Time vs remote vs branch
npm latest 401 kB 64.48ms - 68.92ms - unsure 🔍
-3% - +6%
-2.18ms - +3.78ms
branch 386 kB 63.91ms - 67.89ms unsure 🔍
-6% - +3%
-3.78ms - +2.18ms		 -

tooltip permalink

Version Bytes Avg Time vs remote vs branch
npm latest 645 kB 104.00ms - 106.84ms - unsure 🔍
-1% - +2%
-0.56ms - +2.48ms
branch 628 kB 103.94ms - 104.98ms unsure 🔍
-2% - +1%
-2.48ms - +0.56ms		 -

@TarunAdobe
chore(tooltip): extend tooltip self-managed documentation
51e91b3 
chore(tooltip): updated tooltip documentation

chore(tooltip): updated documentation for self-managed tooltip

chore(tooltip): extended self-managed doc
Westbrook
Westbrook approved these changes Nov 30, 2023
View reviewed changes
Copy link
Contributor

@Westbrook Westbrook left a comment

Choose a reason for hiding this comment

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

Super useful addition. Thanks for editing through this! :shipit:

@Westbrook Westbrook merged commit 5be8198 into main Nov 30, 2023
47 checks passed
@Westbrook Westbrook deleted the 3787/expand-tooltip-doc branch November 30, 2023 14:00
mirekszot pushed a commit that referenced this pull request Dec 6, 2023
@TarunAdobe
docs(tooltip): extend tooltip self-managed documentation (#3815)
1671e87 
chore(tooltip): updated tooltip documentation

chore(tooltip): updated documentation for self-managed tooltip

chore(tooltip): extended self-managed doc
mirekszot pushed a commit that referenced this pull request Dec 6, 2023
@TarunAdobe
docs(tooltip): extend tooltip self-managed documentation (#3815)
d8c1c15 
chore(tooltip): updated tooltip documentation

chore(tooltip): updated documentation for self-managed tooltip

chore(tooltip): extended self-managed doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Westbrook Westbrook Westbrook approved these changes

@Rajdeepc Rajdeepc Awaiting requested review from Rajdeepc

@blunteshwar blunteshwar Awaiting requested review from blunteshwar

@najikahalsema najikahalsema Awaiting requested review from najikahalsema

Assignees

@TarunAdobe TarunAdobe

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Tooltip] Expand self-managed documentation
2 participants
@TarunAdobe @Westbrook