patternfly / patternfly/patternfly-react

Icons - add support for custom icons

Open
#11,055 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Stale
Dominant language
TypeScript
Stars
862
Forks
392
Avg merge
4d 8h
Merged PRs (30d)
9

Description

Is this a new component or an extension of an existing one?
What is the existing component, if any?

Existing, MenuToggle, ToolbarFilter

When using PF tokens to create a custom theme, MenuToggle and ToolbarFilter use default icons in PF that currently cannot be changed via a prop since the prop does not exist, while components like Label, Alert, and Button, offer this functionality.

An alternative option was discussed at today's working session (cc @mcoker), which would include adding support for custom icons directly to react-icons and then importing any custom overrides.

Related: https://github.com/patternfly/patternfly-react/issues/10634

Describe the feature
A clear and concise description of the new feature. What is the expected behavior?

Are there visuals for this feature? If applicable, please include examples for each state and for varying widths

See below. MUI uses a different toggle icon for their menu toggle.

Include screenshots or links to Marvel or other mockups.
MUI:
Screenshot 2024-09-24 at 4 27 39 PM
Screenshot 2024-09-25 at 3 21 01 PM

PF:
Screenshot 2024-09-24 at 4 28 05 PM
Screenshot 2024-09-25 at 3 26 46 PM

Any other information?
Would it be possible to prioritize this work for an upcoming sprint to align with RHOAI priorities for the MUI theming effort @nicolethoen ?

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 the MenuToggle and ToolbarFilter component implementations, then read related issue #10634 and the discussion about extending react-icons. Done means users can provide custom icons for both components through an agreed, documented API, with behavior consistent with the existing icon support in Label, Alert, and Button.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
design, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.