index.md

Manuals

Before starting with the manuals, make sure that you know what LaxarJS is about, and that you are familiar with the core concepts. If you're already in the process of developing your first widgets and want to know which programmatic APIs are provided by LaxarJS, have a look at the API docs.

For developers coming from previous LaxarJS major versions, there is an upgrade guide to ease the transition.

Basic Manuals

• Widgets and Activities

  Learn about the central building blocks of a LaxarJS application, and the basics on integration technologies.

• Writing Pages

  A step-by-step introduction to writing layouts and pages for a LaxarJS application.

• Installing Third Party Widgets

  Learn how to integrate and leverage existing widgets and activities.

• Flow and Places

  Creating a flow through the pages and make the addressable as places.

• Widget Services

  Services that are offered as injections to all widgets regardless of their technology.

• Events

  How to communicate between widgets using topics on the event bus.

• The "plain" Integration Technology

  Even without any fancy MVC framework, you can create useful widgets and activities.

• Configuration

  Documents the LaxarJS configuration API which can be used to configure widgets, and the built-in configuration options.

• Providing Controls

  How to create reusable, interactive elements that support themes.

• Infrastructure and Tools

  What happens when a LaxarJS application starts, and how its assets are prepared.

• Upgrading LaxarJS

  A migration guide helping to upgrade applications from earlier versions of LaxarJS.

Advanced Manuals

• Creating an Application from Scratch

  Learn what is actually required in a LaxarJS project.

• Asset Lookup and the Artifacts Bundle

  How CSS, HTML and other static assets are resolved and loaded.

• Creating Themes

  How to create a custom, pluggable style for your widgets and applications.

• Writing Compositions

  When simple pages are not enough.

• Internationalization (i18n)

  Explains how to leverage the LaxarJS event bus and APIs when writing internationalized applications.

• Visibility Events

  Introduces visibility events for improving performance by allowing widgets to determine if they are visible to the user or if they currently reside in the background.

• Creating an Adapter for a new Widget Technology

  Learn how to adapt any MVC technology for creating LaxarJS widgets.