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

Added initial config for docs #20

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

DanielBrierton
Copy link
Collaborator

  • Added React Styleguidist
  • Added basic config for it
  • Slight refactor on how components with React.forwardedRef are handled.
    • This is needed, otherwise the props and methods won't appear in the docs

Very much open to suggestions on other libraries or how we might tidy this up some other way.

@Phidelux
Copy link
Collaborator

Phidelux commented Sep 3, 2019

Could the issue with forwardRef components be caused by conflicts with another package? Seems as this should work since react-styleguidist@^8.0.0. styleguidist/react-styleguidist#1235

@DanielBrierton
Copy link
Collaborator Author

I think the issue referred to there is actually where roughly what I've done doesn't work. I think the issue is that the forwardRef wrapped component doesn't inherit the propTypes from the component it's wrapping.

@AdrianMachado
Copy link
Owner

Is it possible that we can use the withSoftKeyManager function i wrote to wrap these components instead of making these Pure/Nonpure versions? The issue I had with my function was that it wasn't forwarding the refs properly, but I might be able to figure it out

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants