vuetifyjs/vuetify

[Documentation] Font Awesome preset comments

Open

#12.522 geöffnet am 28. Okt. 2020

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)TypeScript (40.995 Stars) (7.139 Forks)batch import
Service: IconsT: documentationT: enhancementgood first issue

Beschreibung

Problem to solve

Clarity in icon usage for components, for delete and clear. Currently, it's confusing for people that use Font Awesome (5).

Proposed solution

Update comments in the fa.ts file, so it's more clear which components the icons are used in by default. Maybe include cancel and close too since those words all mean similar things.

image

Contributor Guide

Tech Stack
typescriptvue
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90
Research-Richtung
Examine the file packages/vuetify/src/services/icons/presets/fa.ts, particularly the comments for 'delete' and 'clear' icons. Identify which components (e.g., v btn) use these icons by default. Update the comments to clearly indicate the component and context, and consider adding annotations for 'cancel' and 'close' for clarity. No need to modify the icon mappings themselves.