more explicit usage docs #404
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
peer dependencies, CSS imports, DOM4 existence. the DOM4 section feels pretty awkward but at least it's there.
adidahiya
suggested changes
Jan 4, 2017
| // using the namespace import | ||
| const anotherSpinner = <Blueprint.Spinner/>; | ||
| Blueprint relies on a handful of DOM Level 4 API methods: `el.query`, `el.queryAll`, and `el.closest()`. | ||
| We depend on a [polyfill library called `dom4`][dom4] to ensure these methods are always available. |
There was a problem hiding this comment.
- "We depend" -> "
@blueprintjs/coredepends" - "are always available." -> "are available."
| // use factories for React.createElement shorthand if you're not using JSX | ||
| const myDatePicker = DatePickerFactory(); | ||
| ``` | ||
| If you consume Blueprint through a module bundler such as Webpack then everything should work swimmingly. |
There was a problem hiding this comment.
I would just remove this paragraph and add a line to the previous paragraph: "This module is conditionally loaded if Blueprint is used in a browser environment."
adidahiya
approved these changes
Jan 4, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #190, Fixes #201
Changes proposed in this pull request:
Reviewers should focus on: