@microsoft/windows-admin-center-sdk
Version:
Microsoft - Windows Admin Center Shell
52 lines (51 loc) • 1.42 kB
TypeScript
import { RpcShellNavigate } from '@microsoft/windows-admin-center-sdk/core/rpc/shell-navigate/rpc-shell-navigate-model';
/**
* The typed interface for a banner item to display.
*/
export interface BannerItem {
/**
* The URI of an external source to link to.
*/
externalLink?: string;
/**
* The description of the external source to link to.
*/
linkDescription?: string;
/**
* The icon of the banner item.
*
* If using a Windows Admin Center icon, format the string as follows:
*
* ex. 'sme-icon:sme-icon-chevronLeft'
*
* If using an external icon, it must a value accepted by the CSS url() function.
*
* ex. 'http://example.com/icon.svg'
* ex. 'data:image/gif;base64,<base64 encoded string>'
*/
icon?: string;
/**
* The unique identifier of the banner item.
*/
id: string;
/**
* The shell navigation link to a different part of Windows Admin Center.
*/
rpcShellNavigate?: RpcShellNavigate;
/**
* The function to run for set up.
*/
setUpFunction?: MsftSme.Action;
/**
* The name of the service using the banner.
*/
serviceName: string;
/**
* The title to display on the banner.
*/
title: string;
/**
* The label for action text
*/
actionText?: string;
}