Permalink
Fetching contributors…
Cannot retrieve contributors at this time
58 lines (42 sloc) 10.1 KB

Liferay Screens

License Release Tag

iOS Platform Build Status

Android Platform Build Status

Overview

This repository contains the Liferay Screens source code, in addition to several example projects that illustrate how Screens is used. For detailed instructions on developing mobile apps with Screens, see the Screens documentation for Android, iOS and Xamarin on the Liferay Developer Network (LDN).

Brief descriptions of this repository's contents are listed here:

  • android: the Liferay Screens for Android codebase, View Sets, and example projects.
  • ios: the Liferay Screens for iOS codebase, Themes, and example projects.
  • xamarin: the Liferay Screens for Xamarin.Android and Xamarin.iOS codebases and example projects.

Available Screenlets

  • Login Screenlet [iOS / Android]: Signs users in to a Liferay instance.
  • Sign Up Screenlet [iOS / Android]: Registers new users in a Liferay instance.
  • Forgot Password Screenlet [iOS / Android]: Sends emails containing a new password or password reset link to users.
  • User Portrait Screenlet [iOS / Android]: Shows the user's portrait picture.
  • DDL Form Screenlet [iOS / Android]: Presents dynamic forms to be filled out by users and submitted back to the server.
  • DDL List Screenlet [iOS / Android]: Shows a list of records based on a pre-existing DDL in a Liferay instance.
  • Asset List Screenlet [iOS / Android]: Shows a list of assets managed by Liferay's Asset Framework. This includes web content, blog entries, documents, and more.
  • Web Content Display Screenlet [iOS / Android]: Shows the web content's HTML or structured content. This Screenlet uses the features available in Web Content Management.
  • Web Content List Screenlet [iOS / Android]: Shows a list of web contents from a folder, usually based on a pre-existing DDMStructure.
  • Image Gallery Screenlet [iOS / Android]: Shows a list of images from a folder. This Screenlet also lets users upload and delete images.
  • Rating Screenlet [iOS / Android]: Shows the rating for an asset. This Screenlet also lets the user update or delete the rating.
  • Comment List Screenlet [iOS / Android]: Shows a list of comments for an asset.
  • Comment Display Screenlet [iOS / Android]: Shows a single comment for an asset.
  • Comment Add Screenlet [iOS / Android]: Lets the user comment on an asset.
  • Asset Display Screenlet [iOS / Android]: Displays an asset. Currently, this Screenlet can display Documents and Media Library files (DLFileEntry entities), blogs articles (BlogsEntry entities), and web content articles (WebContent entities). You can also use it to display custom assets.
  • Blogs Entry Display Screenlet [iOS / Android]: Shows a single blogs entry.
  • Image Display Screenlet [iOS / Android]: Shows a single image file from a Liferay instance's Documents and Media Library.
  • Video Display Screenlet [iOS / Android]: Shows a single video file from a Liferay instance's Documents and Media Library.
  • Audio Display Screenlet [iOS / Android]: Shows a single audio file from a Liferay instance's Documents and Media Library.
  • PDF Display Screenlet [iOS / Android]: Shows a single PDF file from a Liferay instance's Documents and Media Library.
  • File Display Screenlet [iOS]: Shows a single file from a Liferay instance's Documents and Media Library. Use this Screenlet to display file types not covered by the other display Screenlets (e.g., DOC, PPT, XLS). Only available for iOS.
  • Web Screenlet [iOS / Android]: Displays any web page. You can also customize the web page through injection of local and remote JavaScript and CSS files.

Contributing

Liferay welcomes any and all contributions! Please read the Liferay Screens Contribution Guide for details on developing and submitting your contributions.

License

This library is free software ("Licensed Software"); you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; including but not limited to, the implied warranty of MERCHANTABILITY, NONINFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA