Skip to content

Commit

Permalink
feat(template): expose getProps util for template
Browse files Browse the repository at this point in the history
Also improve template documentation.

Closes #187
  • Loading branch information
gregberge committed Sep 30, 2018
1 parent a4ce09a commit 5cb238e
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,23 @@ You can use a specific template.
$ npx @svgr/cli --template path/to/template.js my-icon.svg
```

You can find template examples in [templates folder](https://github.com/smooth-code/svgr/blob/master/packages/core/src/templates).
An example of template:

```js
const { getProps } = require('@svgr/core')

const reactDomTemplate = (code, config, state) => {
const props = getProps(config)
let result = `import React from 'react'\n\n`
result += `const ${state.componentName} = ${props} => ${code}\n\n`
result += `export default ${state.componentName}`
return result
}

module.exports = reactDomTemplate
```

You can find all default templates in [templates folder](https://github.com/smooth-code/svgr/blob/master/packages/core/src/templates).

## Node API usage

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ export { default as toReactNative } from './h2x/toReactNative'
// Templates
export { default as reactDomTemplate } from './templates/reactDomTemplate'
export { default as reactNativeTemplate } from './templates/reactNativeTemplate'
export * from './templates/util'

0 comments on commit 5cb238e

Please sign in to comment.