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

EuiIcon is missing props #3185

Closed
myasonik opened this issue Mar 27, 2020 · 14 comments
Closed

EuiIcon is missing props #3185

myasonik opened this issue Mar 27, 2020 · 14 comments
Labels
bug documentation Issues or PRs that only affect documentation - will not need changelog entries

Comments

@myasonik
Copy link
Contributor

EuiIcon seems to be missing props

Screen Shot 2020-03-27 at 15 36 33

@myasonik myasonik added bug documentation Issues or PRs that only affect documentation - will not need changelog entries labels Mar 27, 2020
@Marvin9
Copy link
Contributor

Marvin9 commented Mar 28, 2020

Can I give it a try?

@Marvin9
Copy link
Contributor

Marvin9 commented Mar 28, 2020

@myasonik react-docgen plugin is not generating __docgenInfo property of EuiIcon, After debugging custom plugin proptypes-from-ts-props and react-docgen, I found this error (in react-docgen) is stopping __docgenInfo generation.

Screenshot from 2020-03-28 18-06-43

I wonder if anything is missed out in proptypes-from-ts-props plugin or It is issue of react-docgen itself.

@ghost
Copy link

ghost commented Mar 28, 2020

@Marvin9 Are you trying it still or should I try to fix?

@Marvin9
Copy link
Contributor

Marvin9 commented Mar 28, 2020

You can try @walter-ind

@ghost
Copy link

ghost commented Mar 28, 2020

Thanks @Marvin9

@Marvin9
Copy link
Contributor

Marvin9 commented Mar 29, 2020

Figured out, if we manually remove if statement which is throwing error, we got result.

Screenshot from 2020-03-29 20-21-27

In short, the problem is with dynamic import which is not recognized by ast-types.

This issue will be solved in #3056

@ghost
Copy link

ghost commented Mar 30, 2020

There is one more way by which this issue can be fixed right now and that is if we add props_info.js file in icons folder of views directory and put all prop info into it. @myasonik ?

@myasonik
Copy link
Contributor Author

EUI team, what do y'all think? I've got no idea.

@snide
Copy link
Contributor

snide commented Mar 30, 2020

There is one more way by which this issue can be fixed right now and that is if we add props_info.js file in icons folder of views directory and put all prop info into it. @myasonik ?

This is fine as a short term solution. If you make this, I'd advise against listing the entire icon list (since it is fairly long) for the type and make a custom output that says "Check docs for a list of acceptable values"...etc.

@ghost
Copy link

ghost commented Mar 30, 2020

I know it would be too long. It's better to make one solution that stays for long. So better, let it be fixed by #3056.

@chandlerprall
Copy link
Contributor

The icon props display for me, locally. Is this something that has already been fixed on master, or is it a problem with the docs' production build?

@elizabetdev
Copy link
Contributor

@chandlerprall I think it's a problem is in the doc's production build. I can see the icons props locally but in a build, it doesn't show up: https://eui.elastic.co/pr_3200/#/display/icons

@chandlerprall
Copy link
Contributor

chandlerprall commented Mar 31, 2020

I just did a docs build locally (yarn build-docs && cd docs && python -m SimpleHTTPServer) and see the icon props. Let's keep an eye on this after the next EUI release & docs deploy.

@snide
Copy link
Contributor

snide commented Apr 2, 2020

Latest release cleared up this issue. Will monitor the builds the next few docs syncs to see if there is something flakey here.

@snide snide closed this as completed Apr 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation Issues or PRs that only affect documentation - will not need changelog entries
Projects
None yet
Development

No branches or pull requests

5 participants