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.

Sign up for GitHub

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

Jump to bottom

README Creations #46

Merged
merged 1 commit into from
Oct 16, 2017
Merged

README Creations #46

merged 1 commit into from
Oct 16, 2017

Conversation

fysheets
Copy link
Contributor

@fysheets fysheets commented Oct 5, 2017 •
edited
Loading

Create base README files for each of the Paragon components

@coveralls
Copy link

Coverage Status

Coverage remained the same at 99.24% when pulling 83be987 on fsheets/readme into fd4b1bd on master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 99.24% when pulling 74645c9e46958a16e52d7e314c1930fcdc19a445 on fsheets/readme into fd4b1bd on master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 99.24% when pulling 918e52904bdedfde3bec03035073276befa798a9 on fsheets/readme into fd4b1bd on master.

@fysheets fysheets changed the title WIP: README Creations README Creations Oct 6, 2017
@coveralls
Copy link

Coverage Status

Coverage remained the same at 99.24% when pulling 6aff2a458a7c2a976ed33c9f42715ee4552dad06 on fsheets/readme into fd4b1bd on master.

fysheets
fysheets commented Oct 6, 2017
View reviewed changes
src/asInput/README.md
@@ -0,0 +1,35 @@
# asInput
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@arizzitano I wouldn't mind discussing this component a bit more -- especially the disabled and required props :)

Copy link
Contributor

Choose a reason for hiding this comment

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

@fysheets to address disabled and required -- although they aren't used directly by asInput itself (you probably saw the eslint ignore rule at the top of the file about this), components that extend asInput do use them (e.g. InputText) and they are passed along within the {...this.props} spread on the WrappedComponent. My primary reason for adding them here was so that they'd be available within inputProps for any input component to use. Does that make sense?

@coveralls
Copy link

Coverage Status

Coverage remained the same at 99.24% when pulling 2023f4bebe4e7d67cfaffd2638ac16a80192e6a4 on fsheets/readme into 4ebc1ab on master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 99.24% when pulling 3e41dd16dd07d978fb1923400a9ff12860e5557f on fsheets/readme into a4e492b on master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 99.24% when pulling 7b67105310728a4bccd8118d256e3e5d76ff398d on fsheets/readme into a4e492b on master.

arizzitano
arizzitano approved these changes Oct 12, 2017
View reviewed changes
Copy link
Contributor

@arizzitano arizzitano left a comment

Choose a reason for hiding this comment

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

Just a couple nit typos here, but this looks great. Thanks for going above and beyond to get this finished -- it's a huge help for us and other devs (plus now you know how everything works!)

src/asInput/README.md Outdated
`className` specifies Bootstrap class names to apply to the input component. The default is an empty array.

### `description` (string or element; optional)
`description` can be used to provide a longer description of the component. It will show up below the input compentent specified. The default is an empty string.
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: compentent

src/asInput/README.md Outdated
`onBlur` is a function that would specify what the input component should do when the `onBlur` event is triggered. For example, it could be used to update which element is currently in focus within the state. The default is an empty function.

### `onChange` (function; optional)
`onChange` is a function that would specify what the input componet should do when the `onChange` event is triggered. For example, it could be storing the updated input data within the state. The default is an empty function.
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: componet

@coveralls
Copy link

Coverage Status

Coverage remained the same at 99.24% when pulling 8f3c3f7905ad6bc43e139bbced2b5b2b1bc92030 on fsheets/readme into a4e492b on master.

@fysheets
Copy link
Contributor Author

This will be ready to merge once #42 has been merged as well.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 99.24% when pulling 831848b on fsheets/readme into a4e492b on master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 99.34% when pulling b718722 on fsheets/readme into c046e63 on master.

@coveralls
Copy link

coveralls commented Oct 16, 2017 •
edited
Loading

Coverage Status

Coverage remained the same at 99.24% when pulling 83be987 on fsheets/readme into fd4b1bd on master.

@fysheets fysheets merged commit 8c9cf8e into master Oct 16, 2017
@fysheets fysheets deleted the fsheets/readme branch October 16, 2017 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arizzitano arizzitano arizzitano approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fysheets @coveralls @arizzitano