/com.bduyng.intropages

An Alloy widget to create welcome pages like AirBnB application.

Primary LanguageJavaScript

WARNING: 3.0 IS NOT BACKWARDS COMPATIBLE WITH 2.1

Alloy Intro Pages Appcelerator Alloy

An Alloy Widget to to create welcome pages like AirBnB application.

Screenshot

Screenshot

Get it gitTio npmJS

Install via gitTio:

$ gittio install com.bduyng.intropages

Or download a release, extract it to your app's app/widgets/com.bduyng.intropages folder and add the dependency to your config.json:

{
    ..
    "dependencies": {
        "com.bduyng.intropages": "*",
        "au.jkotchoff.scrollableView": "*"
        ..
    }
}

Use it

Feel free to modify if needed. Requires au.jkotchoff.scrollableView to be installed too.

index.xml

<Alloy>
    <Widget id="intro" src="com.bduyng.intropages"></Widget>
</Alloy>

index.tss

"#intro": {
    /**
     * This should be an array with all the views and their options
     * @type {Array}
     */
    views: [
        {
            /**
             * This will be the primary text of page onboarding.
             * @type {[String]}
             */
            title: "LOREM IPSUM\nDOLOR SIT",

            /**
             * This will be secondary text that will further explain the feature.
             * @type {[String]}
             */
            description: "Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit.",

            /**
             * Local or remote url / can be video or image.
             * The media which will be shown in the background of the screen.
             * Video should automatically play after view transition.
             * @type {[String]}
             */
            media: "/images/intro/1.png"
        },
        {
            title: "PROIN GRAVIDA\nVELIT NISL, EGET",
            description: "Donec fermentum nisl nec ligula placerat, a convallis mi rutrum.",
            media: "/images/intro/2.png"
        },
        {
            title: "NULLAM LIBERO\nTURPIS",
            description: "Fusce massa neque, gravida suscipit lorem a, vehicula convallis orci.",
            media: "/images/intro/3.png"
        }
    ],
    titles: {
        left: 20, right: 50, bottom: 150,
        color: "white",
        font: {
            fontSize: 30,
            fontWeight: "bold"
        }
    },
    descriptions: {
        left: 20, right: 50, bottom: 90,
        color: "white",
        font: {
            fontSize: 16
        }
    }
}

index.js

$.intro.open();

Changelog

  • 4.0.1 Bump version.
  • 4.0.0 Rewrite the widget with simple animation logic, better performance.
  • 3.0.0 Complete overhaul of the widget, added customisation and cleaned up code. Not backwards compatible, as the widget main view is no longer a Window.
  • 2.1.0 Fix ImageView aspect ratio in Android
  • 2.0.0 Add Android Support with [ScrollableView widget](https://github.com/jkotchoff/au.llableView)
  • 1.0.0 Initial version

License

The MIT License (MIT)

Copyright (c) 2015 Duy Bao Nguyen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.