KaiUI icon indicating copy to clipboard operation
KaiUI copied to clipboard

Added initial config for docs

Open DanielBrierton opened this issue 6 years ago • 3 comments

  • 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.

DanielBrierton avatar Sep 03 '19 16:09 DanielBrierton

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

Phidelux avatar Sep 03 '19 19:09 Phidelux

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.

DanielBrierton avatar Sep 04 '19 08:09 DanielBrierton

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

AdrianMachado avatar Sep 09 '19 07:09 AdrianMachado