Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] We should document the possible values for the icon attribute of Elements, like <rh-tag>, etc. #1524

Open
markcaron opened this issue Apr 17, 2024 · 4 comments
Assignees
Labels
docs Improvements or additions to documentation

Comments

@markcaron
Copy link
Collaborator

Our docs aren't very clear on what string goes into the icon attribute on our Elements.

For example, on Tag:

image

The presumption is the names of the icons from <pf-icon> or <rh-icon>, but what are they?

@markcaron markcaron added the docs Improvements or additions to documentation label Apr 17, 2024
@bennypowers
Copy link
Member

bennypowers commented Apr 18, 2024

For reference, https://patternflyelements.org/components/icon/demo/sets/ lists all the available icons

@hellogreg
Copy link
Collaborator

Tackle after rh-icon

@bennypowers
Copy link
Member

there's some preliminary work in #1859 and #1844, just adding the correct types to the element source files

we can go back later and transform those types in 11ty into links to the icon page (#1844)

@bennypowers
Copy link
Member

pushing the second phase of this (transforming the IconNameFor type in the 11ty attrs table to a link to iconography page) to cubone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

3 participants