@adobe/exc-app 0.2.39 → 0.2.42

package/page.ts

@@ -248,10 +248,38 @@ export interface PageApiProperties {
   unloadPromptMessage: string;
 }
 
+export interface Callback {(value?: any): void}
+
 /**
  * Defines page-level APIs available to solutions.
  */
 export interface PageApi extends PageApiProperties {
+  /**
+   * A function that listens and handles the afterPrint event.
+   *
+   * ```typescript
+   * ***Example:***
+   * page.afterPrintHandler = function () {
+   *   // Revert temporary CSS changes
+   * };
+   * ````
+   * @param callback The function that results in printing.
+   */
+  afterPrintHandler(callback: Callback): void;
+
+  /**
+   * A function that listens and handles the beforePrint event.
+   *
+   * ```typescript
+   * ***Example:***
+   * page.beforePrintHandler = function () {
+   *   // Temporary CSS changes, like unsetting height
+   * };
+   * ````
+   * @param callback The function that results in printing.
+   */
+  beforePrintHandler(callback: Callback): void;
+
   /**
    * Sometimes applications will need to block navigation away from the current page. The most common use case
    * for this is when a user has unsaved changes that would be lost on navigation.
@@ -392,6 +420,22 @@ export interface PageApi extends PageApiProperties {
    */
   openInNewTab(path: string, newApp?: boolean): void;
 
+  /**
+   * A function to control printing. The callback function should call `window.print()`
+   * at some point. It's important that the callback not be an arrow function if you
+   * want the `window` object to be the iframe contents. Feel free to adjust your
+   * CSS or UI before `window.print()` and reverse those changes afterwards.
+   *
+   * ```typescript
+   * ***Example:***
+   * page.print = function () {
+   *   window.print();
+   * };
+   * ````
+   * @param callback The function that results in printing.
+   */
+  print(callback: Callback): void;
+
   /**
    * Set the list of selectors presently being used by modalAutoDetect. If set to an empty
    * array, the default selectors used by runtime will be used instead. To stop observing changes
@@ -425,7 +469,9 @@ export interface PageApi extends PageApiProperties {
 }
 
 const page = connect('page', [
+  ['afterPrintHandler'],
   ['appContainer'],
+  ['beforePrintHandler'],
   ['blockNavigation', true],
   ['clipboardWrite', true],
   ['done', true],
@@ -438,6 +484,7 @@ const page = connect('page', [
   ['notFound', true],
   ['openInNewTab', true],
   ['preventDefaultCombos'],
+  ['print', true],
   ['shellRedirect', true],
   ['setModalQuerySelectors'],
   ['spinner'],

package/docs/interfaces/reflection-936.reflection-270.modules.md

@@ -1,161 +0,0 @@
-**[@adobe/exc-app](../README.md)**
-
-> [Globals](../README.md) / [](../modules/reflection-936.md) / [](../modules/reflection-936.reflection-270.md) / Modules
-
-# Interface: Modules
-
-## Hierarchy
-
-* **Modules**
-
-## Index
-
-### Properties
-
-* [appApi](reflection-936.reflection-270.modules.md#appapi)
-* [capabilityApi](reflection-936.reflection-270.modules.md#capabilityapi)
-* [default](reflection-936.reflection-270.modules.md#default)
-* [helpCenter](reflection-936.reflection-270.modules.md#helpcenter)
-* [internal](reflection-936.reflection-270.modules.md#internal)
-* [metrics](reflection-936.reflection-270.modules.md#metrics)
-* [network](reflection-936.reflection-270.modules.md#network)
-* [nps](reflection-936.reflection-270.modules.md#nps)
-* [orgSwitcher](reflection-936.reflection-270.modules.md#orgswitcher)
-* [page](reflection-936.reflection-270.modules.md#page)
-* [permissions](reflection-936.reflection-270.modules.md#permissions)
-* [pulse](reflection-936.reflection-270.modules.md#pulse)
-* [runtime](reflection-936.reflection-270.modules.md#runtime)
-* [session](reflection-936.reflection-270.modules.md#session)
-* [settings](reflection-936.reflection-270.modules.md#settings)
-* [shell](reflection-936.reflection-270.modules.md#shell)
-* [sidebar](reflection-936.reflection-270.modules.md#sidebar)
-* [sidenav](reflection-936.reflection-270.modules.md#sidenav)
-* [topbar](reflection-936.reflection-270.modules.md#topbar)
-* [user](reflection-936.reflection-270.modules.md#user)
-* [userProfile](reflection-936.reflection-270.modules.md#userprofile)
-
-## Properties
-
-### appApi
-
-• `Readonly` **appApi**: () => [AppApi](appapi.appapi-1.md)
-
-___
-
-### capabilityApi
-
-• `Readonly` **capabilityApi**: () => [CapabilityApi](capabilityapi.capabilityapi-1.md)
-
-___
-
-### default
-
-• `Readonly` **default**: (options?: any) => [Runtime](reflection-936.reflection-270.runtime.md)
-
-___
-
-### helpCenter
-
-• `Readonly` **helpCenter**: [HelpCenterApi](helpcenter.helpcenterapi.md)
-
-___
-
-### internal
-
-• `Readonly` **internal**: InternalApi
-
-___
-
-### metrics
-
-• `Readonly` **metrics**: [MetricsApi](metrics.metricsapi.md)
-
-___
-
-### network
-
-• `Readonly` **network**: [NetworkApi](network.networkapi.md)
-
-___
-
-### nps
-
-• `Readonly` **nps**: [Nps](nps.nps-1.md)
-
-___
-
-### orgSwitcher
-
-• `Readonly` **orgSwitcher**: OrgSwitcherApi
-
-___
-
-### page
-
-• `Readonly` **page**: [PageApi](page.pageapi.md)
-
-___
-
-### permissions
-
-• `Readonly` **permissions**: () => [PermissionsApi](permissions.permissionsapi.md)
-
-___
-
-### pulse
-
-• `Readonly` **pulse**: () => [PulseApi](pulse.pulseapi.md)
-
-___
-
-### runtime
-
-•  **runtime**: [Runtime](reflection-936.reflection-270.runtime.md)
-
-___
-
-### session
-
-• `Readonly` **session**: () => [SessionApi](session.sessionapi.md)
-
-___
-
-### settings
-
-• `Readonly` **settings**: () => [SettingsApi](settings.settingsapi.md)
-
-___
-
-### shell
-
-• `Readonly` **shell**: () => [ShellApi](shell.shellapi.md)
-
-___
-
-### sidebar
-
-• `Readonly` **sidebar**: SidebarApi
-
-___
-
-### sidenav
-
-• `Readonly` **sidenav**: () => SidenavApi
-
-___
-
-### topbar
-
-• `Readonly` **topbar**: [TopbarApi](topbar.topbarapi.md)
-
-___
-
-### user
-
-• `Readonly` **user**: () => [UserApi](user.userapi.md)
-
-___
-
-### userProfile
-
-• `Readonly` **userProfile**: [UserProfileApi](userprofile.userprofileapi.md)

package/docs/interfaces/reflection-936.reflection-270.runtime.md

@@ -1,102 +0,0 @@
-**[@adobe/exc-app](../README.md)**
-
-> [Globals](../README.md) / [](../modules/reflection-936.md) / [](../modules/reflection-936.reflection-270.md) / Runtime
-
-# Interface: Runtime\<T>
-
-Defines the runtime object providing all unified-shell APIs for solution authors.
-
-## Type parameters
-
-Name | Default |
------- | ------ |
-`T` | Record\\<string, any> |
-
-## Hierarchy
-
-* EventEmitter
-
-  ↳ **Runtime**
-
-## Index
-
-### EventEmitter Methods
-
-* [emit](reflection-936.reflection-270.runtime.md#emit)
-* [off](reflection-936.reflection-270.runtime.md#off)
-* [on](reflection-936.reflection-270.runtime.md#on)
-
-## EventEmitter Methods
-
-### emit
-
-▸ **emit**\<K>(`type`: K, `event?`: T[K]): void
-
-*Inherited from void*
-
-Invoke all handlers for the given type.
-
-#### Type parameters:
-
-Name | Type |
------- | ------ |
-`K` | keyof T |
-
-#### Parameters:
-
-Name | Type | Description |
------- | ------ | ------ |
-`type` | K | The event type to invoke. |
-`event?` | T[K] | Any value (object is recommended and powerful), passed to each handler. |
-
-**Returns:** void
-
-___
-
-### off
-
-▸ **off**\<K>(`type`: K, `handler`: (event?: T[K]) => void): void
-
-*Inherited from void*
-
-Remove an event handler for the given type.
-
-#### Type parameters:
-
-Name | Type |
------- | ------ |
-`K` | keyof T |
-
-#### Parameters:
-
-Name | Type | Description |
------- | ------ | ------ |
-`type` | K | Type of event to unregister `handler` from. |
-`handler` | (event?: T[K]) => void | Handler function to remove. |
-
-**Returns:** void
-
-___
-
-### on
-
-▸ **on**\<K>(`type`: K, `handler`: (event?: T[K]) => void): void
-
-*Inherited from void*
-
-Register an event handler for the given type.
-
-#### Type parameters:
-
-Name | Type |
------- | ------ |
-`K` | keyof T |
-
-#### Parameters:
-
-Name | Type | Description |
------- | ------ | ------ |
-`type` | K | Type of event to listen for. |
-`handler` | (event?: T[K]) => void | Function to call in response to given event. |
-
-**Returns:** void

package/docs/modules/reflection-936.md

@@ -1,11 +0,0 @@
-**[@adobe/exc-app](../README.md)**
-
-> [Globals](../README.md) / 
-
-# Module: 
-
-## Index
-
-### Modules
-
-* [](reflection-936.reflection-270.md)

package/docs/modules/reflection-936.reflection-270.md

@@ -1,74 +0,0 @@
-**[@adobe/exc-app](../README.md)**
-
-> [Globals](../README.md) / [](reflection-936.md) / 
-
-# Module: 
-
-## Index
-
-### Interfaces
-
-* [Modules](../interfaces/reflection-936.reflection-270.modules.md)
-* [Runtime](../interfaces/reflection-936.reflection-270.runtime.md)
-
-### Functions
-
-* [init](reflection-936.reflection-270.md#init)
-* [runtime](reflection-936.reflection-270.md#runtime)
-
-## Functions
-
-### init
-
-▸ **init**(`bootstrap`: (runtime: [Runtime](../interfaces/reflection-936.reflection-270.runtime.md)) => void): void
-
-Initializes a solution web application by invoking the bootstrap callback
-once the runtime is ready.
-1. if the module is already defined, start to bootstrap
-2. otherwise define the global callback that will be called when runtime is ready.
-
-***Example:***
-
-```typescript
-import React from 'react';
-import ReactDOM from 'react-dom';
-import runtime, {init} from '@adobe/exc-app';
-
-init(() => {
-  ReactDOM.render(<MainComponent runtime={runtime()} />, document.querySelector('#main'));
-});
-```
-
-#### Parameters:
-
-Name | Type | Description |
------- | ------ | ------ |
-`bootstrap` | (runtime: [Runtime](../interfaces/reflection-936.reflection-270.runtime.md)) => void | Callback used to bootstrap a solution. The runtime object is passed in as a parameter to this callback.  |
-
-**Returns:** void
-
-___
-
-### runtime
-
-▸ **runtime**(): [Runtime](../interfaces/reflection-936.reflection-270.runtime.md)
-
-Get the runtime object which contains all unified-shell APIs.
-
-***Example:***
-
-```typescript
-import React from 'react';
-import ReactDOM from 'react-dom';
-import excApp from '@adobe/exc-app';
-
-export class MyComponent extends React.Component {
-  constructor(props) {
-    this.runtime = excApp();
-  }
-}
-```
-
-**Returns:** [Runtime](../interfaces/reflection-936.reflection-270.runtime.md)
-
-The runtime object.