Skip to content

Commit b2e1cd3

Browse files
GianlucaGuariniGianlucaGuarini
committed
updated: doc
1 parent dc96229 commit b2e1cd3

File tree

1 file changed

+34
-16
lines changed

1 file changed

+34
-16
lines changed

‎README.md‎

Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,47 @@ import css from 'bianco.css'
1313
```
1414

1515
[travis-image]: https://img.shields.io/travis/biancojs/css.svg?style=flat-square
16+
1617
[travis-url]: https://travis-ci.org/biancojs/css
18+
1719
[license-image]: http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
20+
1821
[license-url]: LICENSE
22+
1923
[npm-version-image]: http://img.shields.io/npm/v/bianco.css.svg?style=flat-square
24+
2025
[npm-downloads-image]: http://img.shields.io/npm/dm/bianco.css.svg?style=flat-square
26+
2127
[npm-url]: https://npmjs.org/package/bianco.css
2228

2329
## API
2430

2531
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
2632

33+
#### Table of Contents
34+
35+
- [set](#set)
36+
- [Parameters](#parameters)
37+
- [Examples](#examples)
38+
- [get](#get)
39+
- [Parameters](#parameters-1)
40+
- [Examples](#examples-1)
41+
- [remove](#remove)
42+
- [Parameters](#parameters-2)
43+
- [Examples](#examples-2)
44+
2745
### set
2846

2947
Set any css property on a single node or a list of DOM nodes.
3048

31-
**Parameters**
49+
#### Parameters
3250

33-
- `els` **([HTMLElement](https://developer.mozilla.org/en-US/docs/Web/HTML/Element) \| [NodeList](https://developer.mozilla.org/en-US/docs/Web/API/NodeList) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** DOM node/s to parse
34-
- `name` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** either the name of the property to set
51+
- `els` **([HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element) \| [NodeList](https://developer.mozilla.org/docs/Web/API/NodeList) \| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array))** DOM node/s to parse
52+
- `name` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object))** either the name of the property to set
3553
or a list of properties as object key - value
36-
- `value` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the new value of the property (optional)
54+
- `value` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the new value of the property (optional)
3755

38-
**Examples**
56+
#### Examples
3957

4058
```javascript
4159
import { set } from 'bianco.css'
@@ -51,18 +69,18 @@ set(img, {
5169
})
5270
```
5371

54-
Returns **([HTMLElement](https://developer.mozilla.org/en-US/docs/Web/HTML/Element) \| [NodeList](https://developer.mozilla.org/en-US/docs/Web/API/NodeList) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** the original array of elements passed to this function.
72+
Returns **([HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element) \| [NodeList](https://developer.mozilla.org/docs/Web/API/NodeList) \| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array))** the original array of elements passed to this function.
5573

5674
### get
5775

5876
Get any property from a single node or a list of DOM nodes.
5977

60-
**Parameters**
78+
#### Parameters
6179

62-
- `els` **([HTMLElement](https://developer.mozilla.org/en-US/docs/Web/HTML/Element) \| [NodeList](https://developer.mozilla.org/en-US/docs/Web/API/NodeList) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** DOM node/s to parse
63-
- `names` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** name or list of properties to get
80+
- `els` **([HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element) \| [NodeList](https://developer.mozilla.org/docs/Web/API/NodeList) \| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array))** DOM node/s to parse
81+
- `names` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array))** name or list of properties to get
6482

65-
**Examples**
83+
#### Examples
6684

6785
```javascript
6886
import { get } from 'bianco.css'
@@ -78,18 +96,18 @@ get(img, ['width', 'height']) // => {width: '200', height: '300'}
7896
get([img1, img2], ['width', 'height']) // => [{width: '200', height: '300'}, {width: '500', height: '200'}]
7997
```
8098

81-
Returns **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** list of the properties found.
99+
Returns **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array) \| [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** list of the properties found.
82100

83101
### remove
84102

85103
Remove any css property from a single node or a list of DOM nodes.
86104

87-
**Parameters**
105+
#### Parameters
88106

89-
- `els` **([HTMLElement](https://developer.mozilla.org/en-US/docs/Web/HTML/Element) \| [NodeList](https://developer.mozilla.org/en-US/docs/Web/API/NodeList) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** DOM node/s to parse
90-
- `names` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** name or list of properties to remove
107+
- `els` **([HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element) \| [NodeList](https://developer.mozilla.org/docs/Web/API/NodeList) \| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array))** DOM node/s to parse
108+
- `names` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array))** name or list of properties to remove
91109

92-
**Examples**
110+
#### Examples
93111

94112
```javascript
95113
import { remove } from 'bianco.css'
@@ -103,4 +121,4 @@ remove(img, ['width', 'height']) // remove the width and the height property
103121
remove([img1, img2], ['width', 'height']) // remove the width and the height property from both images
104122
```
105123

106-
Returns **([HTMLElement](https://developer.mozilla.org/en-US/docs/Web/HTML/Element) \| [NodeList](https://developer.mozilla.org/en-US/docs/Web/API/NodeList) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** the original array of elements passed to this function.
124+
Returns **([HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element) \| [NodeList](https://developer.mozilla.org/docs/Web/API/NodeList) \| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array))** the original array of elements passed to this function.

0 commit comments

Comments
 (0)