Response title
This is preview!
Move this topic
Widget Factory _setOption
Need more info
- Need more info
- Working on it
- Answered
in Using jQuery UI
•
8 years ago
When working with jQuery UIs Widget factory is it considered standard to provide _setOption functionality for every option available at instantiation?
The reason I ask it because I'm finding myself adding a shed load of bloat to my widget just to allow option changes that, in all honesty, I can't see being used after instantiation?
Any advice?
Rich
The reason I ask it because I'm finding myself adding a shed load of bloat to my widget just to allow option changes that, in all honesty, I can't see being used after instantiation?
Any advice?
Rich
1
Replies(5)
Re: Widget Factory _setOption
8 years ago
Yes, the design of jQuery UI widgets is that the
entire state of the widget is encapsulated in the options and all
options (with few exceptions) should be able to be changed at any point,
with all side effects and needed consistency handled, not just set at initialization and then fixed. Otherwise making a change to such options would require destroying and re-initializing the widget. There are a few cases where this is reasonable, but they should be the exception, not the rule.
This doesn't necessarily mean if you have 12 options there will be 12 cases handled in _setOption. An example is the jQuery UI Dialog modal option. We don't consider it reasonable to change whether a dialog is modal while the dialog is open. So there's no special handling of modal in _setOption but the modal option is used at both open and close. Demo: http://jsbin.com/ilufa6
It's more common to the plugin pattern (versus the widget pattern we've designed) to have options at init that would never change later. So a first question you may need to ask yourself is "Am I writing a widget where I should be writing a plugin?"
Otherwise, can you provide some specifics?
This doesn't necessarily mean if you have 12 options there will be 12 cases handled in _setOption. An example is the jQuery UI Dialog modal option. We don't consider it reasonable to change whether a dialog is modal while the dialog is open. So there's no special handling of modal in _setOption but the modal option is used at both open and close. Demo: http://jsbin.com/ilufa6
It's more common to the plugin pattern (versus the widget pattern we've designed) to have options at init that would never change later. So a first question you may need to ask yourself is "Am I writing a widget where I should be writing a plugin?"
Otherwise, can you provide some specifics?
Leave a comment on rdworth's reply
Re: Widget Factory _setOption
8 years ago
Thanks for the detailed reply!
I'm porting my Carousel plugin to the jQuery UI Widget Factory which, because it requires state and a public API, I think is appropriate. It can be seen here - https://github.com/richardscarrott/jquery-ui-carousel
I understand that many options, such as your 'modal' demonstration, don't require explicit cases due to $.Widget's base _setOption method but I have a few options that, as I see it, will require a fair amount of code to change something that I don't see being required after instantiation.
For example I have a 'horizontal' option. This sets the carousels orientation however it's not something I'd expect developers to change after instantiation due to it's very definitive nature.
I think, what also make me hesitant is that it's largely governed by CSS which means I'd have to set a number of styles within the JS which I'm not necessarily comfortable with.
Another option that concerns me is 'itemsPerPage' and 'noOfRows' as this is really governed by the width and height of the mask (AKA clipper div) which is set through CSS on a carousel by carousel basis so changing these options and updating the internals won't necessarily have the desired affect without some CSS changes...mmm
On a side note, I wonder if you could provide any information on the current status of the official jquery ui carousel and whether there is anything in the works for 1.9 or 2.0?
I'm porting my Carousel plugin to the jQuery UI Widget Factory which, because it requires state and a public API, I think is appropriate. It can be seen here - https://github.com/richardscarrott/jquery-ui-carousel
I understand that many options, such as your 'modal' demonstration, don't require explicit cases due to $.Widget's base _setOption method but I have a few options that, as I see it, will require a fair amount of code to change something that I don't see being required after instantiation.
For example I have a 'horizontal' option. This sets the carousels orientation however it's not something I'd expect developers to change after instantiation due to it's very definitive nature.
I think, what also make me hesitant is that it's largely governed by CSS which means I'd have to set a number of styles within the JS which I'm not necessarily comfortable with.
Another option that concerns me is 'itemsPerPage' and 'noOfRows' as this is really governed by the width and height of the mask (AKA clipper div) which is set through CSS on a carousel by carousel basis so changing these options and updating the internals won't necessarily have the desired affect without some CSS changes...mmm
On a side note, I wonder if you could provide any information on the current status of the official jquery ui carousel and whether there is anything in the works for 1.9 or 2.0?
Re: Re: Widget Factory _setOption
8 years ago
Sure. Similar to the slider orientation option. See https://github.com/jquery/jquery-ui/blob/master/ui/jquery.ui.slider.js#L528For example I have a 'horizontal' option. This sets the carousels orientation however it's not something I'd expect developers to change after instantiation due to it's very definitive nature.
Imagine a layout changes, maybe a container or window is resized or a mobile device is rotated from portrait to landscape. It may be reasonable for the user to be able to choose to rotate the orientation of the widget to handle that kind of a change. Of course that's up to you as the author and maintainer of the widget. What we try to do when authoring the jQuery UI widgets is not do anything in the init itself, but just call from init (based on the values of the options at init) whatever side-effect methods would be called later when values change in _setOption. This gives you a lot more flexibility to handle such changes as well as ensuring that you widget can be initialized with any set of option values just as well as with the defaults. In other words, making it robust post-init makes it robust at-init.
Most of the CSS should be encapsulated in rules so you should be doing most of the changes by adding and removing classes. Again, I think slider may be a good example to look at.
I think, what also make me hesitant is that it's largely governed by CSS which means I'd have to set a number of styles within the JS which I'm not necessarily comfortable with.
Another option that concerns me is 'itemsPerPage' and 'noOfRows' as this is really governed by the width and height of the mask (AKA clipper div) which is set through CSS on a carousel by carousel basis so changing these options and updating the internals won't necessarily have the desired affect without some CSS changes...mmm
It's not one that's prioritized at this point, meaning no jQuery UI team member is actively working on it. It's not on the roadmap for either release at this pointOn a side note, I wonder if you could provide any information on the current status of the official jquery ui carousel and whether there is anything in the works for 1.9 or 2.0?
http://wiki.jqueryui.com/Roadmap
While that speaks more to what we plan to do than what we don't plan to do, it shows we already have a lot prioritized above it.
Leave a comment on riscarrott1's reply
Re: Widget Factory _setOption
8 years ago
@rdworth
};
I came to this thread from: http://forum.jquery.com/topic/can-t-get-custom-options-to-update-from-default
in my code I'm trying to implement custom setOption, to handle the logic with the title option.
$('..').dialog({ title: false })
title gets changed to "" during construction via dialogs: _setOption function.
i'm trying this logic below
$(function () {
var __setOption = $.ui.dialog.prototype._setOption;
var __create = $.ui.dialog.prototype._create;
$.ui.dialog.prototype.__create = function () {
$.ui.dialog.prototype.__create = function () {
_create.apply(this, arguments);
}
$.ui.dialog.prototype.__setOption = function (key, value) {
//my logic here
}};
I was expecting __setOption logic to fire during _create, instead it fires with $('..').dialog('option', { title: false});
Re: Re: Widget Factory _setOption
8 years ago
Option setting on init, which overrides defaults, is handled by the widget factory. If something is happening to change one of those option values in create or init you can and you want to do something after that, do it after your _create.apply or _init.apply call.
As you've found _setOption is not used on create. _setOption is for handling when options change after initialization. You may want to start with http://blog.nemikor.com/2010/05/15/building-stateful-jquery-plugins/ for a bit more background on each of these.
As you've found _setOption is not used on create. _setOption is for handling when options change after initialization. You may want to start with http://blog.nemikor.com/2010/05/15/building-stateful-jquery-plugins/ for a bit more background on each of these.
Leave a comment on nmyvision's reply
Change topic type
Link this topic
Provide the permalink of a topic that is related to this topic
Reply to riscarrott1's question
Statistics
- 5 Replies
- 12031 Views
- 1 Followers