XElement API Overview

Welcome to our API section of the documentation, here you will find all you need to know about XElement API’s, what they are, how they work and most importantly how to use each API correctly.

The API’s that we have implemented into XElement is designed to be as intuitive as possible for the developer. Without trying to impose any new forms of expression or embed opinions or patterns into your existing knowledge base.

A key design decision was to allow developers to write JavaScript or Typescript that would work on the client. Allowing them to utilize all the DOM API’s that they know so well, without hinderance or obstruction.

There are a few rules in regards to the syntax about what goes in what and where. To this end we have given XElement very well supported Error boundaries to help keep the developer right as they write their components.

All this will make sense to you over a very short period of time. Otherwise you will be tripping up over TypeErrors and being flustered as a result.

This in our eyes is something that we really want to help prevent and provide you with an all round happy experience when you are using XElement

For a happy developer is a productive developer.

How to use

We decided to spilt the documentation for XElement’s API into a two forms. This we feel is to help provide information easily and make it more accessible to as many as we can.

We have placed the API overview pages at the top level of this section, to help give developers a very brief albeit informative use of the methods.

For each method we more detailed documentation which describes their individual behaviors and syntax inside the Methods section of these docs.

All the examples provided are given in Javascript form, these can be easily type annotated and this would be supported in XElement.

For properties bearing as titles, we will provide you with their type annotations also, to help give additional context to the properties and their respective types.

We will try too include any references to relevant external resource that we use at the bottom of each page, letting you explore further, by giving you get as much information that you need to you as possible.

Issues and Feedback

If you do get stuck and these guides are lacking in their explanation’s or directions, please do raise an issue. As you can sense we really do want to get these right for everybody.

Likewise if you find anything missing, or something awry with any of the information that is contained in these files.

Please do raise a PR or an Issue with the github repo and we will make the necessary corrections.

We will try our best to support your as much as possible, since you really are supporting us.