This repository has been archived by the owner on Feb 7, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'stage' of github.com:advanced-rest-client/raml-headers-…
…form into stage
- Loading branch information
Showing
4 changed files
with
48 additions
and
6 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
<a name="0.1.1"></a> | ||
## 0.1.1 (2016-12-07) | ||
|
||
|
||
### Update | ||
|
||
* Added missing dependencies ([c3e0ce0bc174052998e8a6df2c13e734d5a55235](https://github.com/advanced-rest-client/raml-headers-form/commit/c3e0ce0bc174052998e8a6df2c13e734d5a55235)) | ||
|
||
|
||
|
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,35 @@ | ||
# `<raml-headers-form>` | ||
[![Build Status](https://travis-ci.org/advanced-rest-client/raml-headers-form.svg?branch=master)](https://travis-ci.org/advanced-rest-client/raml-headers-form) | ||
|
||
# raml-headers-form | ||
|
||
A headers form to be used to rended a form of pre-defined headers with documentation comming | ||
from the RAML definition. | ||
|
||
### Example | ||
``` | ||
<raml-headers-form></raml-headers-form> | ||
``` | ||
``` | ||
var form = document.querySelector('raml-headers-form'); | ||
form.ramlHeaders = []; // Put headers property from the RAML JS parser. | ||
form.addEventListener('value-changed', function(e) { | ||
var value = e.detail.value; | ||
}); | ||
``` | ||
Note: this element mean to use `raml-js-parser` elements. This element transforms parser output | ||
to the one recognizable by this element. | ||
|
||
### Styling | ||
`<raml-headers-form>` provides the following custom properties and mixins for styling: | ||
|
||
Custom property | Description | Default | ||
----------------|-------------|---------- | ||
`--raml-headers-form` | Mixin applied to the element | `{}` | ||
`--raml-headers-form-input-label-color` | Color of the lable of the `paper-input` element. | `rgba(0, 0, 0, 0.38)` | ||
`--raml-headers-form-prodefined-name-color` | Color of the prodefined header name | `rgba(0, 0, 0, 0.87)` | ||
`--raml-headers-form-docs-color` | Color of the description below the input field | `rgba(0, 0, 0, 0.87)` | ||
`--primary-color` | Color of the button to add new header | `--primary-color` | ||
|
||
## TODO | ||
- Remove arc-definitions and place only request headers definitions or instruct to use definitions as an external element | ||
|
||
A headers form to be used to rended a form of pre-defined headers with documentation comming from the RAML definition |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -48,5 +48,5 @@ | |
"test", | ||
"tasks" | ||
], | ||
"version": "0.1.0" | ||
} | ||
"version": "0.1.1" | ||
} |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "raml-headers-form", | ||
"version": "0.1.0", | ||
"version": "0.1.1", | ||
"license": "Apache-2.0 OR CC-BY-4.0", | ||
"description": "A headers form to be used to rended a form of pre-defined headers with documentation comming from the RAML definition", | ||
"devDependencies": { | ||
|
@@ -30,4 +30,4 @@ | |
"url": "https://github.com/advanced-rest-client/raml-headers-form/issues", | ||
"email": "[email protected]" | ||
} | ||
} | ||
} |