Fast, flexible, and lean implementation of core jQuery designed specifically for the server.
Teach your server HTML.
var cheerio = require('cheerio'),
$ = cheerio.load('<h2 class="title">Hello world</h2>');
$('h2.title').text('Hello there!');
$('h2').addClass('welcome');
$.html();
//=> <h2 class="title welcome">Hello there!</h2>npm install cheerio
❤ Familiar syntax: Cheerio implements a subset of core jQuery. Cheerio removes all the DOM inconsistencies and browser cruft from the jQuery library, revealing its truly gorgeous API.
ϟ Blazingly fast: Cheerio works with a very simple, consistent DOM model. As a result parsing, manipulating, and rendering are incredibly efficient. Preliminary end-to-end benchmarks suggest that cheerio is about 8x faster than JSDOM.
❁ Incredibly flexible: Cheerio wraps around @FB55's forgiving htmlparser2. Cheerio can parse nearly any HTML or XML document.
I wrote cheerio because I found myself increasingly frustrated with JSDOM. For me, there were three main sticking points that I kept running into again and again:
• JSDOM's built-in parser is too strict: JSDOM's bundled HTML parser cannot handle many popular sites out there today.
• JSDOM is too slow: Parsing big websites with JSDOM has a noticeable delay.
• JSDOM feels too heavy: The goal of JSDOM is to provide an identical DOM environment as what we see in the browser. I never really needed all this, I just wanted a simple, familiar way to do HTML manipulation.
Cheerio will not solve all your problems. I would still use JSDOM if I needed to work in a browser-like environment on the server, particularly if I wanted to automate functional tests.
<u
F438
l id="fruits">
<li class="apple">Apple</li>
<li class="orange">Orange</li>
<li class="pear">Pear</li>
</ul>This is the HTML markup we will be using in all of the API examples.
First you need to load in the HTML. This step in jQuery is implicit, since jQuery operates on the one, baked-in DOM. With Cheerio, we need to pass in the HTML document.
This is the preferred method:
var cheerio = require('cheerio'),
$ = cheerio.load('<ul id="fruits">...</ul>');Optionally, you can also load in the HTML by passing the string as the context:
$ = require('cheerio');
$('ul', '<ul id="fruits">...</ul>');Or as the root:
$ = require('cheerio');
$('li', 'ul', '<ul id="fruits">...</ul>');You can also pass an extra object to .load() if you need to modify any
of the default parsing options:
$ = cheerio.load('<ul id="fruits">...</ul>', {
normalizeWhitespace: true,
xmlMode: true
});These parsing options are taken directly from htmlparser2, therefore any options that can be used in htmlparser2 are valid in cheerio as well. The default options are:
{
normalizeWhitespace: false,
xmlMode: false,
decodeEntities: true
}For a full list of options and their effects, see this and htmlparser2's options.
Cheerio's selector implementation is nearly identical to jQuery's, so the API is very similar.
selector searches within the context scope which searches within the root scope. selector and context can be an string expression, DOM Element, array of DOM elements, or cheerio object. root is typically the HTML document string.
This selector method is the starting point for traversing and manipulating the document. Like jQuery, it's the primary method for selecting elements in the document, but unlike jQuery it's built on top of the CSSSelect library, which implements most of the Sizzle selectors.
$('.apple', '#fruits').text()
//=> Apple
$('ul .pear').attr('class')
//=> pear
$('li[class=orange]').html()
//=> <li class="orange">Orange</li>Methods for getting and modifying attributes.
Method for getting and setting attributes. Gets the attribute value for only the first element in the matched set. If you set an attribute's value to null, you remove that attribute. You may also pass a map and function like jQuery.
$('ul').attr('id')
//=> fruits
$('.apple').attr('id', 'favorite').html()
//=> <li class="apple" id="favorite">Apple</li>See http://api.jquery.com/attr/ for more information
Method for getting and setting data attributes. Gets or sets the data attribute value for only the first element in the matched set.
$('<div data-apple-color="red"></div>').data()
//=> { appleColor: 'red' }
$('<div data-apple-color="red"></div>').data('apple-color')
//=> 'red'
var apple = $('.apple').data('kind', 'mac')
apple.data('kind')
//=> 'mac'See http://api.jquery.com/data/ for more information
Method for getting and setting the value of input, select, and textarea. Note: Support for map, and function has not been added yet.
$('input[type="text"]').val()
//=> input_text
$('input[type="text"]').val('test').html()
//=> <input type="text" value="test"/>Method for removing attributes by name.
$('.pear').removeAttr('class').html()
//=> <li>Pear</li>Check to see if any of the matched elements have the given className.
$('.pear').hasClass('pear')
//=> true
$('apple').hasClass('fruit')
//=> false
$('li').hasClass('pear')
//=> trueAdds class(es) to all of the matched elements. Also accepts a function like jQuery.
$('.pear').addClass('fruit').html()
//=> <li class="pear fruit">Pear</li>
$('.apple').addClass('fruit red').html()
//=> <li class="apple fruit red">Apple</li>See http://api.jquery.com/addClass/ for more information.
Removes one or more space-separated classes from the selected elements. If no className is defined, all classes will be removed. Also accepts a function like jQuery.
$('.pear').removeClass('pear').html()
//=> <li class="">Pear</li>
$('.apple').addClass('red').removeClass().html()
//=> <li class="">Apple</li>See http://api.jquery.com/removeClass/ for more information.
Add or remove class(es) from the matched elements, depending on either the class's presence or the value of the switch argument. Also accepts a function like jQuery.
$('.apple.green').toggleClass('fruit green red').html()
//=> <li class="apple fruit red">Apple</li>
$('.apple.green').toggleClass('fruit green red', true).html()
//=> <li class="apple green fruit red">Apple</li>See http://api.jquery.com/toggleClass/ for more information.
Checks the current list of elements and returns true if any of the elements match the selector. If using an element or Cheerio selection, returns true if any of the elements match. If using a predicate function, the function is executed in the context of the selected element, so this refers to the current element.
Encode a set of form elements as an array of names and values.
$('<form><input name="foo" value="bar" /></form>').serializeArray()
//=> [ { name: 'foo', value: 'bar' } ]Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.
$('#fruits').find('li').length
//=> 3
$('#fruits').find($('.apple')).length
//=> 1Get the parent of each element in the current set of matched elements, optionally filtered by a selector.
$('.pear').parent().attr('id')
//=> fruitsGet a set of parents filtered by selector of each element in the current set of match elements.
$('.orange').parents().length
// => 2
$('.orange').parents('#fruits').length
// => 1Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector, DOM node, or cheerio object.
$('.orange').parentsUntil('#food').length
// => 1For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.
$('.orange').closest()
// => []
$('.orange').closest('.apple')
// => []
$('.orange').closest('li')
// => [<li class="orange">Orange</li>]
$('.orange').closest('#fruits')
// => [<ul id="fruits"> ... </ul>]Gets the next sibling of the first selected element, optionally filtered by a selector.
$('.apple').next().hasClass('orange')
//=> trueGets all the following siblings of the first selected element, optionally filtered by a selector.
$('.apple').nextAll()
//=> [<li class="orange">Orange</li>, <li class="pear">Pear</li>]
$('.apple').nextAll('.orange')
//=> [<li class="orange">Orange</li>]Gets all the following siblings up to but not including the element matched by the selector, optionally filtered by another selector.
$('.apple').nextUntil('.pear')
//=> [<li class="orange">Orange</li>]Gets the previous sibling of the first selected element optionally filtered by a selector.
$('.orange').prev().hasClass('apple')
//=> trueGets all the preceding siblings of the first selected element, optionally filtered by a selector.
$('.pear').prevAll()
//=> [<li class="orange">Orange</li>, <li class="apple">Apple</li>]
$('.pear').prevAll('.orange')
//=> [<li class="orange">Orange</li>]Gets all the preceding siblings up to but not including the element matched by the selector, optionally filtered by another selector.
$('.pear').prevUntil('.apple')
//=> [<li class="orange">Orange</li>]Gets the elements matching the specified range
$('li').slice(1).eq(0).text()
//=> 'Orange'
$('li').slice(1, 2).length
//=> 1Gets the first selected element's siblings, excluding itself.
$('.pear').siblings().length
//=> 2
$('.pear').siblings('.orange').length
//=> 1Gets the children of the first selected element.
$('#fruits').children().length
//=> 3
$('#fruits').children('.pear').text()
//=> PearGets the children of each element in the set of matched elements, including text and comment nodes.
$('#fruits').contents().length
//=> 3Iterates over a cheerio object, executing a function for each matched element. When the callback is fired, the function is fired in the context of the DOM element, so this refers to the current element, which is equivalent to the function parameter element. To break out of the each loop early, return with false.
var fruits = [];
$('li').each(function(i, elem) {
fruits[i] = $(this).text();
});
fruits.join(', ');
//=> Apple, Orange, PearPass each element in the current matched set through a function, producing a new Cheerio object containing the return values. The function can return an individual data item or an array of data items to be inserted into the resulting set. If an array is returned, the elements inside the array are inserted into the set. If the function returns null or undefined, no element will be inserted.
$('li').map(function(i, el) {
// this === el
return $(this).text();
}).get().join(' ');
//=> "apple orange pear"Iterates over a cheerio object, reducing the set of selector elements to those that match the selector or pass the function's test. When a Cheerio selection is specified, return only the elements contained in that selection. When an element is specified, return only that element (if it is contained in the original selection). If using the function method, the function is executed in the context of the selected element, so this refers to the current element.
Selector:
$('li').filter('.orange').attr('class');
//=> orangeFunction:
$('li').filter(function(i, el) {
// this === el
return $(this).attr('class') === 'orange';
}).attr('class')
//=> orangeRemove elements from the set of matched elements. Given a jQuery object that represents a set of DOM elements, the .not() method constructs a new jQuery object from a subset of the matching elements. The supplied selector is tested against each element; the elements that don't match the selector will be included in the result. The .not() method can take a function as its argument in the same way that .filter() does. Elements for which the function returns true are excluded from the filtered set; all other elements are included.
Selector:
$('li').not('.apple').length;
//=> 2Function:
$('li').not(function(i, el) {
// this === el
return $(this).attr('class') === 'orange';
}).length;
//=> 2Filters the set of matched elements to only those which have the given DOM element as a descendant or which have a descendant that matches the given selector. Equivalent to .filter(':has(selector)').
Selector:
$('ul').has('.pear').attr('id');
//=> fruitsElement:
$('ul').has($('.pear')[0]).attr('id');
//=> fruitsWill select the first element of a cheerio object
$('#fruits').children().first().text()
//=> AppleWill select the last element of a cheerio object
$('#fruits').children().last().text()
//=> PearReduce the set of matched elements to the one at the specified index. Use .eq(-i) to count backwards from the last selected element.
$('li').eq(0).text()
//=> Apple
$('li').eq(-1).text()
//=> PearRetrieve the DOM elements matched by the Cheerio object. If an index is specified, retrieve one of the elements matched by the Cheerio object:
$('li').get(0).tagName
//=> liIf no index is specified, retrieve all elements matched by the Cheerio object:
$('li').get().length
//=> 3Search for a given element from among the matched elements.
$('.pear').index()
//=> 2
$('.orange').index('li')
//=> 1
$('.apple').index($('#fruit, li'))
//=> 1End the most recent filtering operation in the current chain and return the set of matched elements to its previous state.
$('li').eq(0).end().length
//=> 3Add elements to the set of matched elements.
$('.apple').add('.orange').length
//=> 2Add the previous set of elements on the stack to the current set, optionally filtered by a selector.
$('li').eq(0).addBack('.orange').length
//=> 2Methods for modifying the DOM structure.
Inserts content as the last child of each of the selected elements.
$('ul').append('<li class="plum">Plum</li>')
$.html()
//=> <ul id="fruits">
// <li class="apple">Apple</li>
// <li class="orange">Orange</li>
// <li class="pear">Pear</li>
// <li class="plum">Plum</li>
// </ul>Inserts content as the first child of each of the selected elements.
$('ul').prepend('<li class="plum">Plum</li>')
$.html()
//=> <ul id="fruits">
// <li class="plum">Plum</li>
// <li class="apple">Apple</li>
// <li class="orange">Orange</li>
// <li class="pear">Pear</li>
// </ul>Insert content next to each element in the set of matched elements.
$('.apple').after('<li class="plum">Plum</li>')
$.html()
//=> <ul id="fruits">
// <li class="apple">Apple</li>
// <li class="plum">Plum</li>
// <li class="orange">Orange</li>
// <li class="pear">Pear</li>
// </ul>Insert every element in the set of matched elements after the target.
$('<li class="plum">Plum</li>').insertAfter('.apple')
$.html()
//=> <ul id="fruits">
// <li class="apple">Apple</li>
// <li class="plum">Plum</li>
// <li class="orange">Orange</li>
// <li class="pear">Pear</li>
// </ul>Insert content previous to each element in the set of matched elements.
$('.apple').before('<li class="plum">Plum</li>')
$.html()
//=> <ul id="fruits">
// <li class="plum">Plum</li>
// <li class="apple">Apple</li>
// <li class="orange">Orange</li>
// <li class="pear">Pear</li>
// </ul>Insert every element in the set of matched elements before the target.
$('<li class="plum">Plum</li>').insertBefore('.apple')
$.html()
//=> <ul id="fruits">
// <li class="plum">Plum</li>
// <li class="apple">Apple</li>
// <li class="orange">Orange</li>
// <li class="pear">Pear</li>
// </ul>Removes the set of matched elements from the DOM and all their children. selector filters the set of matched elements to be removed.
$('.pear').remove()
$.html()
//=> <ul id="fruits">
// <li class="apple">Apple</li>
// <li class="orange">Orange</li>
// </ul>Replaces matched elements with content.
var plum = $('<li class="plum">Plum</li>')
$('.pear').replaceWith(plum)
$.html()
//=> <ul id="fruits">
// <li class="apple">Apple</li>
// <li class="orange">Orange</li>
// <li class="plum">Plum</li>
// </ul>Empties an element, removing all its children.
$('ul').empty()
$.html()
//=> <ul id="fruits"></ul>Gets an html content string from the first selected element. If htmlString is specified, each selected element's content is replaced by the new content.
$('.orange').html()
//=> Orange
$('#fruits').html('<li class="mango">Mango</li>').html()
//=> <li class="mango">Mango</li>