Skip to content

Commit 41dd18f

Browse files
authored
Merge pull request #7 from andrerpena/master
Adding some documentation
2 parents b73979b + 0b4d04e commit 41dd18f

File tree

2 files changed

+84
-2
lines changed

2 files changed

+84
-2
lines changed

README.md

Lines changed: 83 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,86 @@
22

33
[![NPM](https://nodei.co/npm/redux-autoform-bootstrap-ui.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/redux-autoform-bootstrap-ui/) [![NPM](https://nodei.co/npm-dl/redux-autoform-bootstrap-ui.png?months=9&height=3)](https://nodei.co/npm/redux-autoform-bootstrap-ui/)
44

5-
Bootstrap UI extension for redux-autoform
5+
Bootstrap UI for [redux-autoform](https://github.com/redux-autoform/redux-autoform)
6+
7+
> Be patient. This documentation is still under construction. Pull-requests are welcome.
8+
9+
Components
10+
---
11+
12+
###TextBox###
13+
14+
15+
Specific metadata for the `TextBox` component. Common metadata is not listed.
16+
17+
Metadata | Description
18+
--- | ---
19+
placeholder | The text that should be displayed as a hint when there's no value.
20+
addonBefore | The text that should be added-on before the component.
21+
addonAfter | The text that should be added-on after the component.
22+
23+
[TextBox demo](http://gearz-lab.github.io/redux-autoform/demo.html?preset=componentsTextBox)
24+
25+
###TextArea
26+
---
27+
28+
Specific metadata for the `TextBox` component. Common metadata is not listed.
29+
30+
Metadata | Description
31+
--- | ---
32+
placeholder | The text that should be displayed as a hint when there's no value.
33+
addonBefore | The text that should be added-on before the component.
34+
addonAfter | The text that should be added-on after the component.
35+
rows | The number of rows.
36+
37+
[TextArea demo](http://gearz-lab.github.io/redux-autoform/demo.html?preset=componentsTextArea)
38+
39+
###CheckBox
40+
---
41+
42+
[Checkbox demo](http://gearz-lab.github.io/redux-autoform/demo.html?preset=componentsCheckbox).
43+
44+
###Select
45+
---
46+
47+
Specific metadata for the `Select` component. Common metadata is not listed.
48+
49+
Metadata | Description
50+
--- | ---
51+
options | The options to display. Options are an array of objects with two properties: **value**: The actual value that is stored in the model. **text**: What is displayed to the user
52+
53+
[Select demo](http://gearz-lab.github.io/redux-autoform/demo.html?preset=componentsSelect).
54+
55+
###Lookup
56+
---
57+
58+
Specific metadata for the `Lookup` component. Common metadata is not listed.
59+
60+
Metadata | Description
61+
--- | ---
62+
options | The options to display. Options are an array of objects with two properties: **value**: The actual value that is stored in the model. **text**: What is displayed to the user
63+
64+
[Lookup demo](http://gearz-lab.github.io/redux-autoform/demo.html?preset=componentsLookup).
65+
66+
###DateTimePicker
67+
---
68+
69+
###Specific metadata for the `DateTimePicker` component. Common metadata is not listed.
70+
71+
Metadata | Description
72+
--- | ---
73+
format | Any format supported by [Moment.js](http://momentjs.com/docs/#/parsing/string-format/). Defaults to your locale configuration. Make sure you have it properly configured.
74+
75+
76+
[DateTimePicker demo](http://gearz-lab.github.io/redux-autoform/demo.html?preset=componentsDateTimePicker).
77+
78+
79+
##Third party
80+
81+
82+
The `DefaultComponentFactory` relies on third-party components. Here's the list:
83+
84+
- [redux-form](https://github.com/erikras/redux-form/).
85+
- [react-bootstrap](http://react-bootstrap.github.io/).
86+
- [react-select](https://github.com/JedWatson/react-select).
87+
- [react-widgets](https://github.com/jquense/react-widgets).

demo/components/LiveSchemaEditor.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ class LiveSchemaEditor extends Component {
134134
<div className='row'>
135135
<div className="col-md-12">
136136
<h2>redux-autoform-bootstrap-ui demo {psjon.version} <Badge>Ctrl + H = Redux DevTools</Badge>
137-
<a className="pull-right" target="_blank" href="https://github.com/gearz-lab/redux-autoform"
137+
<a className="pull-right" target="_blank" href="https://github.com/redux-autoform/redux-autoform"
138138
style={{color: 'black'}}>
139139
<i className="fa fa-github" aria-hidden="true"/>
140140
</a>

0 commit comments

Comments
 (0)