Akumina Developer Documentation

Akumina Developer Documentation

  • API
  • Docs
  • Blog

›Modern

Akumina

  • Quickstart

Yo Akumina

  • Yo Akumina
  • Start with Yeoman
  • React
  • Simple template

Widget Builder

  • Widget Builder Structure
  • Akumina Widget Builder
  • Skipping instances
  • Token replacement for widget properties

Widget Development Quickstart

  • Setting up the Project
  • Configuring .env file
  • Configuring - akumina.sitedployer.config.json file
  • Configuring - akumina.config.json file
  • Extras

Widget Info

  • Akumina Widgets Overview
  • Building a New Widget Instance
  • Widget Views
  • Widget Properties
  • Global vs Local widgets (Widget Scoping)
  • Akumina React Widgets
  • Callbacks
  • RenderChildWidgets
  • Vendor Package List

Virtual Page Builder

  • Akumina Virtual Page Builder
  • Using Virtual Page Layouts
  • Creating a Custom Layout

Stream Card Builder

  • Installation
  • Stream Card Builder
  • Custom Cards
  • Activity Comments Config
  • Akumina Activity Stream PUSH Subscription using PowerAutomate to connect to ServiceNow
  • Akumina Activity Stream PUSH Subscription using PowerAutomate to connect to Dynamic 365

Site Deployer

  • Overview
  • Version 6.0
  • List Attribute Deployments
  • NPM Commands
  • SPA Updates and Deploying to multiple sites

Authoring

  • Content Action Event
  • Publish Validation Integration
  • Field Event Integration
  • CK Editor external plugins

Headless

  • Quickstart
  • Headless Teams support
  • Headless Troubleshooting

Modern

  • Overview
  • FAQ
  • Single Page Application
  • Modern Web Part Library
  • Google Analytics for Modern Pages

Site Creator

  • Overview
  • Adding A Custom Site Definition
  • Core Step Classes
  • Custom Site Definition Components
  • Custom Site Definition XML
  • Custom Subsite Definitions
  • Sample Step Code
  • Supported Tokens

Azure DevOps

  • CI/CD using Azure DevOps
  • Setting up a build to deploy a site package
  • Setting up a build to deploy file to App Manager hosted in an app service

Configuration

  • Configuration Context Overview
  • Edit the Redis cache timeout
  • Using a key vault for the client id and client secret

Debugging

  • Debugging in Akumina

Advanced

  • Central Site Collection Support
  • Eventing OOB Digital Workplace Events
  • Working with custom JSX Views
  • Page Indexing

Service Hub

  • Quickstart

Patch Notes

  • Patch Notes

Modern Web Part Library

Modern web part library (as of 3/10/2019)

The following is a list of a web parts you can use on a page, along with links to more information for each web part.

From https://support.office.com/en-us/article/using-web-parts-on-sharepoint-pages-336e8e92-3e2d-4298-ae01-d404bbe751e0#bkmk_availableparts

Bing maps

The Bing Maps web part adds a map to your page. Simply enter an address or a well known name and your map will appear. You can choose a different map type, such as road or aerial. You can also change the zoom level or give your map pin a friendly name.

Note: The Bing maps web part is not available in SharePoint Server 2019.

Akumina has a traffic widget that uses Goolge Maps API and this could likely be provisioned to function as just a map without the traffic information Traffic Widget - https://community.akumina.com/knowledge-base/trafficwidget/

Button

The Button web part easily adds a button to your page with your own label and link.

Note: The Button web part is not available in SharePoint Server 2019.

Many Akumina widgets have custom button functionality. The HTML Content Widget could be a workaround to getting a single button on a page though. HTML Content Widget - https://community.akumina.com/knowledge-base/htmlcontentwidget/

Document library

The Document Library web part displays a document library and customize it with your own title, view, and even size. Users with appropriate permissions can view or edit files directly from the web part, or can go to the full document library by clicking See all.

See Akumina Document Experience

Embed

The Embed web part displays content on your page from other sites like YouTube videos. Depending on the site, you can either use the site's address or embed code that the site provides.

GenericEmbed Widget - Allows similar functionality

Events

The Events web part allows you to add and display upcoming events on your page. You can even include a map with location, online meeting information, and more.

See Akumina Calendar/Events Experience

Group calendar

The Group calendar web part puts an Office 365 group calendar right on your page so that it is easily visible to your readers.

See Akumina Calendar/Events Experience

Hero

The Hero web part is a great way to bring focus and visual interest to your page. You can display up to five items in the Hero web part and use compelling images, text, and links to draw attention to each. The Hero web part is included by default on Communication sites, but you can also add the Hero web part to other pages.

See Akumina Hero Experience

Image

The Image web part on a page inserts an image on the page, either from your site, your OneDrive, or your hard drive.

See Akumina Image Experience

Image gallery

The Image Gallery web part shares collections of pictures on a page. Simply select your images with the file picker or drag them onto the web part. Once you've created your collection, you can drag and drop the images to reorder them as needed.

See Akumina Image Experience

Link

The Link web part adds a link to an internal or external page, video, image, or document.

Note: The Link web part is not available in SharePoint Server 2019.

Any Akumina widget displaying content will be able to show links.

Microsoft Forms

The Microsoft Forms web part can create surveys, quizzes, and polls on a page. You can also collect responses to your forms and show form results.

Note: The Microsoft Forms web part is not available in SharePoint Server 2019.

Akumina offers a Form widget that can be used to capture data: https://community.akumina.com/knowledge-base/formwidget/

News

The News web part keeps your team in the loop as well as engages them with important or interesting stories. You can quickly create eye-catching posts like announcements, people news, status updates, and more that can include graphics and rich formatting.

See Akumina News Experience

People

The People web part displays a selected group of people and their profiles on your page. It can be used for contact information, team information, presenters, and more.

See Akumina People Experience

Quick links

The Quick Links web part "pins" items to your page for easy access.

See Akumina Menu Experience

Recent documents

The Recent documents web part displays documents that have been recently added or edited.

Note: The Recent documents web part is not available in SharePoint Server 2019.

See Akumina Document Experience

Stream

The Stream web part displays a video right on your page from your organization's Microsoft Stream video portal.

Stream Channel Widget - https://community.akumina.com/knowledge-base/streamchannelwidget/

Text

The Text web part adds paragraphs and tables to your page. Formatting options like styles, bullets, indentations, highlighting, and links are available.

HTML Content Widget - https://community.akumina.com/knowledge-base/htmlcontentwidget/

Weather

The Weather web part shows the current weather on your page.

Note: The Weather web part is not available in SharePoint Server 2019.

Akumina's Weather Widget displays weather and can be targeted to a user Weather Widget - https://community.akumina.com/knowledge-base/weatherwidget/

Akumina Experiences

Akumina News Experience

With many news widgets at your disposal, Akumina's News Experience gives you the tools to surface the right content at the right time, that's customized to your audience.

  • Recent News Widget - https://community.akumina.com/knowledge-base/recentnewswidget/
  • Breaking News Widget - https://community.akumina.com/knowledge-base/breakingnewswidget/
  • News Card Widget - https://community.akumina.com/knowledge-base/newscardswidget/
  • Company News Hero Widget - https://community.akumina.com/knowledge-base/companynewsherowidget/
  • Company News Item Widget - https://community.akumina.com/knowledge-base/companynewsitemwidget/
  • Company News List Widget - https://community.akumina.com/knowledge-base/companynewslistwidget/
  • Department News Widget - https://community.akumina.com/knowledge-base/departmentnewswidget/
  • RSS News Widget - https://community.akumina.com/knowledge-base/rssnewswidget/
  • Blogs Widget - https://community.akumina.com/knowledge-base/blogswidget/

Akumina Document Experience

A couple of widgets make up Akumina's Document Experience. That gives you access to a searchable document list, has a folder tree structure, allows you to upload, edit, and share documents. Summarized lists also displays documents from all libraries and surfaces them to the end user via tabs, I.E. Newest, My Recent, Popular, Recommended

  • Document Viewer Widget - https://community.akumina.com/knowledge-base/documentviewer/
  • Documents Summary List Widget - https://community.akumina.com/knowledge-base/documentssummarylistwidget/

Akumina Hero Experience

Bring focus to content, products, and more with the Akumina Hero Experience! With banner and news widgets, you'll have control over images, titles, tags, sub-text, buttons, and animation, to create an experience that's suited to your audience.

  • Banner Widget - https://community.akumina.com/knowledge-base/bannerwidget/
  • Company News Hero - https://community.akumina.com/knowledge-base/companynewsherowidget/

Akumina People Experience

Highlight your employees, surface your company directory, and provide individual employee data with Akumina's People Experience.

  • Foundation Employee Spotlight Widget - https://community.akumina.com/knowledge-base/foundationemployeespotlightwidget/
  • People Directory Widget - https://community.akumina.com/knowledge-base/peopledirectorywidget/
  • Employee Detail Widget - https://community.akumina.com/knowledge-base/employeedetailwidget/

Akumina Menu Experience

Akumina's Menu Experience gives you the ability to bring pages, forms, content, and any often linked to item, quickly and directly to your audience. The Menu Experience can feature categories, flyout menus, and more!

  • Quick Link Widget - https://community.akumina.com/knowledge-base/quicklinkswidget/

Akumina Image Experience

The Akumina Image Experience allows you to display images and video in several different ways, to help you visually customize a page to your needs.

  • Latest Media Widget - https://community.akumina.com/knowledge-base/latestmediawidget/

  • HTML Content Widget - https://community.akumina.com/knowledge-base/htmlcontentwidget/

  • Content Block Widget - https://community.akumina.com/knowledge-base/contentblock/

Akumina Calendar/Event Experience

Akumina has a calendar experience that provides event functionaility.

  • Full calendar
    • Calendar Widget - https://community.akumina.com/knowledge-base/calendarwidget/
    • Company Calendar Widget - https://community.akumina.com/knowledge-base/companycalendarwidget/
  • List of event dates
    • Important Dates Widget - https://community.akumina.com/knowledge-base/importantdateswidget/
    • Announcement Items Widget - https://community.akumina.com/knowledge-base/announcementitemswidget/
  • Detail display for calendar event
    • Event Detail Widget - https://community.akumina.com/knowledge-base/eventdetail/

The following control displays a calendar from an Office 365 Group:

  • Company Calendar Widget - https://community.akumina.com/knowledge-base/companycalendarwidget/
← Single Page ApplicationGoogle Analytics for Modern Pages →
  • Bing maps
  • Button
  • Document library
  • Embed
  • Events
  • Group calendar
  • Hero
  • Image
  • Image gallery
  • Link
  • Microsoft Forms
  • News
  • People
  • Quick links
  • Recent documents
  • Stream
  • Text
  • Weather
  • Akumina News Experience
  • Akumina Document Experience
  • Akumina Hero Experience
  • Akumina People Experience
  • Akumina Menu Experience
  • Akumina Image Experience
  • Akumina Calendar/Event Experience
Akumina Developer Documentation
Docs
Akumina Framework 5.0Akumina Widget BuilderAkumina Yeoman GeneratorSite Deployer
Community
Akumina Community Site
More
GitHubStar
Copyright © 2024 Akumina