Frappé has a couple of elegant and useful widgets, but some times we need to edit them to add small improvements. This small article will describe how to add new resources to the standard widgets.
Let me explain first our goal:
> Add many
alternative translations in numerous records
and in a lot of doctypes
Look the highlighted sections in the goal, we have many translations to add in many records and in many doctypes, so, we heave a many of work, so we have a lot to do right?
The answer for this question is: -Of course not! Because we know that if one element exists in many records and in many doctypes, this element is the Control
or Widget
So, what we need do, is improve your goal based on the Control
, to reduce our quantity of work.
But, where will we find this magic element, the control? -For now, we can look it in the JavaScript sources - let’s look now at Github
> Don’t worry if you don’t understand the code for now, our goal there is simplify our work.
Let’s go ahead with the thought!
We know where we need to make the changes, but how will we dismember which are the controls that are affected by our feature and which aren’t ?
We need to keep in mind, that Control
are instance of DocFields
and the DocFields
have a field that is very important for us in this case, the field that will help us to dismember which are affected by our feature and which aren’t is the field options
in the DocField
.
-Wait!, we understood that the field options
can help us, but, how will it help us?
Good question, we will define a word to put in the options
of the DocFields
that we need to include the feature, this world will be Translatable
.
> If you forget how to customize the options of a field look this article, it can refresh your knowledge.
Well, with the defined word in options
of our selected DocFields
, now is time to code:
-At last, we think we would never stop talking!
frappe.ui.form.ControlData = frappe.ui.form.ControlData.$extend({
make_input: function(){
var options = this.df.options;
if (!options || options!=="Translatable"){
this._super();
return;
}
var me = this;
$('<div class="link-field" style="position: relative;">\
<input type="text" class="input-with-feedback form-control">\
<span class="dialog-btn">\
<a class="btn-open no-decoration" title="' + __(" open="" translation")="" +="" '"="">\
<i class="icon-globe"></i></a>\
</span>\
</div>').prependTo(this.input_area);
this.$input_area = $(this.input_area);
this.$input = this.$input_area.find('input');
this.$btn = this.$input_area.find('.dialog-btn');
this.set_input_attributes();
this.$input.on("focus", function(){
me.$btn.toggle(true);
});
this.$input.on("blur", function(){
setTimeout(function(){ me.$btn.toggle(false) }, 500);
});
this.input = $this.input.get(0);
this.has_input = true;
var me = this;
this.setup_button();
},
setup_button: function(){
var me = this;
if (this.only_input){
this.$btn.remove();
return;
}
this.$btn.on("click", function(){
var value = me.get_value();
var options = me.df.options;
if (value && options && options==="Translatable"){
this.open_dialog();
}
});
},
open_dialog: function(){
var doc = this.doc;
if (!doc.__unsaved){
new frappe.ui.form.TranslationSelector({
doc: doc,
df: this.doc,
text: this.value
});
}
}
});
-Other letter soup, for my gosh!
In fact, it IS a soup of letters, for a newbie, but we are not a beginner.
Let me explain what this code does;
ControlData
by one extended Class
of itself.make_input
checks if the docfield is Translatable
to make the new Control
if not, it calls the original make_input
using _super()
setup_button
checks if the docfield is Translatable
to enable it show a dialog
open_dialog
invokes a new instance of the TranslationSelector
that we will create in the code below.