@ichicraft/widgets-widget-base

Part of the Widget Development Kit for building widgets for Ichicraft Boards

Usage no npm install needed!

<script type="module">
  import ichicraftWidgetsWidgetBase from 'https://cdn.skypack.dev/@ichicraft/widgets-widget-base';
</script>

README

This package supports development of widgets built using the Widget Development Kit

This package is part of the Widget Development Kit, which is a collection of NPM packages that empower developers to create widgets for Ichicraft Boards.

Changelog

All notable changes to this project will be documented here.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.7.9 - 2022-01-20

  • Added userAccountCreated date/time to the WidgetContext interface.

1.7.8 - 2022-01-18

Changed

  • Added initiateWidgetDeletion() function to the WidgetContext interface.

1.7.7 - 2022-01-14

Changed

  • Added tenantId property to the WidgetContext interface.

1.7.6 - 2021-11-04

Changed

  • Added theme property to the WidgetContext interface to give access to currently applied theme.

1.7.5 - 2021-10-26

Changed

  • Added userSecurityGroups and userSharePointGroups properties to the WidgetContext interface to inform widgets of SharePoint and security group memberships of the current user.

1.7.4 - 2021-10-20

Changed

  • Added contentLanguages property to the WidgetContext interface to inform widgets of the available content languages as configured in Ichicraft Boards.

1.7.3 - 2021-10-04

Changed

  • Added manifestVersion property to the WidgetManifestConfig interface to support multiple versions of the manifest. Current version is 2 which introduced this and the externals property.
  • Added externals property to the WidgetManifestConfig interface to support libraries that can be loaded separately from the widget bundle. This reduces widget bundle size and improves overal performance of Ichicraft Boards.

1.6.1 - 2021-02-18

Changed

  • Added userEmail property to the WidgetContext interface to provide current user's email address to widgets.

1.5.0 - 2021-02-16

Changed

  • Added teamsSdk property to the WidgetContext interface to allow interaction with Teams in case widget board is running in Teams client. Will be undefined if running in SharePoint.

1.4.0 - 2021-01-25

Changed

  • Added several properties to the WidgetContext interface to identify the context in which the widget is shown (e.g. Team Browser hosted)

1.3.0 - 2021-01-15

Changed

  • registerCustomCommandBarItem() is added to the WidgetContext interface as a function to call from within a widget instance to render an additional command bar item in the widget header.
  • unregisterCustomCommandBarItem() is added to the WidgetContext interface as a function to call from within a widget instance to remove a previously added command bar item from the widget header.

1.2.0 - 2021-01-15

Changed

  • loadScript() is added to the WidgetContext interface as a function to call from within a widget in case an external script needs to be loaded. This allows the widget board to load external javascript.

1.1.0 - 2021-01-11

Changed

  • handleFatalError() is added to the WidgetContext interface as a function to call from within a widget in case of an unhandled/unresolvable error. This allows the widget board to handle this situation gracefully.
  • deps: removed dependency ajv

<= 1.0.5 - 2020-12-07

No changelog was maintained for the earlier versions.