modo.Label

Quicknavigation:

Constructor
- modo.Label
Properties
- el
- modoId
- visible
- showEffect
- hideEffect
Methods
- set
- get
- bindToModel
- setFlexible
- show
- hide
- addClass
- removeClass
- addClassTemporary
Events
- change
- show
- hide
CSS Classes

The label element can be used to display any kind of textual information.

Constructor

modo.Label(params)modo.Label

The following list of parameters can be used in the params object, passed to the constructor. Parameters in [brackets] are optional.

Property	Description
[value]	A initial value for the label, OR a function that returns a value. The function is called when you bind the element to a Backbone Model and want to generate the elements value from that model. Example: `value: function(model){ return model.get('firstName') + ' ' + model.get('lastName'); }`
[model]	Set a model here to bind the labels value to a Backbone.Model property (type should be string)
[modelKey]	This, or a value function is mandatory for using the `model` parameter. This is the string key of the models property to use
[className]	A string with custom CSS classes to apply to the generated DOM element
[dataAttributes]	A object with attributes to assign to the generated DOM element. Omit the "data-" part. So for example `{count: 1}` becomes `data-count="1"` on the DOM element.
[el]	The jQuery enhanced DOM element to be generated. If nothing is set, a standard DIV container will be created. If you want to use a different DOM element, pass a jQuery generated DOM element to this parameter.
[showEffect]	The default show effect for the element. See associated property description. Default: `null`
[hideEffect]	The default hide effect for the element. See associated property description. Default: `null`

Properties

Inherited Properties from modo.Element

elObject

Contains the jQuery enhanced DOM Node of this modoJS element.

modoIdNumber

Contains a internally given, numeric ID for this element.

visibleBool

Will be set by .show() and .hide(). Access this property to check the current visibility of the element.

showEffectobject

Set a default show effect (like the options you can pass to the show() / hide() methods.

Example:

element.showEffect = {
    effect: 'slideDown',
    effectArgs: ['fast']
};

hideEffectobject

Define a default hide effect instead of a simple, instant hide.

Methods

set(value)

Pass a string to get it displayed in the labels DOM element. The string can contain HTML tags. Will trigger the Backbone Event "change".

bindToModel(model, [modelKey=null], [processingFunction=null], [noUpdate=false])this

Binds the element to a Backbone Model. Previous bindings will be detached. If you don't want (or can't) give a modelKey to bind to, you need to provide a processing function that turns a value of the model into a string to be displayed by the label.

The noUpdate parameter means that you don't want to update the labels currently displayed value when binding to a model but wait for later model updates.

If the model fires a change event, the label will be updated.

Inherited Methods from modo.Element

setFlexible([value])this

Pass either true or false to this value to make the element stretch inside a modo.FlexContainer element.

show(options)this

Make the connected DOM object visible and trigger the Backbone Event "show".

You can control the way the element is shown by passing an object of options.

Example:

element.show({
    effect: 'slideDown',
    effectArgs: ['fast']
});

hide()this

Make the connected DOM object invisible and trigger the Backbone Event "hide".

You can control the hide effect the same way as with the show() method.

addClass(classname, doPrefix)this

Will add another class name to the DOM element. The class name will be automatically prefixed (i.e. with mdo-) if doPrefix = true (default).

removeClass(classname, doPrefix)this

Will remove a class name from the DOM element. The class name will be automatically prefixed.

addClassTemporary(classname, timeout, doPrefix)this

Helps with adding a classname temporarily to the object. Just call this method and after the specified amount of time, the added class(es) will be removed.

Note: All modoJS Objects are extended with all methods of the Backbone.Events class.

Events

change

Triggered, when the labels value has been changed through .set()

Event Parameter	Description
value	The new value of the label

Inherited Events from modo.Element

show

Triggered, when the object has been displayed through show()

hide

Triggered, when the object has been hidden through hide()

CSS Classes

mdo-label

Applied to the element.

Inherited CSS Classes from modo.Element

mdo-element

Basic class that will be applied to every element that extends modo.Element.

mdo-flexible

Will be applied to every modo element where setFlexible(true) has been called upon.

Articles

Reference