dequelabs/axe-core

Axe-core's d.ts file is incomplete

Open

#4,241 opened on Nov 9, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (5,457 stars) (783 forks)batch import
help wanted

Description

Product

axe-core

Product Version

No response

Latest Version

  • I have tested the issue with the latest version of the product

Issue Description

I wanted to access the function isVisibleOnScreen from axe.commons.dom, but this is not exported in the .d.ts.

This technically can be solved by adding the function to the d.ts file, but there are multiple functions that are not exported, not just the function I'm mentioning.

Contributor guide

Tech stack
javascripttypescript
Domain
developer experiencedocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
TypeScript basicsUnderstanding of axe core API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Look at the existing .d.ts file (likely in typings/axe core.d.ts) and compare with the exported functions in the source code. Start by adding the missing isVisibleOnScreen function from axe.commons.dom, then identify other missing functions by checking the source's public API against the type declarations. Review any comments or maintainer notes for additional guidance.