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

Issue 67 - Add callback to return full axe-core results object #68

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

gilgold
Copy link

@gilgold gilgold commented Oct 13, 2020

  • Adding a callback method for handling the full axe-core results object

- Adding a callback method for handling the full axe-core results object
- Updating README.md with resultsCallback info
Copy link
Member

@sapegin sapegin left a comment

Choose a reason for hiding this comment

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

Hey, thanks for the pull request!

This looks like a breaking change. I'm thinking about a new API for the next major release, and probably we'll need to replace all positional arguments of checkA11y with an object because we already have way too many and they are all optional.

I'll keep this pull request as a reference, and either include in the new version or ask you to rebase it on top of it.

@sapegin sapegin added this to the 1.0.0: New API milestone Oct 26, 2020
@kristina-hager
Copy link

I'm thinking about a new API for the next major release, and probably we'll need to replace all positional arguments of checkA11y with an object because we already have way too many and they are all optional.

big plus 1 to using an object for the args.
also, if there will be big changes, i'd suggest just dropping 'violationsCallback' in favor of 'resultsCallback'.
It would be pretty easy for a resultsCallback to focus just on violations.

@sapegin
Copy link
Member

sapegin commented Oct 27, 2020

That's a good point!

@kristina-hager
Copy link

@sapegin - Hi, do you have any ETA for the new API to move to an arguments object? Do you need any help with this?
We are using an internal fork of this lib due to the need for a full results object. We'd rather help out with this version so we can retire our internal fork. Please let me know what can help!
I could, for example, create a PR to move the existing supported options to an args object. That would allow PRs like this and some of the other open ones to rebase and redo their PRs.

@sapegin sapegin mentioned this pull request Nov 11, 2020
@sapegin
Copy link
Member

sapegin commented Nov 11, 2020

I drafted my ideas on the new API: #75. I hope this covers your use case — let me know what you think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants