Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sparsetech/pine
Functional HTML5 and XML library for the Scala platform
https://github.com/sparsetech/pine
html5 manipulation rendering scala scala-native scalajs web-development
Last synced: 25 days ago
JSON representation
Functional HTML5 and XML library for the Scala platform
- Host: GitHub
- URL: https://github.com/sparsetech/pine
- Owner: sparsetech
- License: apache-2.0
- Created: 2015-07-31T19:10:07.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-12-10T15:32:52.000Z (about 4 years ago)
- Last Synced: 2024-08-04T00:05:23.177Z (4 months ago)
- Topics: html5, manipulation, rendering, scala, scala-native, scalajs, web-development
- Language: Scala
- Homepage:
- Size: 1.67 MB
- Stars: 107
- Watchers: 11
- Forks: 14
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-scala-native - Pine - HTML/XML parsing, manipulation and rendering. (File Formats and Parsers)
README
# 
[](https://travis-ci.org/sparsetech/pine)
[](http://ci.sparse.tech/sparsetech/pine)
[](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22tech.sparse%22%20AND%20a%3A%22pine_2.12%22)
Pine is a functional HTML5 and XML library for the Scala platform. It supports parsing, manipulating and rendering of HTML. Pine provides type-safe bindings for HTML5 generated from [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element). Tree nodes are immutable and can be constructed from compile-time or runtime HTML/XML content. The tree may be manipulated and rendered back as HTML or as a browser node.
## Features
* Immutable and typed trees
* Type-safe bindings, generated from MDN
* Support for custom elements and attributes
* HTML5 and XML parser based on recursive descent
* Macros for compile-time HTML string/file parsing
* Tree manipulation
* Rendering as HTML strings
* DSL for common operations
* Unit and property-based tests
* Few dependencies
### JavaScript back end
* Rendering as DOM nodes
* Updating nodes in DOM
* DSL for attaching/detaching events
## Compatibility
| Platform | Platform version | Scala versions |
|:-------------|:-----------------|:-----------------------------|
| JVM | | 2.11 (T), 2.12 (T), 2.13 (L) |
| Scala.js | 1.0 | 2.12 (T), 2.13 (L) |
| Scala Native | 0.4.0-M2 | 2.11 (T) |
* (T): Typelevel Scala
* (L): Lightbend Scala
## Examples
```scala
import pine._
val url = "http://github.com/"
val root = html"GitHub"
println(root.toHtml) // GitHub
```
### JavaScript
```scala
import pine.dom._
println(root.toDom) // [object HTMLAnchorElement]
```
## sbt
Pine makes use of a language extension called *literal types*, see [SIP-23](http://docs.scala-lang.org/sips/pending/42.type.html). For Scala 2.11 and 2.12, only [Typelevel Scala](https://github.com/typelevel/scala) implements this feature. However, it is available in Lightbend Scala from 2.13 onwards.
### 2.13 onwards
```scala
scalaVersion := "2."
libraryDependencies += scalaOrganization.value % "scala-reflect" % scalaVersion.value
```
### < 2.13
```scala
scalaVersion := "2.12.4-bin-typelevel-4" // or "2.11.11-bin-typelevel-4"
scalaOrganization := "org.typelevel"
scalacOptions += "-Yliteral-types"
libraryDependencies += scalaOrganization.value % "scala-reflect" % scalaVersion.value
```
#### Scala.js settings
```scala
libraryDependencies := libraryDependencies.value.filterNot(_.name == "scalajs-compiler")
addCompilerPlugin("org.scala-js" % "scalajs-compiler" % scalaJSVersion cross CrossVersion.patch)
```
#### Scala Native settings
```scala
libraryDependencies := libraryDependencies.value.filterNot(_.name == "nscplugin")
addCompilerPlugin("org.scala-native" % "nscplugin" % nativeVersion cross CrossVersion.patch)
```
### Dependencies
```scala
libraryDependencies += "tech.sparse" %% "pine" % "" // JVM
libraryDependencies += "tech.sparse" %%% "pine" % "" // JavaScript, Native
```
## Links
* [Documentation](http://sparse.tech/docs/pine.html)
* [ScalaDoc](https://www.javadoc.io/doc/tech.sparse/pine_2.12/)
## Licence
Pine is licensed under the terms of the Apache v2.0 licence.
## Contributors
* Tim Nieradzik
* Matt Hicks
* Anatoliy Kmetyuk
* Keven Wright