https://github.com/johnhunter/om

Really simple DOM framework
https://github.com/johnhunter/om

Last synced: 8 days ago
JSON representation

Really simple DOM framework

• Host: GitHub
• URL: https://github.com/johnhunter/om
• Owner: johnhunter
• Created: 2011-03-28T17:16:21.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2011-09-28T21:27:10.000Z (about 13 years ago)
• Last Synced: 2024-10-13T23:06:29.385Z (23 days ago)
• Language: JavaScript
• Homepage:
• Size: 117 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# om.js - Really simple DOM framework #

## Description ##

om.js is a simple framework for working with the DOM. It is primarily intended for modern browsers and Mobile Webkit in particular. Functionality is currently focused on two areas:

* Recursive methods to access element classname and style properties.

* Aliasing existing DOM query methods (makes no attempt to normalise browsers)

The framework is organised in a single `om` global object. If a global property with this name already exists then the framework falls back to the name `jhi_om`.

If the framework does not provide the functionality you need then you should consider using fuller featured frameworks such as [jQuery](http://jquery.com/) or [XUI](http://xuijs.com/).

## Use ##

	// get an array of 
 elements within content.

	var items = om.qAll('#content li');

	

	

	// add a class to each 


	om.addClass(items, 'my-items');

	

	

	// change the position of each 
 

	om.css(items, {

		'position': 'relative',

		'left': '50px'

	});


## Methods ##

* `qAll(selector [,context])`   - returns an array of dom elements for the css selector

* `qOne(selector [,context])`   - returns first dom element for the css selector

* `qId(id)`                     - returns dom element for id

* `qTag(name [,context])`       - returns an array of dom elements for the given tagname

* `hasClass(el, name)`          - returns true if el has a class of name

* `addClass(el, name)`          - adds class name to el (or el array)

* `removeClass(el, name)`       - removes class name from el (or el array)

* `toggleClass(el, name)`       - toggles class name on el (or el array)

* `css(el, styles)`             - apply the styles object properties to el (or el array)

* `toArray(o)`                  - converts o to an array

* `isArray(o)`                  - test if o is an array

* `extend(target, source)`      - add source object properties to target, returning target

* `each(list, callback)`        - an iterator for arrays

* `subs(str, props)`            - substitute properties of props object into template str `"{$prop}"`

* `trim(str)`                   - trim leading / trailing whitespace from str

## Properties ##

The framework will set the following boolean properties (flags) on the window object:

* `isiPad` 

* `isiPod` 

* `isiPhone` 

These are based on the browser user-agent string. Note that some platforms may have more than one flag. E.g. iPod Touch is flagged as bother isiPod and isiPhone.

## License ##

CC-BSD (2011)