Skip to content

Latest commit

 

History

History
executable file
·
38 lines (24 loc) · 3.51 KB

README.md

File metadata and controls

executable file
·
38 lines (24 loc) · 3.51 KB
Raw

purescript-dom

Latest release Build Status Maintainer: garyb

Type definitions, low level interface implementations, and standard effect type for use while interacting with the DOM.

Installation

bower install purescript-dom

Introduction

purescript-dom is intended to provide a common base for projects that need to talk to or about the DOM.

The API isn't primarily intended for "human consumption", but instead aims to provide functions and types that match up with the interfaces described in the DOM4 and HTML5 specifications, with a minimal amount of additional opinion as to how they should be implemented in PureScript.

This consists of:

  • foreign data types for the various interfaces described.
  • Functions that read Foreign typed values (and IsForeign instances) for foreign types.
  • No classes or other niceties to aid with subtyping relationships. However, coercions are provided from subtypes to their supertypes. For example, from DOM.Node.Types, elementToNode.
  • Functions that can mutate the DOM, or that don't always return the same value, or return a value that may be mutated at a distance use Eff with the DOM effect
  • Enumeration values are provided as ADTs, but with an option to read the raw value too. For example, from DOM.Node.Node, nodeType and nodeTypeIndex.

Module structure

Interfaces from DOM4 are grouped under DOM.Node and interfaces from HTML5 are grouped under DOM.HTML, aside from event-related things which are grouped under DOM.Events. Additionally there are a few other useful DOM interfaces such as the File and XMLHttpRequest2 that have their own submodules.

In each submodule there is a .Types which should enumerate foreign data types for the interfaces within and the coercions and Foreign-reading functions that go with them. After that each interface should have its own submodule - so for example, Element is provided in DOM.Node.Types and the functions from the Element API are defined in DOM.Node.Element. Enumeration types such as NodeType also get their own modules, such as DOM.Node.NodeType.

Module documentation is published on Pursuit: http://pursuit.purescript.org/packages/purescript-dom

Non-standards compliant interfaces

Currently we're choosing not to implement deprecated or non-standard interfaces even if they are commonly available. The innerHTML property of Element and keyCode/charCode of KeyboardEvent being examples of this. Ideally this module will only provide types and functions that "everyone" can agree on. This also means new parts of the specifications that are currently not widely available may also be omitted for the time being, however this only applies to the API implementation, types for new interfaces will be included as needed.