An open API service indexing awesome lists of open source software.

https://github.com/tiaanduplessis/svg-fallback

Image fallback for when SVG ain't a thing
https://github.com/tiaanduplessis/svg-fallback

fallback svg

Last synced: 9 months ago
JSON representation

Image fallback for when SVG ain't a thing

Awesome Lists containing this project

README

          

svg-fallback



Image fallback for when SVG ain't a thing





npm package version


npm downloads


standard JS linter


prettier code formatting


travis ci build status


project license


make a pull request






Github Watch Badge


Github Star Badge


Tweet





Built with ❤︎ by tiaanduplessis and contributors

Table of Contents

Table of Contents

  • Install

  • Usage

  • Contribute

  • License
  • ## Install

    ```sh
    $ npm install svg-fallback
    # OR
    $ yarn add svg-fallback
    ```

    ## Usage

    ```js
    import svgFallback from 'svg-fallback'

    svgFallback({
    type: 'png', // Type of image to replace with. Should have the same name as the svg and be in the same directory
    ignore: '', // Element with this class name will be ignored
    dev: true // If true, will always replace svg. Used for dev
    })

    ```

    See a example [here](example).

    ## Contributing

    Contributions are welcome!

    1. Fork it.
    2. Create your feature branch: `git checkout -b my-new-feature`
    3. Commit your changes: `git commit -am 'Add some feature'`
    4. Push to the branch: `git push origin my-new-feature`
    5. Submit a pull request :D

    Or open up [a issue](https://github.com/tiaanduplessis/svg-fallback/issues).

    ## License

    Licensed under the MIT License.