UNPKG

5.35 kBMarkdownView Raw
1# ISON-JS
2
3```javascript
4// Just say I
5import * as I from "ison-js"
6```
7
8### I.createNewCreative
9Init a new creative, should be call at the end of the JS file
10
11```javascript
12I.createNewCreative({
13 callback: build,
14 name: 'creative',
15 orga: 'ison.inc',
16 favicon: 'assets/favicon.ico'
17})
18```
19***
20### I.getInt
21return the Int value of a size elem in pixel
22
23```javascript
24I.getInt(elem.style.width)
25
26//where elem.style.width = '200px' return 200
27```
28***
29### I.amIphone
30return true on Apple Iphone, browser or app
31
32```javascript
33I.amIphone()
34
35```
36***
37### I.amLandscape
38return true if mobile is in landscape position
39
40```javascript
41I.amLandscape()
42```
43***
44### I.amPortrait
45return true if mobile is in portrait position
46
47```javascript
48I.amPortrait()
49```
50***
51### I.getSize
52return an object size of an element or body
53could return an error for some SDK overwriting the body
54
55```javascript
56I.getSize(elem)
57```
58***
59## SELECTORS
60#### I.select
61short way for `document.getElementById`
62```javascript
63I.select('elem')
64```
65#### I.select
66short way for `document.getElementsByClassName`
67```javascript
68I.selectClass('elem')
69```
70#### I.selectTag
71short way for `document.getElementsByTag`
72```javascript
73I.selectTag('elem')
74```
75#### I.S
76superSelector
77```javascript
78I.S('#id')
79I.S('.class')
80I.S('tag')
81```
82***
83### I.have
84is false if an element is undefined
85```javascript
86I.have(elem)
87```
88***
89### I.create
90short way for `document.createElement`
91```javascript
92I.create('div')
93```
94***
95### I.setElem
96create an element with name and class
97`setElem(tag: string, name: string, index?: number)`
98```javascript
99I.setElem('div', 'foo', 1)
100I.setElem('span', 'bar')
101```
102return
103```html
104<div id="foo1" class="1 foo"></div>
105<span id="bar" class="bar"></span>
106```
107***
108### I.addClass
109short way for `elem.classList.add` for one or many elements
110```html
111<div id="foo1" class="1 foo"></div>
112<span id="bar" class="bar"></span>
113```
114```javascript
115const div = I.select('foo1')
116const span = I.select('bar')
117
118I.addClass('baz', div, span)
119```
120return
121```html
122<div id="foo1" class="1 foo baz"></div>
123<span id="bar" class="bar baz"></span>
124```
125***
126### I.remClass
127short way for `elem.classList.remove` for one or many elements
128```html
129<div id="foo1" class="1 foo baz"></div>
130<span id="bar" class="bar baz"></span>
131```
132```javascript
133const div = I.select('foo1')
134const span = I.select('bar')
135
136I.remClass('baz', div, span)
137```
138return
139```html
140<div id="foo1" class="1 foo"></div>
141<span id="bar" class="bar"></span>
142```
143***
144### I.toggleClass
145short way for `elem.classList.toggle` for one or many elements
146```html
147<div id="foo1" class="1 foo baz"></div>
148<span id="bar" class="bar baz"></span>
149```
150```javascript
151const div = I.select('foo1')
152const span = I.select('bar')
153
154I.toggleClass('baz', div)
155I.toggleClass('fuz', span)
156```
157return
158```html
159<div id="foo1" class="1 foo"></div>
160<span id="bar" class="bar baz fuz"></span>
161```
162***
163### I.appendToDom
164short way for `elem.appendChild(anotherElem)` for one or many elements. Could be 'body' for document.body
165```javascript
166I.appendToDom(wrapper, div, span)
167```
168should append div and span into wrapper
169***
170## CSS manipulation
171### I.innerTxt
172short way for `elem.innerHTML` for one or many elements.
173```javascript
174I.innerTxt('some text', div, span)
175```
176### I.opacity
177short way for `elem.style.opacity` for one or many elements.
178```javascript
179I.opacity(0.5, div, span)
180```
181could be shortened :
182```javascript
183I.opacity0(div, span) // set opacity to 0
184I.opacity1(div, span) // set opacity to 1
185```
186### I.display
187short way for `elem.style.display` for one or many elements.
188```javascript
189I.display('none', div, span)
190```
191could be shortened :
192```javascript
193I.displayBlock(div, span) // set display to 'block'
194I.displayNone(div, span) // set display to 'none'
195I.displayFlex(div, span) // set display to 'flex'
196```
197### I.setPos
198short way for `elem.style.position` for one or many elements.
199```javascript
200I.setPos('absolute', div, span)
201```
202could be shortened :
203```javascript
204I.setAbs(div, span) // set position to 'absolute'
205I.setRel(div, span) // set position to 'relative'
206I.setFix(div, span) // set position to 'fixed'
207```
208### I.setZindex
209short way for `elem.style.zIndex` for one or many elements.
210```javascript
211I.setZindex(42, div, span)
212```
213### I.bkgColor
214short way for `elem.style.backgroundColor` for one or many elements.
215```javascript
216I.bkgColor('#fff', div, span)
217```
218### I.setPM
219short way for `elem.style.margin` or `elem.style.padding` for one or many elements.
220Can be an int for px, a string for %, a vh or vw value or auto
221```javascript
222I.setPM('margin',10, div, span) // 10px
223I.setPM('padding','10', div, span) // 10%
224I.setPM('margin','10vw', div, span) // 10vw
225I.setPM('padding','auto', div, span) //auto
226```
227could be shortened :
228```javascript
229I.setPadding(10,div, span) // set margin to 10px
230I.setMargin('10',div, span) // set position to 'relative'
231```
232#### I.innerTxt
233short way for `elem.innerHTML` for one or many elements.
234```javascript
235I.innerTxt('some text', div, span)
236```
237#### I.innerTxt
238short way for `elem.innerHTML` for one or many elements.
239```javascript
240I.innerTxt('some text', div, span)
241```
242#### I.innerTxt
243short way for `elem.innerHTML` for one or many elements.
244```javascript
245I.innerTxt('some text', div, span)
246```
247#### I.innerTxt
248short way for `elem.innerHTML` for one or many elements.
249```javascript
250I.innerTxt('some text', div, span)
251```