April 22, 2012

Uniform

h1. Uniform

Sexy form elements with jQuery

Version 1.7.5

Requires jQuery 1.4 or newer.

Licensed under: MIT License - http://www.opensource.org/licenses/mit-license.php

h2. Installation

Installation of Uniform is quite simple. First, make sure you have jQuery 1.4+ installed. Then you’ll want to link to the jquery.uniform.js file and uniform.default.css in the head area of your page:

bc.

h2. Basic usage

Using Uniform can be quite easy as well. Simply call:

$("select").uniform();

To “uniform” all possible form elements, just do something like this:

$("select, input[type=checkbox], input[type=radio], input[type=file], input[type=submit], a.button, button").uniform();

A complete tag in the HEAD section of your site can therefore look like this:

bc.

Remember that it is essential to first follow the steps in the Installation section here above.

h2. Extra parameters

You can pass in extra parameters to control certain aspects of Uniform. To pass in parameters, use syntax like this:

bc. $("select").uniform({ param1: value, param2: value, param3: value });

h3. NEW! autoHide(boolean)

Default: true If this option is set to true, Uniform will hide the new elements if the existing elements are currently hidden using display: none;

REMEMBER: If you want to show a select or checkbox you'll need to show the new Uniform div instead of the child element.

h3. selectClass (string)

Default: “selector” Sets the class given to the wrapper div for select elements.

@$("select").uniform({selectClass: 'mySelectClass'});@

h3. radioClass (string)

Default: “radio” Sets the class given to the wrapper div for radio elements.

@$(":radio").uniform({radioClass: 'myRadioClass'});@

h3. checkboxClass (string)

Default: “checker” Sets the class given to the wrapper div for checkbox elements.

@$(":checkbox").uniform({checkboxClass: 'myCheckClass'});@

h3. fileClass (string)

Default: “uploader” Sets the class given to the wrapper div for file upload elements.

@$(":file").uniform({fileClass: 'myFileClass'});@

h3. filenameClass (string)

Default: “filename” Sets the class given to div inside a file upload container that spits out the filename.

@$(":file").uniform({filenameClass: 'myFilenameClass'});@

h3. fileBtnClass (string)

Default: “action” Sets the class given to div inside a file upload container that acts as the “Choose file” button.

@$(":file").uniform({fileBtnClass: 'myFileBtnClass'});@

h3. fileDefaultText (string)

Default: “No file selected” Sets the text written in the filename div of a file upload input when there is no file selected.

@$(":file").uniform({fileDefaultText: 'Select a file please'});@

h3. fileBtnText(string)

Default: “Choose File” Sets the text written on the action button inside a file upload input.

@$(":file").uniform({fileBtnText: 'Choose…'});@

h3. buttonClass(string)

Default: "button" Sets the class given to a button that's been uniformed

@$("input[type=button]").uniform({buttonClass: 'myBtnClass'});@

h3. checkedClass (string)

Default: “checked” Sets the class given to elements when they are checked (radios and checkboxes).

@$(":radio, :checkbox").uniform({checkedClass: 'myCheckedClass'});@

h3. focusClass (string)

Default: “focus” Sets the class given to elements when they are focused.

@$("select").uniform({focusClass: 'myFocusClass'});@

h3. disabledClass (string)

Default: “disabled” Sets the class given to elements when they are disabled.

@$("select").uniform({disabledClass: 'myDisabledClass'});@

h3. activeClass (string)

Default: “active” Sets the class given to elements when they are active (pressed).

@$("select").uniform({activeClass: 'myActiveClass'});@

h3. hoverClass (string)

Default: “hover” Sets the class given to elements when they are currently hovered.

@$("select").uniform({hoverClass: 'myHoverClass'});@

h3. useID (boolean)

Default: true If true, sets an ID on the container div of each form element. The ID is a prefixed version of the same ID of the form element.

@$("select").uniform({useID: false});@

h3. idPrefix (string)

Default: “uniform” If useID is set to true, this string is prefixed to element ID’s and attached to the container div of each uniformed element. If you have a checkbox with the ID of “remember-me” the container div would have the ID “uniform-remember-me”.

@$("select").uniform({idPrefix: 'container'});@

h3. resetSelector (boolean/string)

Default: false This parameter allows you to use a jQuery-style selector to point to a “reset” button in your form if you have one. Use false if you have no “reset” button, or a selector string that points to the reset button if you have one.

@$("select").uniform({resetSelector: 'input[type="reset"]'});@

h2. Additional functions

In addition to the parameters, there are a couple of other ways you can interact with Uniform.

h3. $.uniform.update([elem/selector string]);

If you need to change values on the form dynamically you must tell Uniform to update that element’s style. Fortunately, it’s very simple. Just call this function, and Uniform will do the rest.

@$.uniform.update("#myUpdatedCheckbox");@

If you are lazy, or just don’t specifically know which element to update, you can just leave out the parameter (see below) and Uniform will update all Uniformed elements on the page:

@$.uniform.update();@

h3. $.uniform.restore([elem/selector string]);

If you want to "un-uniform" something, simply call this function. It will remove the inline styles, extra dom elements, and event handlers, effectively restoring the element to it's previous state.

@$.uniform.restore("select");@

h3. $.uniform.elements[]

You can get an array of all the elements that have been Uniformed at any time using this public variable. Wouldn’t advise changing the contents though!

@var uniforms = $.uniform.elements;@

h2. Customizing CSS

To edit the CSS of Uniform it is highly recommended to not edit the theme files, but to override them using CSS. Make sure your CSS file comes after the uniform theme css file in the HEAD section.

It's common to want to resize the selects or other elements. The best way is to set the width property on the div element, span element and the form element itself. Look through the theme CSS in the presentation section to see where the width property is currently set.

h2. Tips & tricks

Uniform is supposed to be pretty simple, but there are a few things that can be tricky. Here are some tips that may make your experience simpler:

Remember to change the CSS classes in the theme if you change the parameters for elements’ classes. This can be tedious work, but if you don’t do it, it’s not going to look correct. Find and Replace is your friend.

Uniform cannot automatically sniff out dynamic value changes. If you make changes to elements in Javascript or using a Reset button of some kind remember to call $.uniform.update(); to sync the changes with Uniform.

Uniform is disabled in IE6. It’s not possible to fix due to the way IE6 handles form elements. If you care about IE6 users, give it a quick look to make sure your “naked” form elements look alright in there.

You’re on your own for styling text inputs and more. Fortunately, things that are not handled by Uniform are pretty easy to skin. :)

If you have ideas, or bugs, please post them in GitHub. We rely on our users for ideas for improvements and bug reports. Otherwise Uniform will stay static.