Skip to content

Commit 9cc69b5

Browse files
chore: updated reference.md and README.md
1 parent a230584 commit 9cc69b5

File tree

6 files changed

+418
-178
lines changed

6 files changed

+418
-178
lines changed

CHANGELOG.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
# Change Log
22

3-
## v0.1.1 (2020-3-18)
3+
## v0.1.2 (2020-3-18)
44

5-
- Initial release
5+
### Added
6+
7+
- more demos and exampls in reference .md
8+
- updated README
9+
- removed snippet in keywords and added html
10+
11+
### Changes
12+
13+
- remove typos in CHANGELOG
14+
15+
## v0.1.1 (2020-3-18)
616

717
### Fixes
818

README.md

Lines changed: 44 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,50 @@
22

33
**Updated for Nativescript v6.4.0 and Angular v9.0.0 release**
44

5-
This extension adds all HTML Nativescript UI Components, Layouts and Gestures snippets.
5+
This extension adds all Nativescript UI Components, Layouts and Gestures snippets in your HTML.
66

77
## Features
88

9-
* Default syntax - Plain Nativescript tag.
10-
* Property syntax - Includes all properties from Angular Nativescript [documentation].
11-
* Complete syntax - Includes all properties, all events and documentation.
9+
* Default syntax (Plain Nativescript tag)
10+
* Property syntax (Includes all element properties)
11+
* Complete syntax (Includes all element properties, events and documentation)
1212
* Layout snippets
1313
* Gesture snippets
1414
* System Icon snippets
1515

16-
### Description
16+
For more examples and demo, [see here][snippet-reference].
1717

18-
| | snippet | entered by user | output | description |
19-
| --------------- | ---------------- | --------- | -------------------------- | -----------------------------------------|
20-
| default | `ns-button` | `nsbutt` | `<Button></Button>` | plain |
21-
| property (prop) | `ns-button-prop` | `nsbutpr` | with *prop | With all properties |
22-
| complete (comp) | `ns-button-comp` | `nsbu-c` | with *prop, *events, *docs | All properties, events and documentation |
23-
| layout snippets | `ns-dock-layout-snippet-2` | `nsdocnip2` | [snippet 2] | Sample snippet from [site docs]. |
24-
| gestures | `ns-tap` | `nstap` | `(tap)=""` | Gesture Snippets |
25-
| setting icon | `ns-icon-stop` | `nsicost` | `14` | [Setting Icon] snippets |
18+
## Syntax
2619

27-
For complete snippet reference and more examples [check this].
20+
| Suffix | Description | Output |
21+
| ------------------- | -------------- | --------------------------------------- |
22+
| `-prop` | property | + all element properties |
23+
| `-comp` | complete | + all element properties and events |
24+
| `-snippet-[number]` | layout snippet | Layout snippets available in site docs |
2825

29-
### `ns-button`: In Action
26+
## Usage
27+
28+
| | snippet | entered by user | output | description |
29+
| --------------- | ---------------- | --------- | --------------------------- | ------------------------------------- |
30+
| default | `ns-button` | `nsbutt` | `<Button></Button>` | Plain tag |
31+
| property (prop) | `ns-button-prop` | `nsbutpr` | with *props | + All properties |
32+
| complete (comp) | `ns-button-comp` | `nsbu-c` | with *props, *events, *docs | + All properties, events and API docs |
33+
| layout snippets | `ns-dock-layout-snippet-2` | `nsdocnip2` | see below | Sample snippets from [site docs]. |
34+
| gestures | `ns-tap` | `nstap` | `(tap)=""` | Gesture Snippets |
35+
| setting icon | `ns-icon-stop` | `nsicost` | `14` | [Setting Icon] snippets |
36+
37+
### In Action: `ns-dock-layout-snippet-2`
38+
39+
``` html
40+
<DockLayout width="210" height="210" backgroundColor="lightgray" stretchLastChild="true">
41+
<Label text="left" dock="left" backgroundColor="red"></Label>
42+
<Label text="top" dock="top" backgroundColor="green"></Label>
43+
<Label text="right" dock="right" backgroundColor="blue"></Label>
44+
<Label text="bottom" dock="bottom" backgroundColor="yellow"></Label>
45+
</DockLayout>
46+
```
47+
48+
### In Action: `ns-button`
3049

3150
#### Default output
3251

@@ -64,24 +83,17 @@ layoutChanged Emitted when the layout bounds of a view changes due to layout pro
6483
-->
6584
```
6685

67-
### `ns-dock-layout-snippet-2`: In Action
86+
## Demo
6887

69-
``` html
70-
<DockLayout width="210" height="210" backgroundColor="lightgray" stretchLastChild="true">
71-
<Label text="left" dock="left" backgroundColor="red"></Label>
72-
<Label text="top" dock="top" backgroundColor="green"></Label>
73-
<Label text="right" dock="right" backgroundColor="blue"></Label>
74-
<Label text="bottom" dock="bottom" backgroundColor="yellow"></Label>
75-
</DockLayout>
76-
```
88+
**HTML snippet `ns-text-field` in action; _default_, _property_ (prop) and _complete_ (comp) syntax demo.**
7789

78-
### Demo
90+
![nativescript-angular-html-snippet-demo](images/playback.gif "Nativescript: Angular HTML Snippets demo")
7991

80-
HTML snippet `ns-text-field` in action; _default_, _property_ (prop) and _complete_ (comp) syntax demo.
92+
## Snippets
8193

82-
![nativescript-angular-html-snippet-demo](images/playback.gif "Nativescript: Angular HTML Snippets demo")
94+
For complete references examples and demo, [see here][snippet-reference].
8395

84-
### Snippets: User Interface > Layouts
96+
### User Interface > Layouts
8597

8698
* ns-absolute-layout
8799
* ns-dock-layout
@@ -90,7 +102,7 @@ HTML snippet `ns-text-field` in action; _default_, _property_ (prop) and _comple
90102
* ns-wrap-layout
91103
* ns-flexbox-layout
92104

93-
### Snippets: User Interface > Components
105+
### User Interface > Components
94106

95107
* ns-actionbar
96108
* ns-actionbarextension
@@ -124,7 +136,7 @@ HTML snippet `ns-text-field` in action; _default_, _property_ (prop) and _comple
124136
* ns-time-picker
125137
* ns-web-view
126138

127-
### Snippets: Gestures
139+
### Gestures
128140

129141
| Snippet | Output |
130142
|----------------|------------------|
@@ -137,7 +149,7 @@ HTML snippet `ns-text-field` in action; _default_, _property_ (prop) and _comple
137149
| `ns-rotation` | `(rotation)=""` |
138150
| `ns-touch` | `(touch)=""` |
139151

140-
### Snippets: Setting Icons
152+
### Setting Icons
141153

142154
| Snippet | Output |
143155
|------------------|--------|
@@ -190,7 +202,7 @@ See [CHANGELOG] for more information.
190202
MIT
191203

192204
[Link]: https://github.com/ElecTreeFrying/nativescript-angular-html-snippets/blob/master/reference.md
193-
[check this]: https://github.com/ElecTreeFrying/nativescript-angular-html-snippets/blob/master/reference.md
205+
[snippet-reference]: https://github.com/ElecTreeFrying/nativescript-angular-html-snippets/blob/master/reference.md
194206
[documentation]: https://docs.nativescript.org/angular/start/introduction
195207
[Setting Icon]: https://docs.nativescript.org/angular/ui/action-bar#setting-icons
196208
[snippet 2]: https://docs.nativescript.org/angular/ui/layouts/layout-containers#docklayout

images/demo1.gif

797 KB
Loading

images/demo2.gif

1.87 MB
Loading

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"email": "jjgermitano@gmail.com"
77
},
88
"displayName": "Nativescript: Angular HTML Snippets",
9-
"description": "This extension adds all HTML Nativescript UI Components, Layouts and Gestures snippets.",
9+
"description": "This extension adds all Nativescript UI Components, Layouts and Gestures snippets in your HTML.",
1010
"version": "0.1.1",
1111
"icon": "images/ns-ng.png",
1212
"categories": [
@@ -16,7 +16,7 @@
1616
"nativescript",
1717
"snippets",
1818
"anuglar",
19-
"snipet"
19+
"html"
2020
],
2121
"galleryBanner": {
2222
"color": "#494949",

0 commit comments

Comments
 (0)