|
1 | | -# React Native Elements Snippets |
| 1 | +<p align="center"> |
| 2 | + <a href="https://reactnativeelements.com/"> |
| 3 | + <img alt="react-native-elements" src="https://user-images.githubusercontent.com/5962998/65694309-a825f000-e043-11e9-8382-db0dba0851e3.png" width="300"> |
| 4 | + </a> |
| 5 | +</p> |
2 | 6 |
|
3 | | - [](https://github.com/semantic-release/semantic-release) |
| 7 | +<p align="center"> |
| 8 | + Cross Platform <a href="https://reactnative.dev">React Native</a> UI Toolkit |
| 9 | +</p> |
4 | 10 |
|
5 | | - |
| 11 | +</p> |
6 | 12 |
|
7 | | -**Note:** There are two ways to insert these: |
| 13 | +<br /> |
8 | 14 |
|
9 | | -- **Trigger Suggest** (<kbd>⌃</kbd><kbd>Space</kbd> on macOS) and then type in the name; or you can |
10 | | - enable the **Editor: Tab Completion** setting, then type the name of the |
11 | | - snippet and press <kbd>Tab</kbd>. |
12 | | - |
13 | | -## Features |
14 | | - |
15 | | -- Works in JS/X and TSX |
16 | | -- Automatically adds missing imports when a snippet is inserted (as long as it succeeds in parsing the entire file) |
17 | | -- Supports `React Native Elements Universe` Package |
18 | | - |
19 | | -## Installation |
20 | | - |
21 | | -As in any Visual Studio Code Extension you have several options to install: |
22 | | - |
23 | | -- Enter the Visual Studio Code Marketplace, search for `React Native Elements Snippets` (or enter directly on the extension page) and click on Install button. |
24 | | - |
25 | | -- Inside Visual Studio Code, enter in the Extension panel, search for `React Native Elements Snippets` and click on Install button |
26 | | - |
27 | | -- Run the following command in the Command Palette: |
28 | | - |
29 | | -> ext install rne.snippets |
30 | | -
|
31 | | -## Snippets |
32 | | - |
33 | | -<!-- snippets --> |
34 | | - |
35 | | -- [`rneAvatar`](#rneavatar) |
36 | | -- [`rneAvatarBadge`](#rneavatarbadge) |
37 | | -- [`rneBadge`](#rnebadge) |
38 | | -- [`rneBadgeMini`](#rnebadgemini) |
39 | | -- [`rneBottomSheet`](#rnebottomsheet) |
40 | | -- [`rneButton`](#rnebutton) |
41 | | -- [`rneButtonGroup`](#rnebuttongroup) |
42 | | -- [`rneButtonIcon`](#rnebuttonicon) |
43 | | -- [`rneButtonType`](#rnebuttontype) |
44 | | -- [`rneCard`](#rnecard) |
45 | | -- [`rneCheckBox`](#rnecheckbox) |
46 | | -- [`rneChip`](#rnechip) |
47 | | -- [`rneChipIcon`](#rnechipicon) |
48 | | -- [`rneDivider`](#rnedivider) |
49 | | -- [`rneFAB`](#rnefab) |
50 | | -- [`rneIcon`](#rneicon) |
51 | | -- [`rneImage`](#rneimage) |
52 | | -- [`rneLinearProgress`](#rnelinearprogress) |
53 | | -- [`rneLinearProgressIndeterminate`](#rnelinearprogressindeterminate) |
54 | | -- [`rneRadio`](#rneradio) |
55 | | -- [`rneSearchBar`](#rnesearchbar) |
56 | | -- [`rneSlider`](#rneslider) |
57 | | -- [`rneSpeedDial`](#rnespeeddial) |
58 | | -- [`rneSpeedDialAction`](#rnespeeddialaction) |
59 | | -- [`rneText`](#rnetext) |
60 | | -- [`rneuCircularSlider`](#rneucircularslider) |
61 | | - |
62 | | -### `rneAvatar` |
63 | | - |
64 | | -#### Avatar Component |
65 | | - |
66 | | -```javascript |
67 | | -<Avatar title="$0" size="${1|small,medium,large,xlarge|}" rounded={${2|true,false|}}/> |
68 | | -``` |
69 | | - |
70 | | -### `rneAvatarBadge` |
71 | | - |
72 | | -#### Avatar with Badge Component |
73 | | - |
74 | | -```javascript |
75 | | -<View> |
76 | | - <Avatar |
77 | | - source={{ |
78 | | - uri: "$1", |
79 | | - }} |
80 | | - size="${2|small,medium,large,xlarge|}" |
81 | | - /> |
82 | | - <Badge |
83 | | - status="${3|success,error,primary,warning|}" |
84 | | - containerStyle={{ position: "absolute", top: -4, right: -4 }} |
85 | | - /> |
86 | | -</View> |
87 | | -``` |
88 | | - |
89 | | -### `rneBadge` |
90 | | - |
91 | | -#### Badge Component |
92 | | - |
93 | | -```javascript |
94 | | -<Badge value="$1" status="${2|success,error,primary,warning|}" $0 /> |
95 | | -``` |
96 | | - |
97 | | -### `rneBadgeMini` |
98 | | - |
99 | | -#### Mini Badge Component |
100 | | - |
101 | | -```javascript |
102 | | -<Badge status="${1|success,error,primary,warning|}" /> |
103 | | -``` |
104 | | - |
105 | | -### `rneBottomSheet` |
106 | | - |
107 | | -#### Bottom Sheet Component |
108 | | - |
109 | | -```javascript |
110 | | -<BottomSheet isVisible={$1} containerStyle={{ backgroundColor: "$2" }}> |
111 | | - $0 |
112 | | -</BottomSheet> |
113 | | -``` |
114 | | - |
115 | | -### `rneButton` |
116 | | - |
117 | | -#### Simple Button Component |
118 | | - |
119 | | -```javascript |
120 | | -<Button onPress={$1} title={$2} $0 /> |
121 | | -``` |
122 | | - |
123 | | -### `rneButtonGroup` |
124 | | - |
125 | | -#### Button Group Component |
126 | | - |
127 | | -```javascript |
128 | | -<ButtonGroup onPress={$1} selectedIndex={$2} buttons={[$3]} /> |
129 | | -``` |
130 | | - |
131 | | -### `rneButtonIcon` |
132 | | - |
133 | | -#### Button with Icon Component |
134 | | - |
135 | | -```javascript |
136 | | -<Button |
137 | | - onPress={$1}${2: |
138 | | - iconPosition="${3|left,right,bottom,top|}"} |
139 | | - icon={{name:'$4',color:'$5'}} |
140 | | - title={$6} |
141 | | - $0/> |
142 | | -``` |
143 | | - |
144 | | -### `rneButtonType` |
145 | | - |
146 | | -#### Button with types Component |
147 | | - |
148 | | -```javascript |
149 | | -<Button onPress={$1} type="${2|solid,clear,outline|}" title={$3} $0 /> |
150 | | -``` |
151 | | - |
152 | | -### `rneCard` |
153 | | - |
154 | | -#### Basic Card Component |
155 | | - |
156 | | -```javascript |
157 | | -<Card> |
158 | | - <Card.Title>$1</Card.Title> |
159 | | - ${2: |
160 | | - <Card.Divider/>} |
161 | | - <Card.Image source={$3}> |
162 | | - ${4: |
163 | | - <Text style={{marginBottom: 10}}> |
164 | | - $5 |
165 | | - </Text> |
166 | | - } |
167 | | - $6 |
168 | | - </Card.Image> |
169 | | -</Card> |
170 | | -``` |
171 | | - |
172 | | -### `rneCheckBox` |
173 | | - |
174 | | -#### CheckBox Component |
175 | | - |
176 | | -```javascript |
177 | | -<CheckBox |
178 | | - title="$1" |
179 | | - iconType="${2|material,material-community,simple-line-icon,zocial,font-awesome,octicon,ionicon,foundation,evilicon,entypo,antdesign,font-awesome-5|}" |
180 | | - checkedIcon="$3" |
181 | | - uncheckedIcon="$4" |
182 | | - checkedColor="$5" |
183 | | - checked={$6} |
184 | | -/> |
185 | | -``` |
186 | | - |
187 | | -### `rneChip` |
188 | | - |
189 | | -#### Simple Chip Component |
190 | | - |
191 | | -```javascript |
192 | | -<Chip title="$1" type="${2|solid,outline|}" /> |
193 | | -``` |
194 | | - |
195 | | -### `rneChipIcon` |
196 | | - |
197 | | -#### Chip with Icon Component |
198 | | - |
199 | | -```javascript |
200 | | -<Chip |
201 | | - title="$1" |
202 | | - type="${2|solid,outline|}" |
203 | | - icon={{ |
204 | | - name: "$3", |
205 | | - type: "$4", |
206 | | - color: "$5", |
207 | | - }} |
208 | | -/> |
209 | | -``` |
210 | | - |
211 | | -### `rneDivider` |
212 | | - |
213 | | -#### Divider Component |
214 | | - |
215 | | -```javascript |
216 | | -<Divider /> |
217 | | -``` |
218 | | - |
219 | | -### `rneFAB` |
220 | | - |
221 | | -#### Floating Action Button Component |
222 | | - |
223 | | -```javascript |
224 | | -<FAB title="$1" placement="${2|left,right|}" size="${3|small,large|}" $0 /> |
225 | | -``` |
226 | | - |
227 | | -### `rneIcon` |
228 | | - |
229 | | -#### Icon Component |
230 | | - |
231 | | -```javascript |
232 | | -<Icon |
233 | | - name="$1" |
234 | | - type="${2|material,material-community,simple-line-icon,zocial,font-awesome,octicon,ionicon,foundation,evilicon,entypo,antdesign,font-awesome-5|}" |
235 | | - size={$3} |
236 | | - color="$4" |
237 | | - $0 |
238 | | -/> |
239 | | -``` |
240 | | - |
241 | | -### `rneImage` |
242 | | - |
243 | | -#### Image Component |
244 | | - |
245 | | -```javascript |
246 | | -<Image |
247 | | - source={{ uri: '$1' }} |
248 | | - style={{ width: $2, height: $3 }} |
249 | | - ${4:PlaceholderContent={$5}} |
250 | | -/> |
251 | | -``` |
252 | | - |
253 | | -### `rneLinearProgress` |
254 | | - |
255 | | -#### Linear Progress Component |
256 | | - |
257 | | -```javascript |
258 | | -<LinearProgress |
259 | | - color="${1|primary,secondary|}" |
260 | | - variant="determinate" |
261 | | - value={$2} |
262 | | - $0 |
263 | | -/> |
264 | | -``` |
265 | | - |
266 | | -### `rneLinearProgressIndeterminate` |
267 | | - |
268 | | -#### Linear Progress indeterminate variant Component |
269 | | - |
270 | | -```javascript |
271 | | -<LinearProgress color="${1|primary,secondary|}" $0 /> |
272 | | -``` |
273 | | - |
274 | | -### `rneRadio` |
275 | | - |
276 | | -#### CheckBox Component |
277 | | - |
278 | | -```javascript |
279 | | -<CheckBox |
280 | | - title="$1" |
281 | | - iconType="material" |
282 | | - checkedIcon="radio-button-checked" |
283 | | - uncheckedIcon="radio-button-unchecked" |
284 | | - checkedColor="$2" |
285 | | - checked={$3} |
286 | | -/> |
287 | | -``` |
288 | | - |
289 | | -### `rneSearchBar` |
290 | | - |
291 | | -#### Search Bar Component |
292 | | - |
293 | | -```javascript |
294 | | -<SearchBar placeholder="$1" onChangeText={$2} value={$3} $0 /> |
295 | | -``` |
296 | | - |
297 | | -### `rneSlider` |
298 | | - |
299 | | -#### Slider Component |
300 | | - |
301 | | -```javascript |
302 | | -<Slider |
303 | | - value={$1} |
304 | | - onValueChange={$2} |
305 | | - maximumValue={$3} |
306 | | - minimumValue={$4} |
307 | | - thumbProps={{ $5 }} |
308 | | -/> |
309 | | -``` |
310 | | - |
311 | | -### `rneSpeedDial` |
312 | | - |
313 | | -#### Speed Dial Wrapper Component |
314 | | - |
315 | | -```javascript |
316 | | -<SpeedDial |
317 | | - isOpen={$1} |
318 | | - onOpen={$2} |
319 | | - onClose={$3} |
320 | | - icon={{ name: "$4" }} |
321 | | - openIcon={{ name: "$5" }} |
322 | | -> |
323 | | - $0 |
324 | | -</SpeedDial> |
325 | | -``` |
326 | | - |
327 | | -### `rneSpeedDialAction` |
328 | | - |
329 | | -#### Speed Dial Action Component |
330 | | - |
331 | | -```javascript |
332 | | -<SpeedDial.Action icon={{ name: "$1" }} title="$2" onPress={$3} /> |
333 | | -``` |
334 | | - |
335 | | -### `rneText` |
336 | | - |
337 | | -#### Text Component |
338 | | - |
339 | | -```javascript |
340 | | -<Text ${1|h1,h2,h3,h4,h5,h6|} $1styles={{$2}}> |
341 | | - $0 |
342 | | -</Text> |
343 | | -``` |
344 | | - |
345 | | -### `rneuCircularSlider` |
346 | | - |
347 | | -#### Universal Circular Slider Component |
348 | | - |
349 | | -```javascript |
350 | | -<CircularSliderUniverse value={$1} onChange={$2} showThumbText /> |
351 | | -``` |
352 | | - |
353 | | -<!-- snippetsend --> |
| 15 | + |
0 commit comments