grommet/grommet

[TS] Undocumented theme option `defaultMode` missing from TypeScript definitions

Open

#4 607 ouverte le 14 oct. 2020

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)JavaScript (8 247 stars) (1 015 forks)batch import
documentationgood first issuetypescript

Description

Expected Behavior

defaultMode is used in Grommet component along with themeMode prop to determine initial theme mode between dark and light themes. As this property is used by Grommet Theme Designer, Grommet HPE Theme and in HPE Design System I would expect it to be documented and included in the TypeScript definitions.

Actual Behavior

defaultMode is not documented and not included in TS definisions, resulting in an error when used

  • Grommet version: 2.15.2

Guide contributeur

Stack technique
typescriptreact
Domaine
frontend
Type d'issue
bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Knowledge of TypeScriptFamiliarity with Grommet theming
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
Examine the Grommet component's source code at src/js/components/Grommet/Grommet.js to understand how defaultMode is used. Then locate the TypeScript definition files (likely in index.d.ts) and add the missing `defaultMode` property to the theme type definition. Review any related documentation to ensure consistency.