Skip to content

Commit e51e221

Browse files
committed
Add docs
1 parent 35fd5d0 commit e51e221

File tree

1 file changed

+184
-0
lines changed

1 file changed

+184
-0
lines changed

README.md

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
# JavaScript Snippets for Sublime Text
2+
3+
Vanilla JavaScript snippets for Sublime Text 2 and 3.
4+
5+
## Install
6+
7+
### Package Control
8+
9+
TODO: Include project on Package Control
10+
11+
### Sublime Text 2
12+
13+
TODO: Include instructions for Sublime Text 2
14+
15+
### Sublime Text 3
16+
17+
* Mac OS X
18+
19+
```
20+
git clone git://github.com/jprichardson/sublime-js-snippets.git ~/Library/Application Support/Sublime Text 3/Packages
21+
```
22+
23+
* Linux
24+
25+
```
26+
git clone git://github.com/jprichardson/sublime-js-snippets.git ~/.config/sublime-text-3/Packages
27+
```
28+
29+
* Windows
30+
31+
```
32+
git clone git://github.com/jprichardson/sublime-js-snippets.git %userprofile%\AppData\Roaming\Sublime Text 3\Packages
33+
```
34+
35+
## Console
36+
37+
### [cd] console.dir
38+
39+
```javascript
40+
console.dir(${1:obj});
41+
```
42+
43+
### [ce] console.error
44+
45+
```javascript
46+
console.error(${1:obj});
47+
```
48+
49+
### [cl] console.log
50+
51+
```javascript
52+
console.log(${1:obj});
53+
```
54+
55+
### [cw] console.warn
56+
57+
```javascript
58+
console.warn(${1:obj});
59+
```
60+
61+
## DOM
62+
63+
### [gi] getElementById
64+
65+
```javascript
66+
${1:document}.getElementById('${2:id}');
67+
```
68+
69+
### [gc] getElementsByClassName
70+
71+
```javascript
72+
${1:document}.getElementsByClassName('${2:class}');
73+
```
74+
75+
### [gt] getElementsByTagName
76+
77+
```javascript
78+
${1:document}.getElementsByTagName('${2:tag}');
79+
```
80+
81+
### [qs] querySelector
82+
83+
```javascript
84+
${1:document}.querySelector('${2:selector}');
85+
```
86+
87+
### [qsa] querySelectorAll
88+
89+
```javascript
90+
${1:document}.querySelectorAll('${2:selector}');
91+
```
92+
93+
### [ae] addEventListener
94+
95+
```javascript
96+
${1:document}.addEventListener('${2:event}', function(e) {
97+
${3}
98+
});
99+
```
100+
101+
### [ac] appendChild
102+
103+
```javascript
104+
${1:document}.appendChild('${2}');
105+
```
106+
107+
### [ce] createElement
108+
109+
```javascript
110+
${1:document}.createElement('${2:elem}');
111+
```
112+
113+
### [ih] innerHTML
114+
115+
```javascript
116+
${1:document}.innerHTML = '${2}';
117+
```
118+
119+
### [tc] textContent
120+
121+
```javascript
122+
${1:document}.textContent = '${2}';
123+
```
124+
125+
## Attribute
126+
127+
### [ga] getAttribute
128+
129+
```javascript
130+
${1:document}.getAttribute('${2:attr}');
131+
```
132+
133+
### [sa] setAttribute
134+
135+
```javascript
136+
${1:document}.setAttribute('${2:attr}', ${3:value});
137+
```
138+
139+
### [ra] removeAttribute
140+
141+
```javascript
142+
${1:document}.removeAttribute('${2:attr}');
143+
```
144+
145+
## Class
146+
147+
### [ca] classList.add
148+
149+
```javascript
150+
${1:document}.classList.add('${2:class}');
151+
```
152+
153+
### [ra] classList.toggle
154+
155+
```javascript
156+
${1:document}.classList.toggle('${2:class}');
157+
```
158+
159+
### [ra] classList.remove
160+
161+
```javascript
162+
${1:document}.classList.remove('${2:class}');
163+
```
164+
165+
## Roadmap
166+
167+
* Add Node.js snippets
168+
169+
## Contributing
170+
171+
1. Fork it!
172+
2. Create your feature branch: `git checkout -b my-new-feature`
173+
3. Commit your changes: `git commit -m 'Add some feature'`
174+
4. Push to the branch: `git push origin my-new-feature`
175+
5. Submit a pull request :D
176+
177+
## History
178+
179+
* v0.1.0 May 23, 2013
180+
* Added DOM manipulation and console snippets
181+
182+
## License
183+
184+
[MIT License](http://zenorocha.mit-license.org/) © Zeno Rocha

0 commit comments

Comments
 (0)