Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/department-stockholm/svgsus
Organize, clean and transform your SVGs
https://github.com/department-stockholm/svgsus
Last synced: 8 days ago
JSON representation
Organize, clean and transform your SVGs
- Host: GitHub
- URL: https://github.com/department-stockholm/svgsus
- Owner: department-stockholm
- License: mit
- Created: 2016-08-23T12:19:01.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-05T11:52:24.000Z (over 7 years ago)
- Last Synced: 2024-09-21T08:52:12.448Z (about 2 months ago)
- Language: JavaScript
- Size: 331 KB
- Stars: 40
- Watchers: 7
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://npmjs.org/package/svgsus) [](https://travis-ci.org/department-stockholm/svgsus) [](https://ci.appveyor.com/project/slaskis/svgsus)
## Install
### Command Line
To use svgsus as a command line tool anywhere in your system you simply need
to install globally it using [npm](https://npm.com).
```
npm install -g svgsus
```
### Library
Or if you want to use svgsus as a library in your project you also use npm but
keep it local to your project to make it easier for your fellow developers.
```
npm install --save svgsus
```
### App
There's also the option of installing Svgsus as an App if you're on macOS
(versions for Windows and Linux are planned).
The app, besides providing a GUI for this tool, also has a few more features.
Read all about them on [our website](http://www.svgs.us) and [our medium post](https://medium.com/@DepartmentStockholm/svgsus-tips-tricks-ba2de435fee0#.o193oyj0t).
[](https://itunes.apple.com/en/app/svgsus/id1106867065?l=en&mt=12)
## Usage
### Command Line
```
Svgsus - Organize, clean and transform your SVGs
Usage: svgsus [options] [--] [...]
svgsus svg [--codeIndent= --compressed --output=] [--] [...]
svgsus svgsymbol [--codeIndent= --stripStyle --name= --compressed --output=] [--] [...]
svgsus css [--codeIndent= --output=] [--] [...]
svgsus (pug|jade) [--codeIndent= --output=] [--] [...]
svgsus cashapelayer [--codeIndent= --codeType= --output=] [--] [...]
svgsus uibeziershape [--codeType= --output=] [--] [...]
svgsus vectordrawable [--codeIndent= --output=] [--] [...]
svgsus -h | --help
svgsus --version
Options:
--stripStyle whether to remove any style tags from the SVG so it's
stylable using CSS.
--name= the id of the symbol in the sheet [default: svg-symbol]
--compressed whether the output should have whitespace stripped
--codeIndent= must be whitespace [default: " "]
--codeType= must be either "AppKit" or "UIKit" [default: UIKit]
--output= a directory to write converted files to, defaults to
current directory if any s are specified
```
If no files are specified svgsus expects an SVG to be piped in using stdin and
the formatted output will be piped to stdout.
### Library
Svgsus exports a few converters which each take an SVG and (an optional)
options object as arguments.
### Example
A quick example to demonstrate using svgsus as a library. It reads a an SVG file
and generates a cleaned version of it.
```
const fs = require('fs')
const svgsus = require('svgsus')
const svg = fs.readFileSync('example.svg', 'utf8')
const options = {compressed: true}
svgsus.svg(svg, options).then(cleanedSvg => fs.writeFileSync('example-cleaned.svg'))
```
### API
#### `svgsus.svg.convert(svg, options={})`
Optimizes an SVG using [svgo](https://github.com/svg/svgo).
Options:
- `codeIndent` - a string of whitespace to be used for indentation
- `compressed` - whether the output should have its whitespace stripped
#### `svgsus.svgsymbol.convert(svg, options={})`
Generates a SVG symbol in a "Spritesheet". It can then easily be used in HTML
documents using svg ``-tags.
Options:
- `name` - the id of the symbol in the sheet
- `stripStyle` - whether to remove any style tags from the SVG so it's stylable using CSS.
- `codeIndent` - a string of whitespace to be used for indentation
- `compressed` - whether the output should have its whitespace stripped
#### `svgsus.css.convert(svg, options={})`
Generates CSS class with a background using the SVG as a data-uri.
Options:
- `codeIndent` - a string of whitespace to be used for indentation
#### `svgsus.pug.convert(svg, options={})` or `svgsus.jade(svg, options={})`
Renders the SVG as Pug (formerly known as Jade).
Available Options:
- `codeIndent` - a string of whitespace to be used for indentation
#### `svgsus.cashapelayer.convert(svg, options={})`
Renders the SVG as Swift code suitable for iOS (UIKit) or macOS (AppKit).
Available Options:
- `codeIndent` - a string of whitespace to be used for indentation
- `codeType` - must be either "AppKit" or "UIKit"
#### `svgsus.uibeziershape.convert(svg, options={})`
Renders the SVG as a single merged UIBezierShape in Swift code suitable
for iOS (UIKit) or macOS (AppKit).
Available Options:
- `codeType` - must be either "AppKit" or "UIKit"
#### `svgsus.vectordrawable.convert(svg, options={})`
Renders the SVG as XML code suitable for Android.
Available Options:
- `codeIndent` - a string of whitespace to be used for indentation
#### `svgsus..convertAll(inputs, options={})`
Every format also provides a `convertAll()`-function which accepts multiple
inputs.
The `inputs`-argument should be an array of `{name, svg}`-objects and the
output will be an array of `{name, code}`-objects, for example:
```
const inputs = [
{name: 'trashcan', svg: fs.readFileSync('trashcan.svg', 'utf8')},
{name: 'star', svg: fs.readFileSync('star.svg', 'utf8')}
]
svgsus.svg.convertAll(inputs)
.then(outputs =>
outputs.forEach(({name, code}) =>
fs.writeFileSync(name, code)
)
)
```
The number of files in the `outputs`-array depends on the format.
Currently the _swift_-based formats, `cashapelayer` and `uibezierpath`,
generate a single .swift file with each input svg as separate variables.
And the other formats output one output file per input file.
The options are the same as the `convert()`-equivalent.
## Contribute
Please have a look at our [contribution guidelines](CONTRIBUTING.md).
## Credits
A very special thanks to the all the developers of our beloved dependencies, and to [svg2android](https://github.com/inloop/svg2android) for providing the inspiration and source of the Vector Drawable converter.
With ❤️ by [Department](https://department.se).