Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
twisty committed Aug 11, 2017
2 parents e43fb3b + 9fbf281 commit e0bfba6
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 14 deletions.
14 changes: 1 addition & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,6 @@

`formsy-react-components` is a selection of React components that render form elements for use in a [formsy-react](https://github.com/christianalfoni/formsy-react) form.

The form components included are:

* `<Checkbox>`
* `<CheckboxGroup>`
* `<File>`
* `<Input>`
* `<RadioGroup>`
* `<Select>`
* `<Textarea>`

For convenience, we also ship a `<Form>` component that wraps `formst-react`’s `<Form>` component and allows you to define some common props that will be picked-up by child components in the form.

The components render markup to be quickly included in a [Bootstrap 3 form](http://getbootstrap.com/css/#forms). This includes a `<label>`, [help text](http://getbootstrap.com/css/#forms-help-text), and some [validation styling](http://getbootstrap.com/css/#forms-control-validation) tied to formsy’s validation state and validation messages.

## Install
Expand Down Expand Up @@ -63,5 +51,5 @@ const MyForm = (props) => {

Documentation is a work in progress!

* For a working code example, visit the [Playground](http://twisty.github.io/formsy-react-components/playground/), then examine the [source](https://github.com/twisty/formsy-react-components/tree/19c0577ecda7e6b3452c85aa31a7170b34b87709/playground).
* For a working code example, visit the [Playground](http://twisty.github.io/formsy-react-components/playground/), then examine the [source](https://github.com/twisty/formsy-react-components/tree/master/examples/playground).
* There is some information in the [Wiki](https://github.com/twisty/formsy-react-components/wiki).
17 changes: 17 additions & 0 deletions docs/components/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Components

**Note:** Docs are in-progress. Have a look at the [examples](https://github.com/twisty/formsy-react-components/tree/master/examples) to see how things work.

The components included are:

* `<Checkbox>`
* `<CheckboxGroup>`
* [`<File>`](file.md)
* `<Input>`
* `<RadioGroup>`
* `<Select>`
* `<Textarea>`

---

For convenience, we also ship a `<Form>` component that wraps `formsy-react`’s `<Form>` component and allows you to define some common props that will be picked-up by child components in the form.
2 changes: 1 addition & 1 deletion docs/layouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The horizontal layout aims to mirror the [Bootstrap horizontal form layout](http

This layout requires that the enclosing form has the `form-horizontal` classname applied.

The default classes are `col-sm-3` for the labels, and `col-sm-9` for the element. It is possible to modify these classes, see [Modifying CSS class names](class-names.md).
The default classes are `col-sm-3` for the labels, and `col-sm-9` for the element. It is possible to modify these classes, see [Modifying CSS class names](css-classes.md).

## Vertical layout

Expand Down

0 comments on commit e0bfba6

Please sign in to comment.