DOM Mutations
Inserts HTML into the DOM, inside the target element, after its last child.
append(
batch: String, # [null] - add the operation to a named batch
cancel: Boolean, # [false] - cancel the operation (for use on client)
delay: Integer, # [0] - wait for n milliseconds before running
focus_selector: String, # [null] - string containing a CSS selector
html: String, # [null] - the HTML to assign
select_all: Boolean, # [false] - operate on list of elements returned from selector
selector: String, # required - string containing a CSS selector or XPath expression
xpath: Boolean # [false] - process the selector as an XPath expression
)
cable-ready:before-appendcable-ready:after-append
Reparent the target element and its children to a new parent element in the DOM.
Grafted elements are moved, not recreated. This means that any Stimulus controllers attached to an element will
disconnect and then immediatelyconnect again, but their internal state remains intact.graft(
batch: String, # [null] - add the operation to a named batch
cancel: Boolean, # [false] - cancel the operation (for use on client)
delay: Integer, # [0] - wait for n milliseconds before running
focus_selector: String, # [null] - string containing a CSS selector
parent: String, # [null] - string containing a CSS selector
select_all: Boolean, # [false] - operate on list of elements returned from selector
selector: String, # required - string containing a CSS selector or XPath expression
xpath: Boolean # [false] - process the selector as an XPath expression
)
cable-ready:before-graftcable-ready:after-graft
Sets the innerHTML of a DOM element.
inner_html(
batch: String, # [null] - add the operation to a named batch
cancel: Boolean, # [false] - cancel the operation (for use on client)
delay: Integer, # [0] - wait for n milliseconds before running
focus_selector: String, # [null] - string containing a CSS selector
html: String, # [null] - the HTML to assign
select_all: Boolean, # [false] - operate on list of elements returned from selector
selector: String, # required - string containing a CSS selector or XPath expression
xpath: Boolean # [false] - process the selector as an XPath expression
)
cable-ready:before-inner-htmlcable-ready:after-inner-html
Inserts HTML into the DOM relative to an element. Positions are as follows, defaulting to
beforeend:beforebegin: Before the target element itselfafterbegin: Inside the target element, before its first childbeforeend: Inside the target element, after its last childafterend: After the target element itself
insert_adjacent_html(
batch: String, # [null] - add the operation to a named batch
cancel: Boolean, # [false] - cancel the operation (for use on client)
delay: Integer, # [0] - wait for n milliseconds before running
focus_selector: String, # [null] - string containing a CSS selector
html: String, # [null] - the HTML to insert
position: String, # [beforeend] - the relative position to the DOM element (beforebegin, afterbegin, beforeend, afterend)
select_all: Boolean, # [false] - operate on list of elements returned from selector
selector: String, # required - string containing a CSS selector or XPath expression
xpath: Boolean # [false] - process the selector as an XPath expression
)
cable-ready:before-insert-adjacent-htmlcable-ready:after-insert-adjacent-html
Inserts text into the DOM relative to an element. Positions are as follows, defaulting to
beforeend:beforebegin: Before the target element itselfafterbegin: Inside the target element, before its first childbeforeend: Inside the target element, after its last childafterend: After the target element itself
insert_adjacent_text(
batch: String, # [null] - add the operation to a named batch
cancel: Boolean, # [false] - cancel the operation (for use on client)
delay: Integer, # [0] - wait for n milliseconds before running
focus_selector: String, # [null] - string containing a CSS selector
position: String, # [beforeend] - the relative position to the DOM element (beforebegin, afterbegin, beforeend, afterend)
select_all: Boolean, # [false] - operate on list of elements returned from selector
selector: String, # required - string containing a CSS selector or XPath expression
text: String, # [null] - the text to insert
xpath: Boolean # [false] - process the selector as an XPath expression
)
cable-ready:before-insert-adjacent-textcable-ready:after-insert-adjacent-text
Fast lightweight DOM diffing/patching without a virtual DOM.
morph(
batch: String, # [null] - add the operation to a named batch
cancel: Boolean, # [false] - cancel the operation (for use on client)
children_only: Boolean, # [false] - indicates if only child nodes should be morphed... skipping the parent element
content: String, # reference - the content that is going to be used to morph
delay: Integer, # [0] - wait for n milliseconds before running
focus_selector: String, # [null] - string containing a CSS selector
html: String, # [null] - the HTML to assign
permanent_attribute_name: String, # [null] - an attribute name that prevents elements from being updated i.e. "data-permanent"
select_all: Boolean, # [false] - operate on list of elements returned from selector
selector: String, # required - string containing a CSS selector or XPath expression
xpath: Boolean # [false] - process the selector as an XPath expression
)
When morphing an element with
children_only: true you need to make sure that the content you're providing to the html value will result in a successful operation:- it must have a single top-level container element with the same CSS selector as the target
Consider the following example of
#foo, a successful morphing candidate:show.html.erb
<div>
<%= render partial: "foo", locals: {message: "Am I the medium or the massage?"} %>
</div>
_foo.html.erb
<div id="foo">
<span><%= message %></span>
</div>
If the
<div id="foo"> was located in show.html.erb the morph would not succeed because the top-level container that you're replacing would not be present in the replacement HTML.If you need to render a collection of partials, you'll have to wrap the render method in a container because you cannot have the top-level container in each partial:
show.html.erb
<div id="bar">
<%= render collection: @bars %>
</div>
_bar.html.erb
<span><%= bar.message %></span>
morph(
children_only: true,
selector: "#bar",
html: "<div id=\"bar\">" + render(Bar.all) + "</div>"
)
cable-ready:before-morphcable-ready:after-morph
As with all operations, you can modify the items in the
event.detail object inside of a before-morph to change the parameters of how the operation will be executed.The
morph operation's event.detail object has a special key called content which is a direct reference to the internal template element's content accessor holding the document fragment that will be morphed into your DOM.This means that you can change the content which will soon be morphed into your page, but you cannot assign the
content to a new value. Doing so would remove the reference!Instead, use the DOM API and mutate children inside of the content:
document.addEventListener('cable-ready:before-morph', event => {
event.detail.content.querySelector('#foo').setStyle('color', 'red')
})
Replaces a DOM element with new HTML.
outer_html(
batch: String, # [null] - add the operation to a named batch
cancel: Boolean, # [false] - cancel the operation (for use on client)
delay: Integer, # [0] - wait for n milliseconds before running
focus_selector: String, # [null] - string containing a CSS selector
html: String, # [null] - the HTML to use as replacement
select_all: Boolean, # [false] - operate on list of elements returned from selector
selector: String, # required - string containing a CSS selector or XPath expression
xpath: Boolean # [false] - process the selector as an XPath expression
)
cable-ready:before-outer-htmlcable-ready:after-outer-html
Inserts HTML into the DOM, inside the target element, before its first child.
prepend(
batch: String, # [null] - add the operation to a named batch
cancel: Boolean, # [false] - cancel the operation (for use on client)
delay: Integer, # [0] - wait for n milliseconds before running
focus_selector: String, # [null] - string containing a CSS selector
html: String, # [null] - the HTML to assign
select_all: Boolean, # [false] - operate on list of elements returned from selector
selector: String, # required - string containing a CSS selector or XPath expression
xpath: Boolean # [false] - process the selector as an XPath expression
)
cable-ready:before-prependcable-ready:after-prepend
Removes an element from the DOM.
remove(
batch: String, # [null] - add the operation to a named batch
cancel: Boolean, # [false] - cancel the operation (for use on client)
delay: Integer, # [0] - wait for n milliseconds before running
focus_selector: String, # [null] - string containing a CSS selector
select_all: Boolean, # [false] - operate on list of elements returned from selector
selector: String, # required - string containing a CSS selector or XPath expression
xpath: Boolean # [false] - process the selector as an XPath expression
)
cable-ready:before-removecable-ready:after-remove
Replaces a DOM element with new HTML. This operation is an alias of outer_html and has the same implementation.
replace(
batch: String, # [null] - add the operation to a named batch
cancel: Boolean, # [false] - cancel the operation (for use on client)
delay: Integer, # [0] - wait for n milliseconds before running
focus_selector: String, # [null] - string containing a CSS selector
html: String, # [null] - the HTML to use as replacement
select_all: Boolean, # [false] - operate on list of elements returned from selector
selector: String, # required - string containing a CSS selector or XPath expression
xpath: Boolean # [false] - process the selector as an XPath expression
)
cable-ready:before-replacecable-ready:after-replace
Sets the text content of a DOM element.
CableReady sets
textContent instead of innerText. You can learn more here, or just move on with your day. ☀️text_content(
batch: String, # [null] - add the operation to a named batch
cancel: Boolean, # [false] - cancel the operation (for use on client)
delay: Integer, # [0] - wait for n milliseconds before running
focus_selector: String, # [null] - string containing a CSS selector
select_all: Boolean, # [false] - operate on list of elements returned from selector
selector: String, # required - string containing a CSS selector or XPath expression
text: String, # [null] - the text to assign
xpath: Boolean # [false] - process the selector as an XPath expression
)
cable-ready:before-text-contentcable-ready:after-text-content
Last modified 1yr ago