Skip to content
Type checked access to browser APIs for Java code.
Branch: master
Clone or download
jDramaix and Copybara-Service Javascript bindings for OffscreenCanvas.
PiperOrigin-RevId: 258530406
Latest commit 60b5880 Jul 17, 2019

README.md

Elemental2 · Build Status

Elemental2 provides type checked access to all browser APIs for Java code. This is done by using closure extern files and generating JsTypes, which are part of the new JsInterop specification that is both implemented in GWT and J2CL.

Build with bazel

If you want to modify and/or build the last version on your own, follow the instructions below:

  • Install Bazel.

  • clone this repository with git: git clone https://github.com/google/elemental2.git

  • Inside the repository, run the script build_gwt_mvn_jars.sh:

    $ ./build_gwt_mvn_jars.sh /path/to/output/directory
    

The jars are available in /path/to/output/directory directory. If you don't provide a argument to the script, the script will create a temporary directory for the generated jar.

Bazel dependencies

If your project use Bazel, add this repository as an external dependency in your WORKSPACE file:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "com_google_elemental2",
    strip_prefix = "elemental2-master",
    url = "https://github.com/google/elemental2/archive/master.zip",
)

load("@com_google_elemental2//build_defs:repository.bzl", "load_elemental2_repo_deps")
load_elemental2_repo_deps()

load("@com_google_elemental2//build_defs:workspace.bzl", "setup_elemental2_workspace")
setup_elemental2_workspace()

Now from you can add elemental2 targets as needed to your j2cl_library deps.

Following are the different elemental2 modules and their target names:

module Bazel targets for J2CL
core @com_google_elemental2//:elemental2-core-j2cl
dom @com_google_elemental2//:elemental2-dom-j2cl
promise @com_google_elemental2//:elemental2-promise-j2cl
indexeddb @com_google_elemental2//:elemental2-indexeddb-j2cl
svg @com_google_elemental2//:elemental2-svg-j2cl
webgl @com_google_elemental2//:elemental2-webgl-j2cl
media @com_google_elemental2//:elemental2-media-j2cl
webstorage @com_google_elemental2//:elemental2-webstorage-j2cl

Maven dependencies

If your project use Maven, add maven dependencies in your pom.xml:

<dependency>
  <groupId>com.google.elemental2</groupId>
  <artifactId>${artifact-id}</artifactId>
  <version>1.0.0-RC1</version>
</dependency>
module artifact-id
core elemental2-core
dom elemental2-dom
promise elemental2-promise
indexeddb elemental2-indexeddb
svg elemental2-svg
webgl elemental2-webgl
media elemental2-media
webstorage elemental2-webstorage

Download the jar files

You can also download manually the jars files.

module jar file
core elemental2-core.jar
dom elemental2-dom.jar
promise elemental2-promise.jar
indexeddb elemental2-indexeddb.jar
svg elemental2-svg.jar
webgl elemental2-webgl.jar
media elemental2-media.jar
webstorage elemental2-webstorage.jar

GWT

If you use Elemental2 with GWT, you need to inherit the right gwt module in your gwt.xml file:

module GWT module name
core elemental2.core.Core
dom elemental2.dom.Dom
promise elemental2.promise.Promise
indexeddb elemental2.indexeddb.IndexedDb
svg elemental2.svg.Svg
webgl elemental2.webgl.WebGl
media elemental2.media.Media
webstorage elemental2.webstorage.WebStorage

Contributing

Please refer to the contributing document.

Licensing

Please refer to the license file.

Disclaimer

This is not an official Google product.

You can’t perform that action at this time.