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

Deprecate "brand" in axe.configure #2891

Closed
WilcoFiers opened this issue Apr 26, 2021 · 2 comments
Closed

Deprecate "brand" in axe.configure #2891

WilcoFiers opened this issue Apr 26, 2021 · 2 comments
Labels
deprecation pr A pr has been created for the issue
Milestone

Comments

@WilcoFiers
Copy link
Contributor

Up until about a year ago axe-core used axe.configure({ branding: { brand }}) to distinguish results produced by Attest products from results produced with axe. This is no longer necessary, since all Attest products have been renamed to axe DevTools. This should let us deprecate the brand property. As we're doing that, we might also want to consider changing the "branding" API. Maybe it could just be axe.configure({ application })?

@WilcoFiers WilcoFiers added this to the axe-core 4.3 milestone Apr 26, 2021
@WilcoFiers
Copy link
Contributor Author

Talked to @dylanb about this. What I think we should do is to deprecate branding.brand, and no longer use it to generate help URLs. It can only ever be axe, anything configured with branding.brand will be ignored as of axe-core 4.3. In addition, I think we should update axe.configure({ branding }) and allow branding to be a string, if it is, it is used as the application key in the help URL.

@padmavemulapati
Copy link

Validated with the latest develop branch axe-core code based,

// previously
axe.configure({
  branding: { application: 'axe' }
})
// current
able to configure `branding` with specified string.
axe.configure({ branding: 'axe' })

for ex: if I pass await axe.configure({ branding: 'axe' });
I am seeing helpURL:
image

If I pass await axe.configure({ branding: 'Padma' }); also
I am seeing helpURL with string "Padma"
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation pr A pr has been created for the issue
Projects
None yet
Development

No branches or pull requests

2 participants