Object options vs. 1.1.0 Full+Lite

An optional object that holds the button properties. The ng.Button class inherits the ng.PlugIn.options and all it's properties.

Properties

String layout (Optional - Default: ita) vs. 1.1.3 Full+Lite
Set the Button icon, text and arrow layout. This allows you to arrange the button in any style. The characters allowed are i for icon, t for text, a for arrow and | for new row.
Integer width (Optional - Default: Null) vs. 1.1.0 Full+Lite
The button's width. If Null, the width will be automatic.
String text (Optional - Default: (empty string)) vs. 1.1.0 Full+Lite
The button's text. If this is empty, the HTML Element innerHTML or value will be used.
String value (Optional - Default: Null) vs. 1.1.0 Full+Lite
The button's value. This will be used if the HTML Element object is a submit button. If null, the object value will be used.
String icon (Optional - Default: Null) vs. 1.1.0 Full+Lite
The button's icon image source. The path should be relative to the current page (not the JavaScript file). If null, the button will not have an icon.
Component component (Optional - Default: Null) vs. 1.1.0 Full+Lite
A component that will be associated with the button. If this option is set, an arrow will be placed on the end of the button and the component will be toggled when the button is clicked.
Boolean hide_text (Optional - Default: false) vs. 1.1.0 Full+Lite
Hide the text part of the button or not.
Boolean hide_icon (Optional - Default: false) vs. 1.1.0 Full+Lite
Hide the icon part of the button or not.
Boolean hide_component (Optional - Default: false) vs. 1.1.0 Full+Lite
Hide the component's arrow part of the button or not. The button will still toggle the component regardless of this value.
String ui_class Required vs. 1.2.0 Full+Lite
An optional UI CSS class name to define the button colors and styles.
String count Required vs. 1.2.0 Full+Lite
An optional value to show over the button as a count.
Integer text_length (Optional - Default: Null) vs. 1.1.0 Full+Lite
The maximum length of the text string. If the length is bigger than this value, it will be shortened using the ng.String.shorten. Null will not alter the text length.
Boolean disabled (Optional - Default: false) vs. 1.1.0 Full+Lite
Should the button be disabled or not. If the button is disabled, it will not fire any events or react to any actions.
Boolean checked (Optional - Default: false) vs. 1.1.0 Full+Lite
Is the button checked or not. If checked, the checked_color will be applied.
Boolean stop_default (Optional - Default: false) vs. 1.1.0 Full+Lite
Should the original HTML Element action be stopped or not. For example, if the button is generated from an anchor tag, it will redirect to the user to the link when clicked unless this value is set to true.
Mixed color (Optional - Default: transparent (Configuration value)) vs. 1.1.0 Full+Lite. Deprecated in vs 1.2.0
As of version 1.2.0, this option is deprecated and will be removed in version 1.2.5. The buttons background color. This can be an ng.Color object, a hexadecimal code string, "transparent" or "none".
Mixed over_color (Optional - Default: #ffd06e (Configuration value)) vs. 1.1.0 Full+Lite. Deprecated in vs 1.2.0
As of version 1.2.0, this option is deprecated and will be removed in version 1.2.5. The buttons background color when the mouse is over it. This can be an ng.Color object, a hexadecimal code string, "transparent" or "none".
Mixed down_color (Optional - Default: Null) vs. 1.1.0 Full+Lite. Deprecated in vs 1.2.0
As of version 1.2.0, this option is deprecated and will be removed in version 1.2.5. The buttons background color when it's down. This can be an ng.Color object, a hexadecimal code string, "transparent" or "none". Null will make this value the same as the over_color value.
Mixed disable_color (Optional - Default: null (same as button_over_color)) vs. 1.1.0 Full+Lite. Deprecated in vs 1.2.0
As of version 1.2.0, this option is deprecated and will be removed in version 1.2.5. The buttons background color when disabled. This can be an ng.Color object, a hexadecimal code string, "transparent" or "none". Null will make this value the desaturated value of button_color.
Mixed checked_color (Optional - Default: #f5be5b (Configuration value)) vs. 1.1.0 Full+Lite. Deprecated in vs 1.2.0
As of version 1.2.0, this option is deprecated and will be removed in version 1.2.5. The buttons background color when checked. This can be an ng.Color object, a hexadecimal code string, "transparent" or "none".
Mixed text_color (Optional - Default: Null (Configuration value)) vs. 1.1.0 Full+Lite. Deprecated in vs 1.2.0
As of version 1.2.0, this option is deprecated and will be removed in version 1.2.5. The buttons text color. This can be an ng.Color object or a hexadecimal code string. Null will make this value white for dark buttons and black for light buttons.
Boolean gloss (Optional - Default: true (Configuration value)) vs. 1.1.0 Full+Lite. Deprecated in vs 1.2.0
As of version 1.2.0, this option is deprecated and will be removed in version 1.2.5. A boolean to either add a gloss effect on the button or leave it matt.
String arrow_style (Optional - Default: down) vs. 1.1.0 Full+Lite. Deprecated in vs 1.2.0
As of version 1.2.0, this option is deprecated and will be removed in version 1.2.5. The components arrow style. This can be either "up" or "down"
Boolean light_border (Optional - Default: false (Configuration value)) vs. 1.1.4 Full+Lite. Deprecated in vs 1.2.0
As of version 1.2.0, this option is deprecated and will be removed in version 1.2.5. True or false to use a light border around the buttons. By default, the border is darker color of the button color, but if this is set to true, the border color is lighter. This is useful when the button is dark and the page background is dark as well.
Boolean render_top (Optional - Default: true) vs. 1.1.0 Full+Lite
Render the button's top border or not.
Boolean render_right (Optional - Default: true) vs. 1.1.0 Full+Lite
Render the button's right border or not.
Boolean render_bottom (Optional - Default: true) vs. 1.1.0 Full+Lite
Render the button's bottom border or not.
Boolean render_left (Optional - Default: true) vs. 1.1.0 Full+Lite
Render the button's left border or not.

Inherit Options from ng.PlugIn (options)

HTML_Element object (Optional - Default: Null) vs. 1.1.0 Full+Lite
The HTML Element that will hold all the plugin output and handle all the events. By default, an new DIV will be created at the bottom of the body.
String language (Optional - Default: en (Configuration value)) vs. 1.1.0 Full+Lite
The default plugin language.

API Menu