A bunch of general purpose utilities for Atom packages.
Returns a promise that is only resolved when all the requested packages have been activated.
require 'atom-utils'requirePackages'tree-view''find-and-replace''snippets'then# Do something with the required packages
Registers or updates a custom element whose name is
require 'atom-utils': ->consolelog 'element created'registerOrUpdateElement'my-element'MyElementprototype
The update is performed by copying the properties from the passed-in prototype in the registered element prototype. As a node's callback methods can't be overriden once the element have been registered, a generic version is created that will invoke the concrete callback when called, that way even the node's callback methods can be updated.
Ancestors (previously AncestorsMethods)
A mixin that provides jQuery a like method to retrieve a node's parents:
require 'atom-utils'AncestorsincludeIntothis: -># Returns all the ancestors to the html elementparents = @parents# Returns all the ancestors that matches the selectorfilteredParents = @parents'selector'# It creates the custom element and register it as the `dummy-node` tag.DummyNode = documentregisterElement 'dummy-node'prototype: DummyNodeprototype
Can be called with or without the selector argument.
If called without argument, the method will return every parents of the current node.
If called with an argument, the method will return only the parent elements that match the passed-in selector.
Parents in the returned array are sorted by their distance from the node.
An alias of
::parents except it throw an error if called without a selector.
Returns only the first parent element that matches the passed-in selector.
Throws an error when called without a selector.
Iterates over each parent the node and calls
iterator with the current parent node.
A mixin that provides a
addDisposableEventListener method that registers an event listener on an element and returns a
Disposable to unregister it:
require 'atom-utils'require 'event-kit'DisposableEventsincludeIntothis: ->@subscriptions =@subscriptionsadd @addDisposableEventListener this'click'# ...# It creates the custom element and register it as the `dummy-node` tag.DummyNode = documentregisterElement 'dummy-node'prototype: DummyNodeprototype
A mixin that provides events delegation ala jQuery without jQuery. Use it by including it into your custom element:
require 'atom-utils'require 'event-kit'# It includes the mixin on the class prototype.EventsDelegationincludeIntothis# Custom element's callback on creation.: ->@subscriptions =@appendChilddocumentcreateElement'div'@firstChildappendChilddocumentcreateElement'span'# Without a target and a selector, it registers to the event on the# element itself.# The `subscribeTo` method returns a disposable that unsubscribe from# all the events that was added by this call.@subscriptionsadd @subscribeTo:consolelog"won't be called if the click is done on the child div"# With just a selector, it registers to the event on the elements children# matching the passed-in selector.@subscriptionsadd @subscribeTo 'div':consolelog"won't be called if the click is done on the child span"# Events propagation can be used to prevents the delegated handlers# to catch the events in continuation.estopPropagation# By passing a node and a selector, it registers to the event on the# elements children matching the passed-in selector.@subscriptionsadd @subscribeTo @firstChild'span':estopPropagation# It creates the custom element and register it as the `dummy-node` tag.DummyNode = documentregisterElement 'dummy-node'prototype: DummyNodeprototype
As there is no standard way to detect when an element size changed this mixin provides a DOM polling mechanism to custom element whose display and logic may rely on the element size:
require 'atom-utils'ResizeDetectionincludeIntothis# Starts the DOM poll when the element is attached: -> @initializeDOMPolling# Stops the DOM poll when the element is detached: -> @disposeDOMPolling# Callback called when the poll routine has detected a size change.# The callback receive the new width and height as arguments.:# If you need to prevent the poll routine to check the element size,# redefine this method with your own conditions. The function should return# false when the polling can occurs.# isDOMPollingPrevented: -> @domPollingPaused
If you need to suspend the polling while keeping the interval active you can use the
pauseDOMPolling to pause the polling routine and
resumeDOMPolling to resume it.
A mixin that provides the same content creation mechanism as
space-pen but for custom elements:
require 'atom-utils'SpacePenDSLincludeIntothis: ->@div outlet: 'container'class: 'container'=>@span outlet: 'label'class: 'label': -># Content is available in the created callback# It creates the custom element and register it as the `dummy-node` tag.DummyNode = documentregisterElement 'dummy-node'prototype: DummyNodeprototype