53 lines
1.6 KiB
Markdown
53 lines
1.6 KiB
Markdown
# css-list-helpers
|
|
|
|
[](https://www.npmjs.org/package/css-list-helpers)
|
|
[](https://www.npmjs.org/package/css-list-helpers)
|
|
[](https://travis-ci.org/jedmao/css-list-helpers)
|
|
[](https://codecov.io/gh/jedmao/css-list-helpers)
|
|
|
|
[](https://nodei.co/npm/css-list-helpers/)
|
|
|
|
Helper methods for splitting CSS lists (i.e., by spaces or commas), extracted from [PostCSS#list](https://github.com/postcss/postcss/blob/master/lib/list.es6).
|
|
|
|
## Installation
|
|
|
|
```
|
|
$ npm install css-list-helpers [--save[-dev]]
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
var listHelpers = require('css-list-helpers');
|
|
|
|
listHelpers.splitBySpaces(' 0 a(b / c) "d e" ');
|
|
// ['0', 'a(b / c)', '"d e"']
|
|
|
|
listHelpers.splitByCommas(' 0, a(b / c), "d e" ');
|
|
// ['0', 'a(b / c)', '"d e"']
|
|
|
|
listHelpers.split('a/fn(b / c)', ['/']);
|
|
// ['a', 'fn(b / c)']
|
|
```
|
|
|
|
### ES6/2015 import
|
|
|
|
```ts
|
|
import * as listHelpers from 'css-list-helpers';
|
|
```
|
|
|
|
## Docs
|
|
|
|
This project provides first-class TypeScript support via generated TypeScript
|
|
definitions, included with the package. As such, you shouldn't have to
|
|
look-up documentation in your editor, so long as your editor supports
|
|
TypeScript.
|
|
|
|
## Testing
|
|
|
|
```
|
|
$ npm test
|
|
```
|
|
|
|
This will run tests and generate a code coverage report. Anything less than 100% coverage will throw an error.
|