nuxt / nuxt/icon

Type safe local icon support

Open
#359 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.2k
Forks
96
Avg merge
8h 12m
Merged PRs (30d)
2

Description

Hi there!

I've been using the Icon component both personally and at work; I found that when working with local icon collections, the intellisense I get back from the Icon component is lacking compared to the experience I have with Iconify collections.

If possible I'd like to make a modification that enables type generation for local collections (I already have a good working PR, but it might require some feedback).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how the Icon component currently types local collections and how Iconify collections provide type information. Compare the existing behavior with the proposed working PR, then verify that local collection names provide the expected IntelliSense and generated types.

Written by the indexing model from the issue text.

Assessment

Tech stack
nuxt, typescript
Domain
developer-experience, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.