fix(top-nav): allow consumers to "ignore-url-parts" or "search" or "hash"

[Westbrook]

Description

Add ignore-url-parts attribute and ignoreURLParts property that accept a space separated list of things to remove from the URL when comparing for the "selected" item in a Top Nav. Values of hash and search are currently supported.

This makes it so that consumers can opt-in to which part of the URL they would like their "selected" Top Nav Item to be matched against.

Related issue(s)

• fixes [Bug]: <sp-top-nav-item> isn’t selected when URL parameters are present #1983

How has this been tested?

• Test case 1
  1. Go here
  2. See that the selected item in the Top Nav does not include the search params in its href.

Types of changes

• New feature (non-breaking change which adds functionality)

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.

[github-actions]

Branch Preview

• Documentation Site
• Storybook

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:

• High Contrast Mode | Medium | LTR
• Classic | Lightest | Medium | LTR
• Classic | Lightest | Medium | RTL
• Classic | Lightest | Large | LTR
• Classic | Lightest | Large | RTL
• Classic | Light | Medium | LTR
• Classic | Light | Medium | RTL
• Classic | Light | Large | LTR
• Classic | Light | Large | RTL
• Classic | Dark | Medium | LTR
• Classic | Dark | Medium | RTL
• Classic | Dark | Large | LTR
• Classic | Dark | Large | RTL
• Classic | Darkest | Medium | LTR
• Classic | Darkest | Medium | RTL
• Classic | Darkest | Large | LTR
• Classic | Darkest | Large | RTL
• Express | Lightest | Medium | LTR
• Express | Lightest | Medium | RTL
• Express | Lightest | Large | LTR
• Express | Lightest | Large | RTL
• Express | Light | Medium | LTR
• Express | Light | Medium | RTL
• Express | Light | Large | LTR
• Express | Light | Large | RTL
• Express | Dark | Medium | LTR
• Express | Dark | Medium | RTL
• Express | Dark | Large | LTR
• Express | Dark | Large | RTL
• Express | Darkest | Medium | LTR
• Express | Darkest | Medium | RTL
• Express | Darkest | Large | LTR
• Express | Darkest | Large | RTL

[github-actions]

Tachometer results

Chrome

top-nav permalink

Version	Bytes	Avg Time	vs remote	vs branch
npm latest	431 kB	85.94ms - 89.97ms	-	unsure 🔍 -3% - +2% -2.63ms - +1.78ms
branch	424 kB	87.48ms - 89.29ms	unsure 🔍 -2% - +3% -1.78ms - +2.63ms	-

Firefox

top-nav permalink

Version	Bytes	Avg Time	vs remote	vs branch
npm latest	431 kB	138.21ms - 145.83ms	-	unsure 🔍 -3% - +6% -3.78ms - +8.02ms
branch	424 kB	135.40ms - 144.40ms	unsure 🔍 -6% - +3% -8.02ms - +3.78ms	-

[najikahalsema]

LGTM! Thanks for fixing this.