Aikau Framework

[ddraper]

Aikau is available on GitHub at: https://github.com/Alfresco/Aikau

• For latest news on Aikau read: Dave Draper 's blog posts.
• To get started with Aikau follow the tutorial: Aikau/About.md at develop · Alfresco/Aikau · GitHub 
• For education references, see Education References · Alfresco/Aikau Wiki · GitHub 
• You can play with Aikau in the Sandpit: Aikau Sandpit 
• JSDoc for Aikau is available here: JSDoc: Index 
• Ask questions on StackOverflow using the 'aikau' tag: http://stackoverflow.com/questions/tagged/aikau
• Get immediate help via Alfresco IRC on freenode: http://chat.alfresco.com/

The official documentation is at: http://docs.alfresco.com'

Table of Contents

• 1 Aikau Framework

• 1.1 Usage

• 1.1.1 4.2

• 1.1.2 5.0

• 1.2 Aikau Documentation

• 1.2.1 Alfresco's Official Documentation

• 1.2.2 Introduction

• 1.2.3 Community Tutorial

• 1.2.4 Summit 2013 Videos

• 1.2.5 Summit 2014 Sessions

• 1.2.6 Tech Talk Lives

• 1.2.7 Mini Examples

• 1.2.8 Using Aikau With Other UI Frameworks

• 1.2.9 Share Extension modules

• 1.3 Third Party Aikau Extensions

• 1.4 Aikau Widget Documentation

• 1.5 Why did we choose the name Aikau?

Aikau Framework

Aikau is a UI framework that was developed by Alfresco and included in the Alfresco 4.2 release. It was expanded and developed further Alfresco One 5.0. Unlike the majority of Alfresco source code it can be found in its own GitHub repository (https://github.com/Alfresco/Aikau). The project is managed on its own JIRA board (https://issues.alfresco.com/jira/secure/RapidBoard.jspa?rapidView=322&view=planning). There are weekly backwards compatible releases.

The framework consists of a method of loading and defining UI widgets and also includes the widgets that have been built using it.

Usage

4.2

• Header

5.0

4.2 areas, plus:

• Live Search
• Filtered Search Page
• Search Management Page
• Site Management Page
• Analytics and Reporting Widgets
• Page Creator
• Document List prototype

Aikau Documentation

There are lots of resources to help developers with the Aikau framework, however these resources are spread out over various different sites. This page serves to collate the resources and act as a single point of reference.

Alfresco's Official Documentation

• Community: http://docs.alfresco.com/community/concepts/aikau-intro.html
• Alfresco One: http://docs.alfresco.com/5.0/concepts/aikau-intro.html (available when the 5.0 release occurs)

Tutorials (currently Alpha):

• Community: http://docs.alfresco.com/community/concepts/aikau-tutorials.html
• Alfresco One (Preview only): http://docs.alfresco.com/5.0/concepts/aikau-tutorials.html

Introduction

Introducing Aikau: http://blogs.alfresco.com/wp/developer/2014/02/26/introducing-aikau/ (Dave Draper)

Community Tutorial

Working with the new Aikau framework in Alfresco Share 4.2 http://ohej.github.io/alfresco-tutorials/tutorial/aikau/tutorial.html and the blog post that accompanied it: http://ohej.dk/2014/07/tutorial-about-the-aikau-framework-in-alfresco-share/ (Ole Hejlskov)

Summit 2013 Videos

• Share Page Creation Live: https://www.youtube.com/watch?v=3u-KMa4YUSo (Dave Draper)
• The Share Widget Library: https://www.youtube.com/watch?v=qcaotLDJq9U (Dave Draper)

Summit 2014 Sessions

Slides and demo videos:

• Declarative Share Configuration with Aikau (SF): https://summit.alfresco.com/san-francisco/sessions/declarative-configuration-share (David Webster)
• Declarative Share Configuration (London): https://summit.alfresco.com/london/sessions/declarative-configuration-share (Dave Draper)
• Dynamic UI Generation with Share 4.2 and Aikau: https://summit.alfresco.com/san-francisco/sessions/dynamic-ui-generation-share-42-and-aikau (Kevin Dorr)

Tech Talk Lives

• Tech Talk Live 78: Latest Share Development Practices: https://www.youtube.com/watch?v=F4AjxHu1HSA (Dave Draper)

Mini Examples

• Dynamic Visibility: http://blogs.alfresco.com/wp/developer/2014/09/26/aikau-mini-examples-dynamic-visibility/
• Horizontal Layout: http://blogs.alfresco.com/wp/developer/2014/09/26/aikau-mini-examples-horizontal-layout/
• Wrapping jQuery widget: http://blogs.alfresco.com/wp/developer/2014/09/26/aikau-mini-examples-wrapping-a-jquery-widget/
• Role based rendering: http://blogs.alfresco.com/wp/developer/2014/09/26/aikau-mini-examples-role-based-rendering/
• Simple Form: http://blogs.alfresco.com/wp/developer/2014/09/26/aikau-mini-examples-simple-form/
• CRUD:
  • Get: http://blogs.alfresco.com/wp/developer/2014/09/29/aikau-mini-examples-crud-service-get/
  • Update: http://blogs.alfresco.com/wp/developer/2014/09/29/aikau-mini-examples-crud-service-update/
  • Delete: http://blogs.alfresco.com/wp/developer/2014/09/29/aikau-mini-examples-crud-service-delete/

Using Aikau With Other UI Frameworks

• Wrapping jQuery widget (mini example): http://blogs.alfresco.com/wp/developer/2014/09/26/aikau-mini-examples-wrapping-a-jquery-widget/
• Using jQuery as an AMD package: http://www.contezza.nl/blog/using-jquery-as-an-amd-package-for-dojoaikau (Tahir Malik / Contezza)

Share Extension modules

Aikau extensions are done via the extension module approach that was introduced in Alfresco 4.0:

• http://blogs.alfresco.com/wp/developer/2011/08/05/customizing-alfresco-share-javascript-controllers/
• http://blogs.alfresco.com/wp/developer/2011/07/29/sub-component-evaluations/

with Aikau specific examples:

• http://blogs.alfresco.com/wp/developer/2013/09/04/customizing-the-share-header-menu-part-1/
• http://blogs.alfresco.com/wp/developer/2013/09/06/customizing-the-share-header-menu-part-2/

Third Party Aikau Extensions

• Alfresco-inboxes (Paolo Predonzani)
  • Code: https://github.com/softwareloop/alfresco-inboxes
  • Initial write up: http://softwareloop.com/inbox-plugin-for-alfresco-using-the-aikau-framework/
  • Customising results view: http://softwareloop.com/alfresco-inboxes-how-to-customise-the-results-view/

Aikau Widget Documentation

• JSDocs: http://dev.alfresco.com/resource/docs/aikau-jsdoc/

Why did we choose the name Aikau?

The Aikau framework is named after the legendary Hawaiian Surfer Eddie Aikau, named because the framework sits atop Surf.