xml 2.1.5

A lightweight library for parsing, traversing, querying and building XML documents.

Dart XML

Dart XML is a lightweight library for parsing, traversing, querying and building XML documents.

This library is open source, stable and well tested. Development happens on GitHub. Feel free to report issues or create a pull-request there. The most recent stable versions are available through pub.dartlang.org. General questions are best asked on StackOverflow.

Continuous build results are available from Jenkins. Up-to-date documentation is created automatically with every new push.

Basic Usage

Installation

Add the dependency to your package's pubspec.yaml file:

dependencies:
  xml: ">=2.0.0 <3.0.0"

Then on the command line run:

$ pub get

To import the package into your Dart code write:

import 'package:xml/xml.dart';

Reading and Writing

To read XML input use the top-level function parse(String input):

var bookshelfXml = '''<?xml version="1.0"?>
    <bookshelf>
      <book>
        <title lang="english">Growing a Language</title>
        <price>29.99</price>
      </book>
      <book>
        <title lang="english">Learning XML</title>
        <price>39.95</price>
      </book>
      <price>132.00</price>
    </bookshelf>''';
var document = parse(bookshelfXml);

The resulting object is an instance of XmlDocument. In case the document cannot be parsed, a ParseError is thrown.

To write back the parsed XML document simply call toString():

print(document.toString());

Traversing and Querying

Accessors allow to access nodes in the XML tree:

• attributes returns an iterable over the attributes of the current node.
• children returns an iterable over the children of the current node.

There are various methods to traverse the XML tree along its axes:

• preceding returns an iterable over nodes preceding the opening tag of the current node in document order.
• descendants returns an iterable over the descendants of the current node in document order. This includes the attributes of the current node, its children, the grandchildren, and so on.
• following the nodes following the closing tag of the current node in document order.
• ancestors returns an iterable over the ancestor nodes of the current node, that is the parent, the grandparent, and so on. Note that this is the only iterable that traverses nodes in reverse document order.

For example, the descendants iterator could be used to extract all textual contents from an XML tree:

var textual = document.descendants
    .where((node) => node is XmlText && !node.text.trim().isEmpty)
    .join('\n');
print(textual);

Additionally, there are helpers to find elements with a specific tag:

• findElements(String name) finds direct children of the current node with the provided tag name.
• findAllElements(String name) finds direct and indirect children of the current node with the provided tag name.

For example, to find all the nodes with the