Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/audithsoftworks/uniform

A jQuery plugin to make your form controls look how you want them to. Now with HTML-5 attributes!
https://github.com/audithsoftworks/uniform

css custom-form-fields javascript jquery sass uniform

Last synced: 1 day ago
JSON representation

A jQuery plugin to make your form controls look how you want them to. Now with HTML-5 attributes!

Awesome Lists containing this project

README 

        
# (jQuery) Uniform



> A jQuery plugin to make your form controls look how you want them to. Now with HTML-5 attributes!



Works well with jQuery 1.6+, but we've received patches and heard that this works with jQuery 1.3.



Version 4.3.x uses jQuery 3.3.1+ and so far, things look promising.



[![NPM](https://img.shields.io/npm/v/@imanov/jquery.uniform.svg?maxAge=2592000?style=plastic)](https://www.npmjs.com/package/@imanov/jquery.uniform)

[![Total Downloads](https://img.shields.io/github/downloads/AudithSoftworks/Uniform/total.svg?maxAge=2592000?style=plastic)](https://github.com/AudithSoftworks/Uniform)

[![Contributors](https://img.shields.io/github/contributors/AudithSoftworks/Uniform.svg?maxAge=2592000?style=plastic)](https://github.com/AudithSoftworks/Uniform)

[![License](https://img.shields.io/github/license/AudithSoftworks/Uniform.svg?maxAge=2592000?style=plastic)](https://github.com/AudithSoftworks/Uniform/blob/master/LICENSE.txt)



## Installation



Packaging of Uniform comes with source SASS files and minified CSS files, ready for consumption in live/production environment. You can install Uniform via one of two methods listed below:



### Via NPM



[![NPM Monthly Downloads](https://img.shields.io/npm/dm/jquery.uniform.svg)](https://www.npmjs.com/package/jquery.uniform)

[![NPM Total Downloads](https://img.shields.io/npm/dt/jquery.uniform.svg)](https://www.npmjs.com/package/jquery.uniform)



Simply run:



    npm install --save @imanov/jquery.uniform

    

To create minified file, run (though this isn't necessary, as the minified file is already included in the package):

    

    npm run build

    

Minified source file will be built inside ```dist/``` folder.



### Via Public CDN



[![CDNJS](https://img.shields.io/cdnjs/v/Uniform.js.svg?maxAge=2592000?style=plastic)](https://cdnjs.com/libraries/Uniform.js)

[![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/jquery.uniform/badge?style=rounded)](https://www.jsdelivr.com/package/npm/jquery.uniform)



### Un-minified CSS files



For your own development purposes, to get human-readable, un-minified CSS outputs, you will need to install Uniform via NPM (as shown above), install the necessary dependencies through ```npm install``` and then run ```gulp```. Doing so will recreate readable CSS files in ```dist/css``` folder. Invoking ```gulp --production``` however, will recreate minified CSS files (which is default behavior, what we already have in the ```dist``` folder).

    



## Implementation



There are two ways to go with this:



### Basic Implementation



Basically, you can use the final assets provided in ```dist``` folder out of the box.

 

Stylesheets and Javascript files should be linked in the `````` of your markup (the latter, coming after jQuery):



    

	

	

	



Or if you are using our bundled version - ```jquery.uniform.bundled.js``` file - which already comes with jQuery (beware not to include jQuery twice):



    

	

	



### Advanced Implementation



To have more control over your web assets, you can directly work with our SCSS and JS files, by importing them into or bundling with your own assets. Please be advised that our Gulp configuration (via Laravel-Elixir package) includes Auto-prefixer, i.e. browser prefixes are automatically added to CSS during the post-processing of SCSS files. Whatever your post-processing solution will be (Gulp-based or Compass), you need to make sure to include Auto-prefixer in that workflow. Our SCSS source files do not include browser prefixes out of the box! 



## Usage



See our Wiki page for documentation.



## Reporting Bugs



It sure would be handy if you could create a test page to help illustrate bugs.  When you use the GitHub Issue Tracker, you could use [this jsfiddle](https://jsfiddle.net/Shehi/qgLwy8Ln/) to help illustrate your point. Additionally, we have provided some demo pages in ```/demo``` folder for you to use.



Even if you don't use these assets, all sorts of feedback is welcome, but narrowing down your problem or providing an example would immediately help narrow down the problem quickly.



## Contributor/Developer Assets



We have created a Docker container to help our contributors with development of Uniform.



[![](https://img.shields.io/docker/automated/audithsoftworks/uniform.svg)](https://microbadger.com/images/audithsoftworks/uniform "Docker Hub public images")

[![](https://images.microbadger.com/badges/version/audithsoftworks/uniform.svg)](https://microbadger.com/images/audithsoftworks/uniform "Docker Hub public images")

[![](https://images.microbadger.com/badges/image/audithsoftworks/uniform.svg)](https://microbadger.com/images/audithsoftworks/uniform "Docker Hub public images layers")

[![](https://img.shields.io/docker/pulls/audithsoftworks/uniform.svg)](https://microbadger.com/images/audithsoftworks/uniform "Docker Hub public images")



Additionally, ```/dev``` folder contains following assets, to further enhance our capabilities:



1. ```docker``` folder contains necessary ```Dockerfile``` to build the container.

2. ```theme-kit``` contains assets to help you create new themes.

3. ```build.sh``` script, which basically spins a Docker container up and builds the package, using that instance.