android

android.setViewModel(data[, sessionId="0"])

Imports to be used for layout bindings associated by session.

Parameters:

  • data (AppViewModel) – Dictionary of imports and variables

  • sessionId (string) – Names a session to be used for storage

Usage:

squared.parseDocument(() => {
  android.setViewModel(
    {
      import: ["java.util.Map"],
      variable: [{ name: "map", type: "Map<String, String>" }]
    },
    squared.latest()
  );
});
android.setViewModelByProject(data[, projectId="_"])

Imports to be used for layout bindings associated by project.

Parameters:

  • data (AppViewModel) – Dictionary of imports and variables

  • projectId (string) – Names a project to be used for storage

Usage:

android.setViewModelByProject(
  {
    import: ["java.util.Map"],
    variable: [{ name: "map", type: "Map<String, String>" }]
  },
  "project-1"
);
await squared.parseDocument({ element: document.body, projectId: "project-1" });
android.addDependency(group, name[, version, type])

Include a dependency by group and name to an existing or newly created build.gradle. Uses the default project “_” for storage. Any existing dependency with the same group and name will be overwritten.

Parameters:

  • group (string) – Namespace of library

  • name (string) – Componenent name in library

  • version (string) – (optional) Exact version requested

  • type (number) – Dependency namespace method in Gradle

Returns:

Dictionary key or “”

Return type:

string

Requirements:

  • createBuildDependencies = true

Usage:

android.addDependency("androidx.core", "core", "1.12.0"); // Default is "implementation"
squared.copyTo("/path/project", { dependencyScopes: true }); // Will also include first-level sub-dependencies (optional)

Alternate:

android.addDependency("androidx.core", "core", DEPENDENCY_TYPE.COMPILE_ONLY, true); // Uses latest Maven published release
squared.copyTo("/path/project", { dependencyScopes: "snapshot" });
android.addDependencyByProject(projectId, group, name[, version, type])

Include a dependency to a project by group and name of an existing or newly created build.gradle. Any existing dependency in the project with the same group and name will be overwritten.

Parameters:

  • projectId (string) – Names a project to be used for storage

  • group (string) – Namespace of library

  • name (string) – Componenent name in library

  • version (string) – (optional) Exact version requested

  • type (number) – Dependency namespace method in Gradle

Returns:

Dictionary key or “”

Return type:

string

Requirements:

  • createBuildDependencies = true

Usage:

android.addDependencyByProject("project-1", "androidx.core", "core", "1.12.0"); // Default is "implementation"
squared.copyTo("/path/project", { projectId: "project-1", dependencyScopes: true }); // Will also include first-level sub-dependencies (optional)

Alternate:

android.addDependencyByProject("project-1", "androidx.core", "core", DEPENDENCY_TYPE.COMPILE_ONLY, true); // Uses latest Maven published release
squared.copyTo("/path/project", { projectId: "project-1", dependencyScopes: "snapshot" });
android.addFontProvider(authority, package, certs, webFonts)

Add additional Web fonts that can be searched for when resolving first available font family. Google Fonts is already included.

Parameters:

  • authority (string) – Class of font provider library

  • package (string) – Namespace of font provider

  • certs (array) – List of certificates the font provider is signed with

  • webFonts (string) – Web font service URL

Returns:

Success when installed

Return type:

Promise<boolean>

Requirements:

  • targetAPI >= 26

  • createDownloadableFonts = true

Usage:

await android.addFontProvider(
  "com.google.android.gms.fonts",
  "com.google.android.gms",
  ["MIIEqDCCA5CgAwIBAgIJANWFuGx9007...", "MIIEQzCCAyugAwIBAgIJAMLgh0Zk..."],
  "https://www.googleapis.com/webfonts/v1/webfonts?key=1234567890" // Pre-built JSON object is synchronous
);
android.addXmlNs(name, uri)

Aliases of global namespaces for third-party controls used when resolving layout attributes.

Parameters:

  • name (string) – Prefix to be used with attribute

  • uri (string) – Full URL namespace of schema

Usage:

android.addXmlNs("tools", "http://schemas.android.com/tools"); // https://developer.android.com/studio/write/tool-attributes
android.customize(16 /* Jelly Bean */, "ImageView", {
  tools: {
    ignore: "ContentDescription",
    targetApi: "16"
  }
});

Output:

<FrameLayout xmlns:tools="http://schemas.android.com/tools">
  <ImageView tools:ignore="ContentDescription" tools:targetApi="16">
</FrameLayout>
android.customize(api, widget, options)

Global attributes to be applied to every qualifying layout control possibly overwriting any auto-generated attributes.

Parameters:

  • api (number) – Android SDK build API version

  • widget (string) – Namespace of layout control

  • options (object) – Attributes to be applied to control

Returns:

Current state of API and widget

Return type:

object or undefined

Requirements:

  • customizationsBaseAPI >= 0

  • customizationsOverwritePrivilege = true

Usage:

android.customize(BUILD_VERSION.ALL /* 0 */, "Button", {
  android: {
    minWidth: "35px",
    minHeight: "25px"
  },
  "_": { // Non-namespaced attributes
    style: "@style/Widget.Material3.Button.TextButton"
  }
});

Output:

<Button
  android:minWidth="35dp"
  android:minHeight="25dp"
  style="@style/Widget.Material3.Button.TextButton" />
android.loadCustomizations(name)

Will merge any saved customizations from the same origin. Any previous calls to android.customize() may be overwritten.

Parameters:

name (string) – Unique identifier to be used for local storage

Usage:

squared.settings.targetAPI = BUILD_VERSION.T;
squared.settings.customizationsBaseAPI = 0; // Apply all customizations

android.loadCustomizations("customize-example"); // Any page in same domain

android.customize(BUILD_VERSION.T, "Button", { android: { minWidth: "25px" } });
android.customize(BUILD_VERSION.LATEST, "Button", { android: { minWidth: "30px" } });

Output:

<Button android:minWidth="25dp" android:minHeight="25dp" />

Alternate:

squared.settings.targetAPI = BUILD_VERSION.T;
squared.settings.customizationsBaseAPI = [BUILD_VERSION.T, BUILD_VERSION.LATEST];

Output:

<Button android:minWidth="30dp" android:minHeight="25dp" />
android.saveCustomizations(name)

Any valid customizations created using android.customize() will be saved to local storage.

Parameters:

name (string) – Unique identifier to be used for local storage

Usage:

android.customize(BUILD_VERSION.ALL /* 0 */, "Button", {
  android: {
    minWidth: "35px",
    minHeight: "25px"
  }
});
android.customize(BUILD_VERSION.NEXT /* 35 */, "Button", { // Invalid
  android: {
    minWidth: "35px",
    minHeight: "25px"
  }
});
android.resetCustomizations()

All customizations currently being used are deleted. Saved customizations in local storage are not affected.

Usage:

android.resetCustomizations();
android.setResolutionByDeviceName(value)

Sets the resolution when converting browser dimensions into Android device dimensions.

  • Phone

  • Medium Phone

  • Foldable

  • Tablet

  • Medium Tablet

  • Small Desktop

  • Medium Desktop

  • Desktop

  • Large Desktop

  • Pixel

  • Pixel XL

  • Pixel 2

  • Pixel 2 XL

  • Pixel 3

  • Pixel 3a

  • Pixel 3 XL

  • Pixel 3a XL

  • Pixel 4

  • Pixel 4 XL

  • Pixel 4a

  • Pixel 5

  • Pixel 6

  • Pixel 6a

  • Pixel 6 Pro

  • Pixel 7

  • Pixel 7a

  • Pixel 7 Pro

  • Pixel 8

  • Pixel 8a

  • Pixel 8 Pro

  • Pixel 9 Pro XL

  • Pixel 9

  • Pixel 9 Pro

  • Pixel Fold

  • Pixel 9 Fold

  • Pixel C

  • Pixel Tablet

  • Nexus 5X

  • Nexus 6

  • Nexus 6P

  • Nexus 7 2012

  • Nexus 7 (2012)

  • Nexus 7

  • Nexus 9

  • Nexus 10

  • TV 4K

  • TV 1080p

  • Television (4K)

  • Television (1080p)

  • TV 720p

  • Television (720p)

  • Automotive

  • Automotive (1024p landscape)

  • Automotive Portrait

  • Automotive Large Portrait

  • Automotive (1408p landscape)

  • Automotive Distant Display

  • Automotive (1080p landscape

  • Automotive Ultrawide

The exact configuration for each device can be found in the latest Android Studio.

Parameters:

name (string) – Predefined device name or generic layout

Returns:

Success when applied

Return type:

boolean

Usage:

android.setResolutionByDeviceName("Pixel 3a XL");

Output:

squared.settings.resolutionDPI = 411;
squared.settings.resolutionScreenWidth = 846;
squared.settings.resolutionScreenHeight = 560;
android.getLocalSettings()

Controller settings which are based on browser defaults can be modified. These are global changes and affect every call to parseDocument().

Returns:

Current modifiable state of settings

Return type:

ControllerSettingsUI

Usage:

const { layout, directory, filename, style, mimeType, unsupported, deviations, values } = android.getLocalSettings();

layout.fileExtension = ".xml";
directory.string = "res/values";
style.buttonBorderStyle = "inset";
android.removeObserver(element)

Forwards the target element to Application which will stop it from being monitored for changes.

Parameters:

element – HTMLElement instance

Returns:

Success when observed

Return type:

boolean

Usage:

await squared.parseDocument({
  element: document.body,
  observe(mutations, observer, settings) {
    console.log(mutations);
  }
});

android.removeObserver(document.body);