Promote the UbuntuWebView as an official API

Bug #1324180 reported by Pat McGowan
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Ubuntu UI Toolkit
Fix Released
Critical
Unassigned
webbrowser-app
Fix Released
High
Olivier Tilloy
webbrowser-app (Ubuntu)
Fix Released
Undecided
Unassigned

Bug Description

Currently our UbuntuWebview implementations are in Ubuntu.Components.Extras.Browser. These are not documented on d.u.c.

This should move to a new namespace (i.e. Ubuntu.Browser or Ubuntu.Web for example) and can maintain the UbuntuWebView name. However I would prefer not putting Ubuntu in the object name as its both redundant with the namespace and not conducive to reuse by others. Note we should not use simply WebView as that will collide with the webkit version.

We need to determine if any apps currently use this api even though it was not promoted as an official part of the toolkit. If so we may need to maintain the old naming for some time in parallel if possible.

Tags: rtm14

Related branches

Revision history for this message
Olivier Tilloy (osomon) wrote :

A significant number of webapps use the UbuntuWebView component already, so we will definitely need to maintain the old naming.

Changed in ubuntu-ui-toolkit:
status: New → Confirmed
Changed in webbrowser-app:
assignee: nobody → Olivier Tilloy (osomon)
status: New → Confirmed
Changed in ubuntu-ui-toolkit:
assignee: Olivier Tilloy (osomon) → nobody
Bill Filler (bfiller)
tags: added: rtm14
Bill Filler (bfiller)
Changed in webbrowser-app:
importance: Undecided → High
Revision history for this message
Olivier Tilloy (osomon) wrote :

> Note we should not use simply WebView as that will collide with
> the webkit version.

Actually, it’s probably fine to simply use WebView, as QML supports qualified module imports that allow doing:

  import QtWebKit 3.1 as WebKit
  import Ubuntu.Web 0.2 as Ubuntu

  WebKit.WebView {}
  Ubuntu.WebView {}

Olivier Tilloy (osomon)
Changed in webbrowser-app:
status: Confirmed → In Progress
Revision history for this message
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package webbrowser-app - 0.23+14.10.20140609-0ubuntu1

---------------
webbrowser-app (0.23+14.10.20140609-0ubuntu1) utopic; urgency=low

  [ Ubuntu daily release ]
  * New rebuild forced

  [ Olivier Tilloy ]
  * Move version 0.2 of the API to "Ubuntu.Web" namespace, rename
    "UbuntuWebView" to "WebView", and document the public API intended
    for application developers. The legacy namespace and component name
    are kept around for compatibility with existing applications.
    Version 0.1 of the API remains untouched (it is deprecated).
    Packaging changes: - new qtdeclarative5-ubuntu-web-plugin package
    that contains the new namespace and name for the public QML API -
    updated runtime dependencies for webbrowser-app, webapp-container
    and qtdeclarative5-ubuntu-ui-extras-browser-plugin - updated
    descriptions for all packages - added missing multiarch stanza for
    webapp-container-autopilot - added missing predepends stanzas for
    multiarch packages (LP: #1324180)
 -- Ubuntu daily release <email address hidden> Mon, 09 Jun 2014 10:44:31 +0000

Changed in webbrowser-app (Ubuntu):
status: New → Fix Released
Revision history for this message
Olivier Tilloy (osomon) wrote :

Almost done, what remains to be done is polish the documentation and publish it on developer.ubuntu.com.

Bill Filler (bfiller)
Changed in webbrowser-app:
status: In Progress → Fix Released
Revision history for this message
Olivier Tilloy (osomon) wrote :

Moving back to "in progress" as the documentation is not publicly available yet.

Changed in webbrowser-app:
status: Fix Released → In Progress
Revision history for this message
Olivier Tilloy (osomon) wrote :

Documentation is now available online at http://developer.ubuntu.com/api/qml/sdk-14.10/Ubuntu.Web/.

Changed in webbrowser-app:
status: In Progress → Fix Released
Changed in ubuntu-ui-toolkit:
status: Confirmed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.