nextcloud-libraries / nextcloud-libraries/nextcloud-vue
Consistent icon behavior
Nobody has claimed this yet.
- Dominant language
- Vue
- Stars
- 246
- Forks
- 99
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 103
Description
We have several places where we allow to use a prop for the icon, but this prop is not consistent across the components.
So I would like to clarify this for the upcoming version 9:
- Do we still want to support icon classes using the icon prop
- Do we still want to support URLs in the icon prop
- Do we want to keep the icon prop at all?
- If we keep it, do we want to support SVGs passed to the icon prop?
And from that questions we should probably make all components consistent with the icon prop.
cc @skjnldsv @raimund-schluessler @ShGKme for input 😃
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing components that expose the icon prop and compare how each handles icon classes, URLs, and SVGs. Resolve the four listed API questions for version 9, then make icon behavior consistent across those components and verify that the agreed prop contract is applied everywhere.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100