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

add docs for using withProps from recompose #198

Merged
merged 10 commits into from
Sep 1, 2017

Conversation

divyagnan
Copy link
Contributor

@divyagnan divyagnan commented Jul 28, 2017

What:
Added documentation for using emotion with the withProps HOC from recompose.

Why:
#111

How:
I added a with-props.md file to the docs folder.

Checklist:

  • Documentation
  • Tests N/A
  • Code complete N/A

I wasn't sure how many examples to include or how in-depth to make them so I kept it really simple for now. I also wasn't entirely sure of what to name the new doc file so I tentatively went with with-props.md.

@codecov-io
Copy link

codecov-io commented Jul 28, 2017

Codecov Report

Merging #198 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #198   +/-   ##
=======================================
  Coverage   90.37%   90.37%           
=======================================
  Files          21       21           
  Lines         966      966           
  Branches      260      260           
=======================================
  Hits          873      873           
  Misses         75       75           
  Partials       18       18

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5d436cf...6b0d63a. Read the comment docs.

@tkh44
Copy link
Member

tkh44 commented Aug 11, 2017

Sorry for taking so long with this.

@@ -0,0 +1,11 @@
## Usage with recompose's withProps

You can pass additional props to your components using recompose's `withProps` higher-order component. The `withProps` api is laid out [here](https://github.com/acdlite/recompose/blob/master/docs/API.md#withprops).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"here" isn't a very accessible anchor link - perhaps it could be "in the recompose documentation" instead?

@tkh44 tkh44 merged commit 86b4a61 into emotion-js:master Sep 1, 2017
@divyagnan divyagnan deleted the docs/withProps branch September 1, 2017 22:43
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.

None yet

5 participants