ni / ni/nimble

Icons: Uptake aspect-ratio (CSS), add docs on customizing size

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

Nobody has claimed this yet.

tech debt
Dominant language
TypeScript
Stars
39
Forks
14
Avg merge
1d 16h
Merged PRs (30d)
13

Description

📌 User Story

From https://github.com/ni/nimble/pull/988#discussion_r1084187495 :

Our icons in Storybook currently don't have docs on customizing their size. We should consider adding docs for that, as well as uptaking CSS aspect-ratio (e.g. aspect-ratio: 1 / 1) like the spinner does, so that users only need to change one property (height). Icons would still keep their current default size via the icon-size token.

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 with the icon stories and existing Storybook documentation, then compare the spinner’s CSS sizing behavior. Identify how the icon-size token sets the default and document how users can customize icon size; done means the docs explain changing height and icons support the requested aspect-ratio behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, storybook, typescript
Domain
design, documentation, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.