Skip to content

Commit

Permalink
Adding documentation for common metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
andrerpena committed Aug 15, 2016
1 parent d6ba7f7 commit ac902aa
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,17 @@ Now the demo should be available here: [http://localhost:4000/](http://localhost

## Components

### Common metadata

Metadata that is common to most of the components.

Metadata | Description
--- | ---
displayName | The user-friendly name for the field.
component | Which component to use.
readOnly | Whether or not the component should be in read-only state.
help | Additional help so the end-user knows what the field is about.

### TextBox

Specific metadata for the `TextBox` component. Common metadata is not listed.
Expand Down

0 comments on commit ac902aa

Please sign in to comment.