Initial README documentation #9
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
taveras
approved these changes
Dec 11, 2017
README.md
Outdated
|
|
||
| const xmlToReact = new XMLToReact({ | ||
| Example: (attrs) => ({ type: 'ul', props: attrs }), | ||
| Item: (attrs) => ({ type: 'li', props: attrs }) |
There was a problem hiding this comment.
should we show an example where type is a custom React component?
There was a problem hiding this comment.
yes, I was a tad lazy
README.md
Outdated
| </Example> | ||
| `); | ||
|
|
||
| React.render('app-container', reactTree); |
There was a problem hiding this comment.
nit: do we mean ReactDOM instead of React here?
|
|
||
| Converters are required mapping functions that define how an XML node should be converted to React. A converter must return an object in the format `{ type, [props] }`, which is intended to be passed to [`React.createElement`](https://reactjs.org/docs/react-api.html#createelement). | ||
|
|
||
| - `type` - required tagName, React component, or React fragment |
README.md
Outdated
| Converters are required mapping functions that define how an XML node should be converted to React. A converter must return an object in the format `{ type, [props] }`, which is intended to be passed to [`React.createElement`](https://reactjs.org/docs/react-api.html#createelement). | ||
|
|
||
| - `type` - required tagName, React component, or React fragment | ||
| - `props` - optional props object |
There was a problem hiding this comment.
could we place "optional" in parenthesis, similar to below?
README.md
Outdated
|
|
||
| ```js | ||
| { | ||
| [nodeName]: converterFunction |
There was a problem hiding this comment.
nit: could we remove the brackets around nodeName? it reads as being optional
There was a problem hiding this comment.
oh, yeah, i was using the dynamic property syntax. but yes, i'll make this change
taveras
approved these changes
Dec 11, 2017
Closed
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.
This is still work in progress
After spending time working on examples and the API documentation, I realized that I probably should have just started with the generic project info. Maybe I can split this apart.