dequelabs/axe-core

Axe-core's d.ts file is incomplete

Open

#4.241 geöffnet am 9. Nov. 2023

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (5.457 Stars) (783 Forks)batch import
help wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
TypeScript basicsUnderstanding of axe core API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
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.