Document React Toolbox #12
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
casto101
reviewed
Dec 30, 2016
| yo react-zeal | ||
| ``` | ||
|
|
||
| Viola! Now craft with React |
There was a problem hiding this comment.
Voila ;) I'd probably end this with a period, as well as the comments above.
| @@ -41,3 +49,48 @@ import styles from './styles.scss' | |||
| ``` | |||
|
|
|||
| In order to better support usage inside Rails etc we have moved the public directory inside the client directory. Thus the frameworks' root will not be cluttered with anything other than the client directory. The generated app will run with `npm start` and you can still develop on `localhost:3000` if you are not in the context of a larger framework. | |||
There was a problem hiding this comment.
I think frameworks' should be framework's? But I'm not entirely sure what you're referring to--the Rails (or other) framework you'd be generating into?
There was a problem hiding this comment.
I'm referring to multiple frameworks, Rails and Phoenix specifically and so my intention is plural possessive.
There was a problem hiding this comment.
Okay, got it. I guess my confusion was that you'd only be using one framework at any given time, which would require a singular form, but with that clarification I think your wording makes sense.
| ``` | ||
| This allows the apps `ThemeProvider` context to pass this information to react-toolbox. By default we follow this pattern for `ProgressBar` as an example. | ||
|
|
||
| Great, you now have hooked into the theme provider. Now you just have to import the _un-themed_ version of the component from react-toolbox and like the theme provider do the rest. |
There was a problem hiding this comment.
let the theme provider do the rest, I think?
craineum
reviewed
Jan 4, 2017
| @@ -41,3 +49,48 @@ import styles from './styles.scss' | |||
| ``` | |||
|
|
|||
| In order to better support usage inside Rails etc we have moved the public directory inside the client directory. Thus the frameworks' root will not be cluttered with anything other than the client directory. The generated app will run with `npm start` and you can still develop on `localhost:3000` if you are not in the context of a larger framework. | |||
|
|
|||
| ## React Toolbox | |||
| The generator installs by default [React Toolbox](http://react-toolbox.com/) which is set of Material Design components. At Zeal we have found this project to be an excellent starting point for many common UI patterns. You can of-course ignore it and or remove it from the generated app if you are so inclined. | |||
| ### Using Customizable React Toolbox Components | ||
| To make for the most flexibility when dealing with React Toolbox we recommend following the pattern of manually adding and exporting the desired components theme. Then instead of importing the pre-themed component from `react-toolbox`, import the un-themed version. Don't worry, if you have exported the theme manually it will still have the default theme, and now you will have more flexibility in terms of overriding theme defaults. | ||
|
|
||
| For example you would like to use the button component from `react-toolbox` and would like to override the default primary color. You will want to import / export the that buttons theme from `react-toolbox` along with a hook for your customization. |
lexun
approved these changes
Jan 4, 2017
Add documentation for themr
…tor-react-zeal into document-react-toolbox
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.
No description provided.