Skip to content

Added tooltip support in schema properties. #521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added tooltip support in schema properties. #521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions examples/basic_person.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"name": {
"type": "string",
"description": "First and Last name",
"tooltip": "First and last name of the simple person",
"minLength": 4
},
"age": {
Expand Down
1 change: 1 addition & 0 deletions examples/person.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"title": "Location",
"properties": {
"city": {
"tooltip": "this is a tooltip",
"type": "string"
},
"state": {
Expand Down
3 changes: 2 additions & 1 deletion src/editors/array/selectize.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@ JSONEditor.defaults.editors.arraySelectize = JSONEditor.AbstractEditor.extend({
this.description = this.theme.getDescription(this.schema.description);
}

if(this.schema.tooltip) this.tooltip = this.schema.tooltip;
this.input = document.createElement('select');
this.input.setAttribute('multiple', 'multiple');

var group = this.theme.getFormControl(this.title, this.input, this.description);
var group = this.theme.getFormControl(this.title, this.input, this.description, this.tooltip);

this.container.appendChild(group);
this.container.appendChild(this.error_holder);
Expand Down
3 changes: 2 additions & 1 deletion src/editors/base64.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ JSONEditor.defaults.editors.base64 = JSONEditor.AbstractEditor.extend({
build: function() {
var self = this;
this.title = this.header = this.label = this.theme.getFormInputLabel(this.getTitle());
if(this.schema.tooltip) this.tooltip = this.schema.tooltip;

// Input that holds the base64 string
this.input = this.theme.getFormInputField('hidden');
Expand Down Expand Up @@ -37,7 +38,7 @@ JSONEditor.defaults.editors.base64 = JSONEditor.AbstractEditor.extend({
this.preview = this.theme.getFormInputDescription(this.schema.description);
this.container.appendChild(this.preview);

this.control = this.theme.getFormControl(this.label, this.uploader||this.input, this.preview);
this.control = this.theme.getFormControl(this.label, this.uploader||this.input, this.preview, this.tooltip);
this.container.appendChild(this.control);
},
refreshPreview: function() {
Expand Down
3 changes: 2 additions & 1 deletion src/editors/checkbox.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ JSONEditor.defaults.editors.checkbox = JSONEditor.AbstractEditor.extend({
}
if(this.schema.description) this.description = this.theme.getFormInputDescription(this.schema.description);
if(this.options.compact) this.container.className += ' compact';
if(this.schema.tooltip) this.tooltip = this.schema.tooltip;

this.input = this.theme.getCheckbox();
this.control = this.theme.getFormControl(this.label, this.input, this.description);
this.control = this.theme.getFormControl(this.label, this.input, this.description, this.tooltip);

if(this.schema.readOnly || this.schema.readonly) {
this.always_disabled = true;
Expand Down
5 changes: 3 additions & 2 deletions src/editors/multiselect.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ JSONEditor.defaults.editors.multiselect = JSONEditor.AbstractEditor.extend({
var self = this, i;
if(!this.options.compact) this.header = this.label = this.theme.getFormInputLabel(this.getTitle());
if(this.schema.description) this.description = this.theme.getFormInputDescription(this.schema.description);
if(this.schema.tooltip) this.tooltip = this.schema.tooltip;

if((!this.schema.format && this.option_keys.length < 8) || this.schema.format === "checkbox") {
this.input_type = 'checkboxes';
Expand All @@ -31,7 +32,7 @@ JSONEditor.defaults.editors.multiselect = JSONEditor.AbstractEditor.extend({
this.inputs[this.option_keys[i]] = this.theme.getCheckbox();
this.select_options[this.option_keys[i]] = this.inputs[this.option_keys[i]];
var label = this.theme.getCheckboxLabel(this.option_keys[i]);
this.controls[this.option_keys[i]] = this.theme.getFormControl(label, this.inputs[this.option_keys[i]]);
this.controls[this.option_keys[i]] = this.theme.getFormControl(label, this.inputs[this.option_keys[i]], null, null);
}

this.control = this.theme.getMultiCheckboxHolder(this.controls,this.label,this.description);
Expand All @@ -51,7 +52,7 @@ JSONEditor.defaults.editors.multiselect = JSONEditor.AbstractEditor.extend({
this.input.disabled = true;
}

this.control = this.theme.getFormControl(this.label, this.input, this.description);
this.control = this.theme.getFormControl(this.label, this.input, this.description, this.tooltip);
}

this.container.appendChild(this.control);
Expand Down
3 changes: 2 additions & 1 deletion src/editors/select.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ JSONEditor.defaults.editors.select = JSONEditor.AbstractEditor.extend({
var self = this;
if(!this.options.compact) this.header = this.label = this.theme.getFormInputLabel(this.getTitle());
if(this.schema.description) this.description = this.theme.getFormInputDescription(this.schema.description);
if(this.schema.tooltip) this.tooltip = this.schema.tooltip;

if(this.options.compact) this.container.className += ' compact';

Expand All @@ -172,7 +173,7 @@ JSONEditor.defaults.editors.select = JSONEditor.AbstractEditor.extend({
self.onInputChange();
});

this.control = this.theme.getFormControl(this.label, this.input, this.description);
this.control = this.theme.getFormControl(this.label, this.input, this.description, this.tooltip);
this.container.appendChild(this.control);

this.value = this.enum_values[0];
Expand Down
3 changes: 2 additions & 1 deletion src/editors/selectize.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ JSONEditor.defaults.editors.selectize = JSONEditor.AbstractEditor.extend({
var self = this;
if(!this.options.compact) this.header = this.label = this.theme.getFormInputLabel(this.getTitle());
if(this.schema.description) this.description = this.theme.getFormInputDescription(this.schema.description);
if(this.schema.tooltip) this.tooltip = this.schema.tooltip;

if(this.options.compact) this.container.className += ' compact';

Expand All @@ -162,7 +163,7 @@ JSONEditor.defaults.editors.selectize = JSONEditor.AbstractEditor.extend({
self.onInputChange();
});

this.control = this.theme.getFormControl(this.label, this.input, this.description);
this.control = this.theme.getFormControl(this.label, this.input, this.description, this.tooltip);
this.container.appendChild(this.control);

this.value = this.enum_values[0];
Expand Down
3 changes: 2 additions & 1 deletion src/editors/string.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ JSONEditor.defaults.editors.string = JSONEditor.AbstractEditor.extend({
var self = this, i;
if(!this.options.compact) this.header = this.label = this.theme.getFormInputLabel(this.getTitle());
if(this.schema.description) this.description = this.theme.getFormInputDescription(this.schema.description);
if(this.schema.tooltip) this.tooltip = this.schema.tooltip;

this.format = this.schema.format;
if(!this.format && this.schema.media && this.schema.media.type) {
Expand Down Expand Up @@ -251,7 +252,7 @@ JSONEditor.defaults.editors.string = JSONEditor.AbstractEditor.extend({

if(this.format) this.input.setAttribute('data-schemaformat',this.format);

this.control = this.theme.getFormControl(this.label, this.input, this.description);
this.control = this.theme.getFormControl(this.label, this.input, this.description, this.tooltip);
this.container.appendChild(this.control);

// Any special formatting that needs to happen after the input is added to the dom
Expand Down
3 changes: 2 additions & 1 deletion src/editors/upload.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,12 @@ JSONEditor.defaults.editors.upload = JSONEditor.AbstractEditor.extend({

var description = this.schema.description;
if (!description) description = '';
if(this.schema.tooltip) this.tooltip = this.schema.tooltip;

this.preview = this.theme.getFormInputDescription(description);
this.container.appendChild(this.preview);

this.control = this.theme.getFormControl(this.label, this.uploader||this.input, this.preview);
this.control = this.theme.getFormControl(this.label, this.uploader||this.input, this.preview, this.tooltip);
this.container.appendChild(this.control);
},
refreshPreview: function() {
Expand Down
3 changes: 2 additions & 1 deletion src/theme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,10 @@ JSONEditor.AbstractTheme = Class.extend({
afterInputReady: function(input) {

},
getFormControl: function(label, input, description) {
getFormControl: function(label, input, description, tooltip) {
var el = document.createElement('div');
el.className = 'form-control';
if(tooltip) el.title = tooltip;
if(label) el.appendChild(label);
if(input.type === 'checkbox') {
label.insertBefore(input,label.firstChild);
Expand Down
3 changes: 2 additions & 1 deletion src/themes/bootstrap2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,10 @@ JSONEditor.defaults.themes.bootstrap2 = JSONEditor.AbstractTheme.extend({
el.textContent = text;
return el;
},
getFormControl: function(label, input, description) {
getFormControl: function(label, input, description, tooltip) {
var ret = document.createElement('div');
ret.className = 'control-group';
if(tooltip) ret.title = tooltip;

var controls = document.createElement('div');
controls.className = 'controls';
Expand Down
3 changes: 2 additions & 1 deletion src/themes/bootstrap3.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ JSONEditor.defaults.themes.bootstrap3 = JSONEditor.AbstractTheme.extend({
}
return el;
},
getFormControl: function(label, input, description) {
getFormControl: function(label, input, description, tooltip) {
var group = document.createElement('div');
if(tooltip) group.title = tooltip;

if(label && input.type === 'checkbox') {
group.className += ' checkbox';
Expand Down
3 changes: 2 additions & 1 deletion src/themes/jqueryui.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@ JSONEditor.defaults.themes.jqueryui = JSONEditor.AbstractTheme.extend({
el.style.display = 'inline-block';
return el;
},
getFormControl: function(label, input, description) {
getFormControl: function(label, input, description, tooltip) {
var el = this._super(label,input,description);
if(tooltip) el.title = tooltip;
if(input.type === 'checkbox') {
el.style.lineHeight = '25px';

Expand Down