Skip to content
This repository has been archived by the owner on May 24, 2024. It is now read-only.

Implement Terra Forms #305

Closed
wants to merge 18 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
203 changes: 203 additions & 0 deletions packages/terra-form/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

13 changes: 13 additions & 0 deletions packages/terra-form/NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright 2017 Cerner Innovation, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
25 changes: 25 additions & 0 deletions packages/terra-form/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Terra Form


[![NPM version](http://img.shields.io/npm/v/terra-form.svg)](https://www.npmjs.org/package/terra-form)
[![Build Status](https://travis-ci.org/cerner/terra-core.svg?branch=master)](https://travis-ci.org/cerner/terra-core)

Components for building forms
Copy link
Contributor

@emilyrohrbough emilyrohrbough May 12, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have a more detailed description of what components are available for building a form? I see the other read me doc goes into more depth into it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion, we should provide links to the packages that this module contains as opposed to describing them here. Otherwise, we could risk this page getting rather large when folders like validations are later included.


- [Getting Started](#getting-started)
- [Documentation](https://github.com/cerner/terra-core/tree/master/packages/terra-form/docs)
- [LICENSE](#license)

## Getting Started

- Install from [npmjs](https://www.npmjs.com): `npm install terra-form`

## LICENSE

Copyright 2017 Cerner Innovation, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
37 changes: 37 additions & 0 deletions packages/terra-form/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Terra Form

Components for building forms

## Getting Started

- Install with [npmjs](https://www.npmjs.com):
- `npm install terra-form`
- `yarn add terra-form`

## Usage

Terra has several different form components for building forms.

[ChoiceField](https://github.com/cerner/terra-core/tree/master/packages/terra-form/docs/components/ChoiceField.md)

[Control](https://github.com/cerner/terra-core/tree/master/packages/terra-form/docs/components/Control.md)

[Field](https://github.com/cerner/terra-core/tree/master/packages/terra-form/docs/components/Field.md)

[Input](https://github.com/cerner/terra-core/tree/master/packages/terra-form/docs/components/Input.md)

[MultiChoiceField](https://github.com/cerner/terra-core/tree/master/packages/terra-form/docs/components/MultiChoiceField.md)

[NumberField](https://github.com/cerner/terra-core/tree/master/packages/terra-form/docs/components/NumberField.md)

[Textarea](https://github.com/cerner/terra-core/tree/master/packages/terra-form/docs/components/Textarea.md)

[TextareaField](https://github.com/cerner/terra-core/tree/master/packages/terra-form/docs/components/TextareaField.md)

[TextField](https://github.com/cerner/terra-core/tree/master/packages/terra-form/docs/components/TextField.md)

To use these components, create a React component that contains a form element, and then insert the Terra form components into that form.

The recommended approach for building forms is to stick with the field components that are build for you (ChoiceField, MultiChoiceField, NumberField, Textarea, TextareaField, Field). If you need to create a custom field, the Field, Control, Input, and Textarea components are available for use.

When using input fields, React has two ways of using inputs: controlled or uncontrolled. Controlled maps the value of the input to the state of the component, while uncontrolled does not (https://facebook.github.io/react/docs/uncontrolled-components.html). If you would like to use a controlled input (ideal for forms that need to do validations with JavaScript and send ajax requests), provide a value and an onChange function to the component. If you would like to use an uncontrolled input (ideal for forms that do straight backend requests), provide just a defaultValue into the input **Note: If you provide both a value and defaultValue to the input, React will be confused as to whether you are working with an uncontrolled input or a controlled one. Provide either a value or a defaultValue to the input, but not both.**
Copy link
Contributor

@bjankord bjankord May 8, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's link the first reference of controlled in this paragraph to https://facebook.github.io/react/docs/forms.html#controlled-components and link the first reference on uncontrolled to https://facebook.github.io/react/docs/uncontrolled-components.html

nit: drop the word just in this phrase: provide just a defaultValue into => provide a defaultValue into

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to support both controlled and uncontrolled forms? If we don't need to, I would prefer to go with a single approach so it is easier for a consumer to understand how to use it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will. For some forms, it's been requested that they have no interactions with JavaScript outside of having React render the form. For this case, it's easiest to leave the input as uncontrolled.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For some forms, it's been requested that they have no interactions with JavaScript outside of having React render the form.

Who requested this? I think I agree with @Matt-Butler in that we only support controlled forms.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you are by default passing down props to the input on the *Field components, you will support controlled and uncontrolled with little to no extra work. By the fact, that all of these are dealing with inputs. Consumers need to be be aware of how React handles inputs and that means them being aware of controlled vs uncontrolled inputs.

I seems like the concern here has more to do with the README being confusing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mhemesath It was from Longitudinal plan. They just want to generate forms that they send straight to the backend server.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is the issue that prompted this request. #276

22 changes: 22 additions & 0 deletions packages/terra-form/docs/components/ChoiceField.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Choice Field

Choice field component for rendering radio inputs in standard field structure.

## Usage

```jsx
import React from 'react';
import { ChoiceField } from 'terra-form';

<ChoiceField
label="What State do you live in?"
name="children_present"
value="children_present"
error="This field is required"
help="State Locations help determine what campus to place you at"
required={true}
attrs={{ className: 'healtheintent-application' }}
choices={[{ name: 'Kansas', value: 'ks' }, { name: 'Missouri', value: 'MO' }]}
isInline={false}
/>
```
22 changes: 22 additions & 0 deletions packages/terra-form/docs/components/Control.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Control

A control represents a radio or checkbox widget with a label. Uses the Input component.

## Usage

```jsx
import React from 'react';
import { Control } from 'terra-form';

<Control
type="checkbox"
label="Do you have any Children?"
name="children_present"
value="children_present"
error="This field is required"
help="Families are eligible for family package"
required={true}
attrs={{ className: 'healtheintent-application' }}
isInline={false}
/>
```
24 changes: 24 additions & 0 deletions packages/terra-form/docs/components/Field.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Field

Generic form field component which handles the layout of a standard form field including errors, help text, label, value and widget placement.

## Usage

```jsx
import React from 'react';
import { Field } from 'terra-form';

<Field
type="checkbox"
label="Do you have any Children?"
name="children_present"
value="children_present"
error="This field is required"
help="Families are eligible for family package plans"
required={true}
attrs={{ className: 'healtheintent-application' }}
isInline={false}
>
{this.props.children}
</Field>
```
16 changes: 16 additions & 0 deletions packages/terra-form/docs/components/Input.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Input

Generic input which represents an HTML input element directly.

## Usage

```jsx
import React from 'react';
import { Input } from 'terra-form';

<Input
required={false}
name="foo"
value="bar"
/>
```
21 changes: 21 additions & 0 deletions packages/terra-form/docs/components/MultiChoiceField.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Multi Choice Field

Choice field component for rendering checkbox inputs in standard field structure.

## Usage

```jsx
import React from 'react';
import { MultiChoicefield } from 'terra-form';

<MultiChoicefield
label='Select the programming languages you have experience with'
name="language_experience"
error="This field is required"
help="Note: All checked languages should have at least 3 months experience"
required={true}
choices=[{ name: 'C', value: 'C' }, { name: 'java', value: 'Java' }]
isInline={false}
required={false}
/>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to pre select choices with this API?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like the original tech design called in for passing those in through a values array, but I don't feel like that's the best API. The place that would belong most likely is on this hash

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@StephenEsser thats what the values is for.

```
Loading