This repository was archived by the owner on May 25, 2021. It is now read-only.
Updating readme and changelog #179
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brownhoward
reviewed
Dec 17, 2019
brownhoward
reviewed
Dec 17, 2019
brownhoward
reviewed
Dec 17, 2019
CHANGELOG.md
Outdated
| - TextArea | ||
| - Date / DateTime / Time fields, using [react-datepicker](https://reactdatepicker.com/) | ||
| - Dropdown | ||
| - Checkbox |
Contributor
There was a problem hiding this comment.
Explicitly say this is for a Boolean checkbox, not Tristate?
brownhoward
reviewed
Dec 17, 2019
README.md
Outdated
| **Note**: This is an early preview build of a work-in-progress component and subject to large-scale changes in future releases. | ||
|
|
||
| This component allows you to create a fully functional form, complete with submit, cancel, and validation rules, from a [ShEx](http://shex.io/shex-primer/index.html) Shape. | ||
| This component takes a FormModel (build using the Form Language and [UI ontology](https://www.w3.org/ns/ui#)). A properly formatted FormModel will render a form, complete with constraints. Some things are not yet supported, such as ui:arc links, FormForms, and more. This component is still being improved and worked on. |
Contributor
There was a problem hiding this comment.
It is not really that FormForm is not supposed, it is that ui:Choice and ui:Options are not supported.
brownhoward
reviewed
Dec 17, 2019
README.md
Outdated
| ##### Textbox | ||
|
|
||
| Textboxes are the default input type for each field in a shape. In future versions, there will be a way to determine if you want a textbox vs a textarea based on properties such as maxlength. | ||
| Textboxes are the default input type for each field in a shape, and represented in the FormModel by SingleLineTextFields. It can have common constraints like maxLength, as defined in the Form Language |
Contributor
There was a problem hiding this comment.
Missing sentence period.
brownhoward
reviewed
Dec 17, 2019
README.md
Outdated
|
|
||
| ##### Textarea | ||
|
|
||
| A Textarea is represented in the FormModel by a MultiLineTextField, and similar to textbox has constraints defined by the Form Language |
Contributor
There was a problem hiding this comment.
Missing sentence period.
brownhoward
reviewed
Dec 17, 2019
README.md
Outdated
| | errorCallback | Function | Function that writes the error message to console | Optional. Overrides the existing error callback function. | | ||
| | messageValidation | Object | null | An Object containing an array of error strings. The error strings will be used in most non-validation situations. | | ||
| | autoSaveMode | Boolean | false | Optional. Determines of the form will autosave or have a save/cancel button. Default is save/cancel button. | | ||
| | Props | Type | Default | Description | |
Contributor
There was a problem hiding this comment.
Include sentence periods for each Description.
brownhoward
reviewed
Dec 17, 2019
CHANGELOG.md
Outdated
|
|
||
| ### Added | ||
|
|
||
| - FormModel component |
brownhoward
reviewed
Dec 17, 2019
README.md
Outdated
|
|
||
| ##### Email / Phone field | ||
|
|
||
| Email and Phone Number fields are custom textboxes, similar to the Number fields. They each take a regex pattern from the form model and |
Contributor
There was a problem hiding this comment.
Missing end of sentence "... from the form model and" And what? I'm left in suspense...
Contributor
Author
There was a problem hiding this comment.
Always keep them wanting more
brownhoward
suggested changes
Dec 17, 2019
Contributor
brownhoward
left a comment
brownhoward
left a comment
There was a problem hiding this comment.
Left inline comments.
brownhoward
approved these changes
Dec 18, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.