-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
151 additions
and
2 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
25 changes: 25 additions & 0 deletions
25
docs/schemaDoc/control-properties-options-properties-cssclass.md
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,25 @@ | ||
| # Untitled string in Control Schema | ||
|
|
||
| ```txt | ||
| https://educorvi.github.io/vue_json_form/schemas/control.schema.json#/properties/options/properties/cssClass | ||
| ``` | ||
|
|
||
| The Controls CSS classes | ||
|
|
||
| | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | ||
| | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------- | | ||
| | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [control.schema.json*](../schemas/control.schema.json "open original schema") | | ||
|
|
||
| ## cssClass Type | ||
|
|
||
| `string` | ||
|
|
||
| ## cssClass Examples | ||
|
|
||
| ```json | ||
| "bg-primary" | ||
| ``` | ||
|
|
||
| ```json | ||
| "bg-info specialpart" | ||
| ``` |
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
25 changes: 25 additions & 0 deletions
25
docs/schemaDoc/layout-properties-options-properties-cssclass.md
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,25 @@ | ||
| # Untitled string in Layout Schema | ||
|
|
||
| ```txt | ||
| https://educorvi.github.io/vue_json_form/schemas/layout.schema.json#/properties/options/properties/cssClass | ||
| ``` | ||
|
|
||
| The Layouts CSS classes | ||
|
|
||
| | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | ||
| | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------- | | ||
| | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [layout.schema.json*](../schemas/layout.schema.json "open original schema") | | ||
|
|
||
| ## cssClass Type | ||
|
|
||
| `string` | ||
|
|
||
| ## cssClass Examples | ||
|
|
||
| ```json | ||
| "bg-primary" | ||
| ``` | ||
|
|
||
| ```json | ||
| "bg-info headerpart" | ||
| ``` |
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,49 @@ | ||
| # Untitled object in Layout Schema | ||
|
|
||
| ```txt | ||
| https://educorvi.github.io/vue_json_form/schemas/layout.schema.json#/properties/options | ||
| ``` | ||
|
|
||
| Additional Options | ||
|
|
||
| | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | ||
| | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------- | | ||
| | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [layout.schema.json*](../schemas/layout.schema.json "open original schema") | | ||
|
|
||
| ## options Type | ||
|
|
||
| `object` ([Details](layout-properties-options.md)) | ||
|
|
||
| # options Properties | ||
|
|
||
| | Property | Type | Required | Nullable | Defined by | | ||
| | :-------------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | [cssClass](#cssclass) | `string` | Optional | cannot be null | [Layout](layout-properties-options-properties-cssclass.md "https://educorvi.github.io/vue_json_form/schemas/layout.schema.json#/properties/options/properties/cssClass") | | ||
|
|
||
| ## cssClass | ||
|
|
||
| The Layouts CSS classes | ||
|
|
||
| `cssClass` | ||
|
|
||
| * is optional | ||
|
|
||
| * Type: `string` | ||
|
|
||
| * cannot be null | ||
|
|
||
| * defined in: [Layout](layout-properties-options-properties-cssclass.md "https://educorvi.github.io/vue_json_form/schemas/layout.schema.json#/properties/options/properties/cssClass") | ||
|
|
||
| ### cssClass Type | ||
|
|
||
| `string` | ||
|
|
||
| ### cssClass Examples | ||
|
|
||
| ```json | ||
| "bg-primary" | ||
| ``` | ||
|
|
||
| ```json | ||
| "bg-info headerpart" | ||
| ``` |
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
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 +1 @@ | ||
| {"$id":"https://educorvi.github.io/vue_json_form/schemas/control.schema.json","$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"Control","description":"Contains a form element, e. g. a text input","properties":{"type":{"type":"string","enum":["Control"]},"scope":{"type":"string","description":"A json pointer referring to the form element in the forms json schema","format":"json-pointer"},"format":{"description":"Format for string fields","type":"string","enum":["time","date","date-time","email","password","search","url","tel","color"]},"options":{"type":"object","title":"Options","description":"Gives multiple options to configure the element","properties":{"label":{"type":"boolean","description":"Defines whether the fields label is activated","default":true},"multi":{"oneOf":[{"type":"boolean"},{"type":"integer"}],"default":false,"description":"If set true, textarea will be shown instead of textfield. \n Alternatively can be set to the number of wanted lines"},"rating":{"type":"boolean","default":false,"description":"If set to true, numberfield will appear as star-rating-field"},"placeholder":{"type":"string","description":"Will be shown as placeholder in form fields, if supported by field"},"drop-placeholder":{"type":"string","description":"Will be shown as placeholder in file upload field when file drag and drop"},"allowMultipleFiles":{"type":"boolean","description":"Allows the upload of multiple files with fileupload"},"acceptedFileType":{"type":"string","description":"The accepted File Types","examples":["image/*","image/jpeg, image/png, image/gif",".jpg, .png, .gif"]},"enumTitles":{"type":"object","title":"Titles for enum","description":"If the text in a enums select field is supposed to differ from the keys, they can be specified as properties of this object. The value in the enum must be used as property name","propertyNames":{"type":"string","minLength":1},"patternProperties":{"":{"type":"string","minLength":1}}},"radiobuttons":{"type":"boolean","description":"If set to true, a group of radiobuttons will be shown instead of the select field","default":false},"stacked":{"type":"boolean","description":"Radiobutton-/Checkbox group will be stacked if set to true","default":false},"buttons":{"title":"Buttons","description":"Render fields that support it (Radiobuttons, Checkboxgroups) as Buttons","oneOf":[{"type":"boolean","description":"set to true, if should be rendered as buttons"},{"$ref":"https://educorvi.github.io/vue_json_form/schemas/variants.schema.json"}]},"switch":{"type":"boolean","title":"Switch(es)","description":"If set to true, the checkbox(-group) it was specified for will be rendered as switch(es)"},"append":{"type":"string","description":"Will be appended to field"},"tags":{"type":"object","description":"Will be rendered as tags-Field","properties":{"enabled":{"type":"boolean"},"variant":{"$ref":"https://educorvi.github.io/vue_json_form/schemas/variants.schema.json"},"pills":{"type":"boolean"}}},"autocomplete":{"type":"string","description":"Specifies what should be autocompleted by the browser. Possible values are listed here: https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete#values"},"textAlign":{"type":"string","enum":["left","right","center","start","end"],"description":"Set the text-align of input fields"}}},"showOn":{"$ref":"https://educorvi.github.io/vue_json_form/schemas/show_on.schema.json"}},"examples":[{"type":"Control","scope":"#/properties/objectInJsonSchema"},{"type":"Control","scope":"#/properties/field","showOn":{"scope":"#/properties/referenceField","type":"EQUALS","referenceValue":"awesomeValue"},"options":{"label":false,"radiobuttons":true,"stacked":true}}],"additionalProperties":false,"required":["type","scope"]} | ||
| {"$id":"https://educorvi.github.io/vue_json_form/schemas/control.schema.json","$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"Control","description":"Contains a form element, e. g. a text input","properties":{"type":{"type":"string","enum":["Control"]},"scope":{"type":"string","description":"A json pointer referring to the form element in the forms json schema","format":"json-pointer"},"format":{"description":"Format for string fields","type":"string","enum":["time","date","date-time","email","password","search","url","tel","color"]},"options":{"type":"object","title":"Options","description":"Gives multiple options to configure the element","properties":{"label":{"type":"boolean","description":"Defines whether the fields label is activated","default":true},"multi":{"oneOf":[{"type":"boolean"},{"type":"integer"}],"default":false,"description":"If set true, textarea will be shown instead of textfield. \n Alternatively can be set to the number of wanted lines"},"rating":{"type":"boolean","default":false,"description":"If set to true, numberfield will appear as star-rating-field"},"placeholder":{"type":"string","description":"Will be shown as placeholder in form fields, if supported by field"},"drop-placeholder":{"type":"string","description":"Will be shown as placeholder in file upload field when file drag and drop"},"allowMultipleFiles":{"type":"boolean","description":"Allows the upload of multiple files with fileupload"},"acceptedFileType":{"type":"string","description":"The accepted File Types","examples":["image/*","image/jpeg, image/png, image/gif",".jpg, .png, .gif"]},"enumTitles":{"type":"object","title":"Titles for enum","description":"If the text in a enums select field is supposed to differ from the keys, they can be specified as properties of this object. The value in the enum must be used as property name","propertyNames":{"type":"string","minLength":1},"patternProperties":{"":{"type":"string","minLength":1}}},"radiobuttons":{"type":"boolean","description":"If set to true, a group of radiobuttons will be shown instead of the select field","default":false},"stacked":{"type":"boolean","description":"Radiobutton-/Checkbox group will be stacked if set to true","default":false},"buttons":{"title":"Buttons","description":"Render fields that support it (Radiobuttons, Checkboxgroups) as Buttons","oneOf":[{"type":"boolean","description":"set to true, if should be rendered as buttons"},{"$ref":"https://educorvi.github.io/vue_json_form/schemas/variants.schema.json"}]},"switch":{"type":"boolean","title":"Switch(es)","description":"If set to true, the checkbox(-group) it was specified for will be rendered as switch(es)"},"append":{"type":"string","description":"Will be appended to field"},"tags":{"type":"object","description":"Will be rendered as tags-Field","properties":{"enabled":{"type":"boolean"},"variant":{"$ref":"https://educorvi.github.io/vue_json_form/schemas/variants.schema.json"},"pills":{"type":"boolean"}}},"autocomplete":{"type":"string","description":"Specifies what should be autocompleted by the browser. Possible values are listed here: https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete#values"},"textAlign":{"type":"string","enum":["left","right","center","start","end"],"description":"Set the text-align of input fields"},"cssClass":{"type":"string","description":"The Controls CSS classes","examples":["bg-primary","bg-info specialpart"]}}},"showOn":{"$ref":"https://educorvi.github.io/vue_json_form/schemas/show_on.schema.json"}},"examples":[{"type":"Control","scope":"#/properties/objectInJsonSchema"},{"type":"Control","scope":"#/properties/field","showOn":{"scope":"#/properties/referenceField","type":"EQUALS","referenceValue":"awesomeValue"},"options":{"label":false,"radiobuttons":true,"stacked":true}}],"additionalProperties":false,"required":["type","scope"]} |
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 +1 @@ | ||
| {"title":"Layout","$schema":"http://json-schema.org/draft-07/schema#","$id":"https://educorvi.github.io/vue_json_form/schemas/layout.schema.json","type":"object","description":"The different Layouts","properties":{"type":{"type":"string","enum":["VerticalLayout","HorizontalLayout","Group"]},"elements":{"title":"Elements","description":"The elements of the layout","type":"array","default":[],"items":{"title":"Layoutelement","oneOf":[{"$ref":"https://educorvi.github.io/vue_json_form/schemas/control.schema.json"},{"$ref":"https://educorvi.github.io/vue_json_form/schemas/layout.schema.json"},{"$ref":"https://educorvi.github.io/vue_json_form/schemas/html.schema.json"},{"$ref":"https://educorvi.github.io/vue_json_form/schemas/divider.schema.json"},{"$ref":"https://educorvi.github.io/vue_json_form/schemas/wizard.schema.json"},{"$ref":"https://educorvi.github.io/vue_json_form/schemas/button.schema.json"}]}},"showOn":{"$ref":"https://educorvi.github.io/vue_json_form/schemas/show_on.schema.json"},"label":{"type":"string"},"$schema":{"type":"string","description":"May contain a schema reference to the uischema"}},"examples":[{"type":"VerticalLayout","elements":[]},{"type":"Group","label":"This is a group","elements":[]}],"additionalProperties":false,"required":["type","elements"]} | ||
| {"title":"Layout","$schema":"http://json-schema.org/draft-07/schema#","$id":"https://educorvi.github.io/vue_json_form/schemas/layout.schema.json","type":"object","description":"The different Layouts","properties":{"type":{"type":"string","enum":["VerticalLayout","HorizontalLayout","Group"]},"elements":{"title":"Elements","description":"The elements of the layout","type":"array","default":[],"items":{"title":"Layoutelement","oneOf":[{"$ref":"https://educorvi.github.io/vue_json_form/schemas/control.schema.json"},{"$ref":"https://educorvi.github.io/vue_json_form/schemas/layout.schema.json"},{"$ref":"https://educorvi.github.io/vue_json_form/schemas/html.schema.json"},{"$ref":"https://educorvi.github.io/vue_json_form/schemas/divider.schema.json"},{"$ref":"https://educorvi.github.io/vue_json_form/schemas/wizard.schema.json"},{"$ref":"https://educorvi.github.io/vue_json_form/schemas/button.schema.json"}]}},"showOn":{"$ref":"https://educorvi.github.io/vue_json_form/schemas/show_on.schema.json"},"label":{"type":"string"},"$schema":{"type":"string","description":"May contain a schema reference to the uischema"},"options":{"description":"Additional Options","type":"object","properties":{"cssClass":{"type":"string","description":"The Layouts CSS classes","examples":["bg-primary","bg-info headerpart"]}}}},"examples":[{"type":"VerticalLayout","elements":[]},{"type":"Group","label":"This is a group","elements":[]}],"additionalProperties":false,"required":["type","elements"]} |