vuetifyjs/vuetify

[Documentation] Font Awesome preset comments

Open

#12522 opened on Oct 28, 2020

View on GitHub
 (0 comments) (0 reactions) (1 assignee)TypeScript (40,995 stars) (7,139 forks)batch import
Service: IconsT: documentationT: enhancementgood first issue

Description

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
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
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.