Skip to content

Windows 10 Progress Tracker

David Buschtöns edited this page Sep 21, 2016 · 29 revisions

This document tracks the progress of the Windows 10 Tabris.js client development.

  • Current Windows-App Version: 0.3.0
  • Current Tabris.js Version: 1.8.0

Table of Contents

Windows-only API

This section documents implemented experimental API not available on the other clients. These are subject to change until the client is out of alpha development.

Back to TOC

Widget

Properties

win_theme

Allowed values are "light", "dark" and "default".
Initial value is "default".
When set to default the theme is inherited from the parent, or in case of tabris.ui (which is the root element) from the OS settings.

tabris.ui

Properties

win_toolbarTheme

Allowed values are "light", "dark" and "default".
Initial value is "default".
Same as above, but since the toolbar is not a separate widget in the tabris API, an additional property is required.

tabris.device

Properties

keyboardPresent

Readonly.
Possible values are true and false.
Returns true if a hardware keyboard is present. The developer may choose to handle some user input differently in that case.

primaryInput

Readonly.
Possible values are "touch" and "mouse".
Returns "touch" on phones and in Windows 10 (PC) tablet mode, otherwise "mouse". The value may change at runtime.

Drawer

Properties

win_DisplayMode

Allowed values are "overlay", "compactOverlay".
Initial value is "overlay".
The value "overlay" matches the android/iOs behavior. With "compactOverlay" the the drawer never completely closes but stays partially visible (currently 48px). More modes could be supported in the future.

win_buttonBackground

Allows any color value.
Initial value is null.
Sets the background color of the button that opens the drawer.

Action

Properties

win_symbol

Allows any string.
Initial value is an empty string.
This property allows to override the Action image with an MDL2 (the "metro" icon font) symbol. When the string is not the name of an MDL2 symbol (starting with an upper case), the image set on the action is displayed instead. Other platforms ignore the property and always show the image.

App

Properties

win_theme

// TODO

Existing Tabris.js API Support

This documents which established Tabris.js is already supported by the Windows 10 client.

Back to TOC

Non-Widget

tabris.app

  • Creation

Methods

  • installPatch(url, callback)
  • reload()

Events

  • "backnavigation"
  • "pause"
  • "resume"

tabris.device

  • Creation

Properties

  • language
  • model
  • orientation
  • platform
  • scaleFactor
  • screenHeight
  • screenWidth
  • version

Events

  • "change:orientation" (device, orientation, options)

Page

  • Creation

Methods

  • close()
  • open()

Properties

  • image
  • title
  • topLevel

Events

  • "appear" (widget)
  • "disappear" (widget)

Drawer

  • Creation

Methods

  • close()
  • open()

window

Methods

  • clearInterval(id)
  • clearTimeout(id)
  • setInterval(callback, delay)
  • setInterval(callback, delay, param*)
  • setTimeout(callback)
  • setTimeout(callback, delay)
  • setTimeout(callback, delay, param*)

XMLHttpRequest

Methos

  • open(method, url, async, username, password)
  • send(data) (:exclamation: partial - local file loading not supported)
  • abort

Properties

  • readyState
  • timeout
  • response
  • responseText
  • status
  • statusText
  • withCredentials

Events

  • readystatechange (:exclamation: partial - not triggered in all cases)
  • load
  • loadend
  • progress (:exclamation: partial - not triggered in all cases)
  • abort (:exclamation: partial - not triggered in all cases)
  • timeout
  • error

localStorage

Methods

Widgets

Widget

Methods

  • animate(properties, options) (:exclamation: partial - some options not supported)
  • appendTo(parent)
  • dispose()

Properties

  • background
    • set
    • get
  • backgroundImage
  • bounds
    • set
    • get
  • enabled
  • font
  • highlightOnTouch
  • layoutData (absolute left/right)
  • layoutData (width/height)
  • layoutData (absolute top/bottom)
  • layoutData (relative left/right/top/bottom)
  • layoutData (percentage left/right/top/bottom)
  • layoutData (centerX/centerY)
  • layoutData (baseline) (:exclamation: partial - only align widget bottom)
  • opacity
  • textColor
    • set
    • get
  • visible
  • cornerRadius
  • elevation

Events

  • "animationend" (widget, options)
  • "animationstart" (widget, options)
  • "longpress" (widget, gesture)
  • "pan" (widget, gesture) ( ❗ partial - missing event parameters)
  • "pan:{direction}" (widget, gesture) ( ❗ partial - missing event parameters)
  • "resize" (widget, bounds, options)
  • "swipe:{direction}" (widget, gesture)
  • "tap" (widget, gesture)
  • "touchcancel" (widget, gesture)
  • "touchend" (widget, gesture)
  • "touchmove" (widget, gesture)
  • "touchstart" (widget, gesture)

tabris.ui

  • Creation

Properties

  • activePage
  • background
  • textColor
  • toolbarVisible
  • displayMode
  • statusBarTheme

Events

  • "change:activePage" (ui, page, options)

ActivityIndicator

  • Creation

Action

  • Creation

Properties

  • image
  • placementPriority
  • title

Events

  • "select" (widget)

Button

  • Creation

Properties

  • alignment
  • image
  • text

Events

  • "select" (widget)

Canvas

  • Creation

Methods

  • getContext(contextType, width, height)

CanvasContext

  • Creation

Properties

  • lineWidth
  • lineCap
  • lineJoin
  • fillStyle
  • strokeStyle
  • textAlign
  • textBaseline

Methods

  • save
  • restore
  • beginPath
  • closePath
  • lineTo
  • moveTo
  • bezierCurveTo
  • quadraticCurveTo
  • rect
  • arc
  • scale
  • rotate
  • translate
  • transform
  • setTransform
  • clearRect
  • fillRect
  • strokeRect
  • fillText
  • strokeText
  • fill
  • stroke
  • measureText

Cell

  • Creation

Properties

  • item
  • itemIndex

Events

  • "change:item" (widget, item, options)
  • "change:itemIndex" (widget, itemIndex, options)

CheckBox

  • Creation

Properties

  • selection
  • text

Events

  • "change:selection" (widget, selection, options)
  • "select" (widget, selection, options)

CollectionView

  • Creation

Methods

  • insert(items)
  • insert(items, index)
  • refresh()
  • refresh(index)
  • remove(index)
  • remove(index, count)
  • reveal(index)

Properties

  • cellType
  • initializeCell
  • itemHeight
  • items
  • refreshEnabled
  • refreshIndicator
  • refreshMessage
  • columnCount

Events

  • "refresh" (widget)
  • "select" (widget, item, options)

Composite

  • Creation

Methods

  • append(child, child*)
  • append(collection)

ImageView

  • Creation

Properties

  • image (:exclamation: partial - width/height/scale propertis do not behave exactly the same as in iOS/Android)
  • scaleMode
  • tintColor

Events

  • load

Picker

  • Creation

Properties

  • items
  • selection
  • selectionIndex

Events

  • "change:selection" (widget, selection, options)
  • "change:selectionIndex" (widget, selectionIndex, options)
  • "select" (widget, selection, options)

ProgressBar

  • Creation

Properties

  • maximum
  • minimum
  • selection
  • state

RadioButton

  • Creation

Properties

  • selection
  • text

Events

  • "change:selection" (widget, selection, options)
  • "select" (widget, selection, options)

ScrollView

  • Creation

Properties

  • direction

Events

  • "scroll" (widget, offset)

SearchAction

  • Creation

Properties

  • message
  • proposals
  • text

Events

  • "accept" (widget, text, options)
  • "input" (widget, text, options)

Slider

  • Creation

Properties

  • maximum
  • minimum
  • selection

Events

  • "change:selection" (widget, selection, options)
  • "select" (widget, selection, options)

Switch

Properties

  • selection

Events

  • "change:selection" (widget, selection, options)
  • "select" (widget, selection, options)

Tab

  • Creation (:exclamation: partial - no styling/colors supported)

Properties

  • badge
  • image
  • title

TabFolder

  • Creation

Methods

  • append(child, child*)

Properties

  • paging
  • selection
  • tabBarLocation

Events

  • "change:selection" (widget, selection, options)
  • "select" (widget, selection, options)

TextInput

  • Creation

Properties

  • alignment
  • autoCapitalize
  • autoCorrect
  • editable
  • keyboard
  • message
  • text
  • type

Events

  • "accept" (widget, text, options)
  • "blur" (widget)
  • "change:text" (widget, text, options)
  • "focus" (widget)
  • "input" (widget, text, options)

TextView

  • Creation

Properties

  • alignment
  • markupEnabled ( ❗ partial - currently supports only <b>)
  • maxLines
  • text
  • lineSpacing

ToggleButton

  • Creation

Properties

  • alignment
  • image
  • selection
  • text

Events

  • "change:selection" (widget, selection, options)
  • "select" (widget, selection, options)

Video

  • Creation

Properties

  • url

WebView

  • Creation

Properties

  • html
  • url

Events

  • "load" (widget)
  • "navigate" (widget, event)

Other Features

Back to TOC

  • Cordova Plug-In support (:exclamation: partial - most don't work)
  • Loading cordova.js from local file system when in remote mode
  • Cordova build integration (:exclamation: partial - currently requires full sources)
  • Splash Screen Configuration (via Cordova)
  • Store/Start-Screen Tile Configuration (via Cordova)
  • Config.xml "content" preference support
  • Config.xml "EnableDeveloperConsole" preference support
  • Config.xml "UseStrictSSL" preference support
  • Continues Integration
  • Local Build Download
  • Build Service
  • Developer App Tabris Connect integration
  • Share/Copy Console Log
  • Array Buffer Support