@uipath/widget.sdk

License

You can use the contents of this repository/package subject to your license agreement with UiPath for the UiPath Platform.

Changelog

1.2.2

Add the navigateToActionCenter method to the WidgetApi.

1.2.1

Add jsDoc documentation to WidgetApi, make startJob return job id observable.

1.2.0

Add readyForSignOutCheck$, onTileClicked$, addLaunchpadTile, removeLaunchpadTile, focusWidgetTab to WidgetApi.

1.1.0

Add jobList$and the startJob, stopJob, installProcess, processInfo functions to WidgetApi.

1.0.8

Remove all previously exported symbols and added a single WidgetApi service (along with type info) to be used by widgets. (due to Angular breaking changes, Angular components are no longer supported by Assistant. Web Components will be used instead)

0.0.19

WidgetShellService

Add openSaveDialog to open a windows-style file save dialog. Add writeFile which can save a file to a specific path on disk.

0.0.18

RobotService

Add unfilteredProcessList$ which includes all processes, regardless of their compatibility with the current OS. Both unfilteredProcessList$ and processList$ now include a targetFramework property for each process.

0.0.15

WidgetAppState

• Allow widgets to use Apollo styling, via the WidgetAppState.markWidgetAsApolloMigrated function.

0.0.14

TranslationPartModule

• Add support for multi string translations separated by "|"(pipe).

PlatformService

• Add support for determining the current platform.

WindowsOnlyModule

• Add directive that shows an element only on the Windows platform.

MacOnlyModule

• Add directive that shows an element only on the Mac platform.

0.0.13

WidgetShellService

• Add support for creating desktop shortcuts.

0.0.12

WidgetHomeTabService

• Add support for creating custom tiles in the Home Tab Launchpad (addCustomLaunchpadTile, removeCustomLaunchpadTile and customLaunchpadTileEvent$).

0.0.11

WidgetHomeTabService

• Allow widgets to register title menu items in the Home tab.
• Add support for highlighting a selected item in the Home tab.
• Allow widgets to open the details side panel of a process and send additional tabs to it.

WidgetAppState

• Allow widgets to respond to deep link actions forwarded by Assistant. They will abide to the following format:
  • {protocolName}://{widgetName}/{actionName}/{parameters} (e.g. uipath-assistant://uipath.marketplace.widget/install/0987-azerty-54321 - This is used by the Marketplace widget to install automations from UiPath Marketplace).

0.0.8

WidgetAppState

• Added action$ which can be used to receive Assistant OS protocol actions (uipath-assistant://widget.action/<my-widget-name>/<my-action>/<my-argument>).
• Added processDetailsOpened$ which can be used to provide tabs to the "Process Details" side panel opened when clicking on a home tab process.

0.0.7

WidgetHomeTabService

• Added togglePinToLaunchpad, pinnedItemIds$ and getPinnedItemIds to (un)pin widget items to the Home Tab Launchpad.
• Added the optional isDraggableToLaunchpad property on IWidgetHomeTabItem.

0.0.6

WidgetHomeTabService

• This service can be used to add new sections to the Home tab.
• Added refresh$ to respond to the Home tab Refresh button.
• Added openSidePanel and closeSidePanel methods to open side panels on the Home tab.

WidgetAppState

• Added search$ that emits the current search term.
• Added dateTimeFormat that contains current OS' date and time format.
• Added translation utility methods: getAssistantTranslationKey and translate.

widget-metadata.ts

• Added isTabHidden that allows widgets to hide their tab.

WidgetTranslationModule and translation pipe

• This module and pipe can be used for i18n.

0.0.5

WidgetAppState

• Added openSidePanel and closeSidePanel methods. They can be used to manage a component that behaves as an overlay over the first column (in one-column mode) or the second column (in two-column mode).

0.0.4

RobotService

• Fixed a breaking change (startJob returning a Promise instead of an Observable) that occured in version 0.0.3.

0.0.3

RobotService

• Added access to Orchestrator URL and token via orchestratorApi.
• Added the bypassSavedConfig parameter on startJob, set to false by default. If set to true, the method will not attempt to use or modify the saved process configuration (from process details).
• Added the userInfo$ stream that emits the user's signed in state.

EmptyStateComponent

• This component is used by the Assistant to load an SVG image as placeholder for no data (e.g. if the user chooses offline mode from the main window, but there are no processes installed).