RaskaJS

  • API Docs for Version: v1.0.0

    • Show:

    $dom

    Module: _helpers
    Parent Module: raska

    DOM manipulation related helpers

    Table of Contents

    Methods

    addChild
    (
    • type
    )
    chainable

    Defined in src\raska.js:150

    Creates a new child element relative to this HTML element

    Parameters:

    • type String

      Element node type

    addSibling
    (
    • type
    )
    chainable

    Defined in src\raska.js:188

    Adds a sibling element

    Parameters:

    • type String

      Element node type

    attr
    (
    • name
    • value
    )
    chainable

    Defined in src\raska.js:94

    Gets/Sets the value for a given attribute of an HTML element

    Parameters:

    • name String

      Attribute name

    • value String

      Attribute value

    child
    (
    • selector
    )
    DOMElementHelper

    Defined in src\raska.js:247

    Selects the first occurent of child elements that matches the selector

    Parameters:

    • selector String

      Element's selector

    Returns:

    DOMElementHelper:

    The element wraped in a helper object

    create
    (
    • type
    • parent
    )
    DOMElementHelper

    Defined in src\raska.js:267

    Creates and returns an element

    Parameters:

    • type String

      Element node type

    • parent HTMLElement

      Element's parent node

    Returns:

    DOMElementHelper:

    The element wraped in a helper object

    css
    (
    • name
    • value
    )
    chainable

    Defined in src\raska.js:53

    Get/Sets the styling of a given element

    Parameters:

    • name String

      Style attribute

    • value String

      Style value

    css
    (
    • name
    )
    chainable

    Defined in src\raska.js:78

    Removes the styling attrribute of a given element

    Parameters:

    • name String

      Style attribute

    get
    (
    • selector
    )
    DOMElementHelper

    Defined in src\raska.js:284

    Gathers an element using a given selector query

    Parameters:

    • selector String

      Element's selector

    Returns:

    DOMElementHelper:

    The element wraped in a helper object

    getById
    (
    • id
    )
    DOMElementHelper

    Defined in src\raska.js:296

    Gathers an element using a given id

    Parameters:

    • id String

      Element's id

    Returns:

    DOMElementHelper:

    The element wraped in a helper object

    getParent ()
    chainable

    Defined in src\raska.js:178

    Gets the parent node for this element

    getXYPositionFrom
    (
    • container
    • evt
    )
    X,y

    Defined in src\raska.js:128

    Gathers UI iteraction X/Y coordinates from an event

    Parameters:

    • container HTMLElement

      The element that contains the bounding rect we'll use to gather relative positioning data

    • evt Event

      The event we're extracting information from

    Returns:

    X,y:

    Values

    html
    (
    • content
    )
    chainable

    Defined in src\raska.js:199

    Gets\Sets the innerHTML content for the HTML element

    Parameters:

    • content String
    html
    (
    • content
    )
    chainable

    Defined in src\raska.js:214

    Gets\Sets the innerText content for the HTML element

    Parameters:

    • content String
    on
    (
    • targetElement
    • iteractionType
    • triggerWrapper
    )
    chainable

    Defined in src\raska.js:229

    Registers a delegate to a given element event

    Parameters:

    • targetElement HTMLElement

      The element that we're interested in

    • iteractionType String

      The event name

    • triggerWrapper Function

      The delegate

    raw () HTMLElement

    Defined in src\raska.js:117

    Retrieves the raw HTML element wraped by this helper

    Returns:

    HTMLElement:

    The element itself

    type () String

    Defined in src\raska.js:168

    Get the node name for this element

    Returns:

    String:

    The node name for this element