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

Commit ba037e4

Browse files
committed
compiles v0.2.0
1 parent 3b2e097 commit ba037e4

File tree

2 files changed

+151
-3
lines changed

2 files changed

+151
-3
lines changed

README.md

Lines changed: 150 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,159 @@ Javascript rendered input forms.
1212
If you use NPM, `npm install d3plus-form`. Otherwise, download the [latest release](https://github.com/d3plus/d3plus-form/releases/latest). The released bundle supports AMD, CommonJS, and vanilla environments. Create a [custom bundle using Rollup](https://github.com/rollup/rollup) or your preferred bundler. You can also load directly from [d3plus.org](https://d3plus.org):
1313

1414
```html
15-
<script src="https://d3plus.org/js/d3plus-form.v0.1.full.min.js"></script>
15+
<script src="https://d3plus.org/js/d3plus-form.v0.2.full.min.js"></script>
1616
```
1717

1818

1919
## API Reference
20+
### Classes
21+
22+
<dl>
23+
<dt><a href="#Radio">Radio</a> ⇐ <code><a href="https://github.com/d3plus/d3plus-common#BaseClass">BaseClass</a></code></dt>
24+
<dd></dd>
25+
<dt><a href="#Select">Select</a> ⇐ <code><a href="https://github.com/d3plus/d3plus-common#BaseClass">BaseClass</a></code></dt>
26+
<dd></dd>
27+
</dl>
28+
29+
<a name="Radio"></a>
30+
31+
### Radio ⇐ <code>[BaseClass](https://github.com/d3plus/d3plus-common#BaseClass)</code>
32+
**Kind**: global class
33+
**Extends:** <code>[BaseClass](https://github.com/d3plus/d3plus-common#BaseClass)</code>
34+
35+
* [Radio](#Radio) ⇐ <code>[BaseClass](https://github.com/d3plus/d3plus-common#BaseClass)</code>
36+
* [new Radio()](#new_Radio_new)
37+
* [.render()](#Radio.render) ↩︎
38+
* [.checked([*value*])](#Radio.checked) ↩︎
39+
* [.container([*selector*])](#Radio.container) ↩︎
40+
* [.labelStyle([*value*])](#Radio.labelStyle) ↩︎
41+
* [.legend([*value*])](#Radio.legend) ↩︎
42+
* [.legendStyle([*value*])](#Radio.legendStyle) ↩︎
43+
* [.options([*value*])](#Radio.options) ↩︎
44+
* [.radioStyle([*value*])](#Radio.radioStyle) ↩︎
45+
* [.text([*value*])](#Radio.text) ↩︎
46+
* [.value([*value*])](#Radio.value) ↩︎
47+
48+
<a name="new_Radio_new"></a>
49+
50+
#### new Radio()
51+
Creates a set of HTML radio input elements.
52+
53+
<a name="Radio.render"></a>
54+
55+
#### Radio.render() ↩︎
56+
Renders the element to the page.
57+
58+
**Kind**: static method of <code>[Radio](#Radio)</code>
59+
**Chainable**
60+
<a name="Radio.checked"></a>
61+
62+
#### Radio.checked([*value*]) ↩︎
63+
Defines the checked input.
64+
65+
**Kind**: static method of <code>[Radio](#Radio)</code>
66+
**Chainable**
67+
68+
| Param | Type |
69+
| --- | --- |
70+
| [*value*] | <code>function</code> |
71+
72+
<a name="Radio.container"></a>
73+
74+
#### Radio.container([*selector*]) ↩︎
75+
If *selector* is specified, sets the SVG container element to the specified d3 selector or DOM element and returns the current class instance. If *selector* is not specified, returns the current SVG container element, which is `undefined` by default.
76+
77+
**Kind**: static method of <code>[Radio](#Radio)</code>
78+
**Chainable**
79+
80+
| Param | Type |
81+
| --- | --- |
82+
| [*selector*] | <code>String</code> &#124; <code>HTMLElement</code> |
83+
84+
<a name="Radio.labelStyle"></a>
85+
86+
#### Radio.labelStyle([*value*]) ↩︎
87+
Sets the css styles for the <label> element.
88+
89+
**Kind**: static method of <code>[Radio](#Radio)</code>
90+
**Chainable**
91+
92+
| Param | Type |
93+
| --- | --- |
94+
| [*value*] | <code>Object</code> |
95+
96+
<a name="Radio.legend"></a>
97+
98+
#### Radio.legend([*value*]) ↩︎
99+
Creates a <legend> tag for the <select> element.
100+
101+
**Kind**: static method of <code>[Radio](#Radio)</code>
102+
**Chainable**
103+
104+
| Param | Type |
105+
| --- | --- |
106+
| [*value*] | <code>String</code> |
107+
108+
<a name="Radio.legendStyle"></a>
109+
110+
#### Radio.legendStyle([*value*]) ↩︎
111+
Sets the css styles for the <legend> element.
112+
113+
**Kind**: static method of <code>[Radio](#Radio)</code>
114+
**Chainable**
115+
116+
| Param | Type |
117+
| --- | --- |
118+
| [*value*] | <code>Object</code> |
119+
120+
<a name="Radio.options"></a>
121+
122+
#### Radio.options([*value*]) ↩︎
123+
Defines the array of values to be used as <option> tags inside of the <select> element. If no value is passed, the current array is returned.
124+
125+
**Kind**: static method of <code>[Radio](#Radio)</code>
126+
**Chainable**
127+
128+
| Param | Type | Default |
129+
| --- | --- | --- |
130+
| [*value*] | <code>Array</code> | <code>[]</code> |
131+
132+
<a name="Radio.radioStyle"></a>
133+
134+
#### Radio.radioStyle([*value*]) ↩︎
135+
Sets the css styles for the <input type="radio"> elements.
136+
137+
**Kind**: static method of <code>[Radio](#Radio)</code>
138+
**Chainable**
139+
140+
| Param | Type |
141+
| --- | --- |
142+
| [*value*] | <code>Object</code> |
143+
144+
<a name="Radio.text"></a>
145+
146+
#### Radio.text([*value*]) ↩︎
147+
Sets the inner text for each <option> element.
148+
149+
**Kind**: static method of <code>[Radio](#Radio)</code>
150+
**Chainable**
151+
152+
| Param | Type | Default |
153+
| --- | --- | --- |
154+
| [*value*] | <code>function</code> &#124; <code>String</code> | <code>function(d) { return d.text; }</code> |
155+
156+
<a name="Radio.value"></a>
157+
158+
#### Radio.value([*value*]) ↩︎
159+
Sets the value for each <option> element.
160+
161+
**Kind**: static method of <code>[Radio](#Radio)</code>
162+
**Chainable**
163+
164+
| Param | Type | Default |
165+
| --- | --- | --- |
166+
| [*value*] | <code>function</code> | <code>function(d) { return d.value; }</code> |
167+
20168
<a name="Select"></a>
21169

22170
### Select ⇐ <code>[BaseClass](https://github.com/d3plus/d3plus-common#BaseClass)</code>
@@ -158,4 +306,4 @@ Sets the value for each <option> element.
158306

159307

160308

161-
###### <sub>Documentation generated on Tue, 07 Feb 2017 19:45:55 GMT</sub>
309+
###### <sub>Documentation generated on Tue, 28 Feb 2017 16:17:35 GMT</sub>

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "d3plus-form",
3-
"version": "0.1.1",
3+
"version": "0.2.0",
44
"description": "Javascript rendered input forms.",
55
"main": "build/d3plus-form.js",
66
"jsnext:main": "index",

0 commit comments

Comments
 (0)