Skip to content
This repository was archived by the owner on Jan 22, 2018. It is now read-only.

Commit 4194956

Browse files
author
Kamil Kisiela
committed
Add fields documentation
1 parent cb16111 commit 4194956

File tree

1 file changed

+119
-4
lines changed

1 file changed

+119
-4
lines changed

README.md

Lines changed: 119 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,128 @@ angular.module('myAppName', [
2525
```
2626

2727
# Components
28-
_rest of angular-material directive in near future_
28+
29+
Any requests? Add issue!
30+
31+
## Common properties
32+
33+
### label (string)
34+
35+
### theme (string)
36+
37+
```
38+
md-theme attribute
39+
```
2940

3041
## Fields
3142

32-
- input
33-
- checkbox
34-
- select
43+
### input
44+
45+
```json
46+
{
47+
"type": "input",
48+
"key": "firstName",
49+
"templateOptions": {
50+
"type": "text",
51+
"label": "First name",
52+
"theme": "custom"
53+
}
54+
}
55+
```
56+
57+
### textarea
58+
59+
**rows (number, optional)**
60+
61+
```json
62+
{
63+
"type": "textarea",
64+
"key": "bio",
65+
"templateOptions": {
66+
"label": "Biography",
67+
"theme": "custom",
68+
"rows": 5
69+
}
70+
}
71+
```
72+
73+
### radio
74+
75+
**options (array, requred)**
76+
77+
**labelProp (string, optional)**
78+
79+
**valueProp (string, optional)**
80+
81+
```json
82+
{
83+
"type": "radio",
84+
"key": "name",
85+
"templateOptions": {
86+
"label": "Name",
87+
"theme": "custom",
88+
"labelProp": "firstName",
89+
"valueProp": "id",
90+
"options": [
91+
{"firstName": "Sarah", id: 1},
92+
{"firstName": "Jessica", id: 2},
93+
{"firstName": "Parker", id: 3}
94+
]
95+
}
96+
}
97+
```
98+
99+
### select
100+
101+
**options (array, requred)**
102+
103+
**labelProp (string, optional)**
104+
105+
**valueProp (string, optional)**
106+
107+
```json
108+
{
109+
"type": "select",
110+
"key": "name",
111+
"templateOptions": {
112+
"label": "Name",
113+
"theme": "custom",
114+
"labelProp": "firstName",
115+
"valueProp": "id",
116+
"options": [
117+
{"firstName": "Sarah", id: 1},
118+
{"firstName": "Jessica", id: 2},
119+
{"firstName": "Parker", id: 3}
120+
]
121+
}
122+
}
123+
```
124+
125+
### checkbox
126+
127+
```json
128+
{
129+
"type": "checkbox",
130+
"key": "terms",
131+
"templateOptions": {
132+
"label": "Terms and Conditions",
133+
"theme": "custom"
134+
}
135+
}
136+
```
137+
138+
### switch
139+
140+
```json
141+
{
142+
"type": "switch",
143+
"key": "terms",
144+
"templateOptions": {
145+
"label": "Terms and Conditions",
146+
"theme": "custom"
147+
}
148+
}
149+
```
35150

36151
## Wrappers
37152

0 commit comments

Comments
 (0)