rws-js-client

Version:

client for RWS frontend

53 lines • 62.8 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Realtime Web Suite Client package</title><meta name="description" content="Documentation for Realtime Web Suite Client package"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><link rel="stylesheet" href="assets/hierarchy.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Realtime Web Suite Client package</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>Realtime Web Suite Client package</h2></div><div class="tsd-panel tsd-typography"><a id="md:rws-frontend-framework-readme" class="tsd-anchor"></a><h1><a href="#md:rws-frontend-framework-readme">RWS Frontend Framework README</a></h1><a id="md:table-of-contents" class="tsd-anchor"></a><h2><a href="#md:table-of-contents">Table of Contents</a></h2><ol> <li><a href="#md:overview">Overview</a></li> <li><a href="#md:getting-started">Getting Started</a></li> <li><a href="#md:key-components-rwsclient--routingservice">Key Components: RWSClient & RoutingService</a></li> <li><a href="#md:component-initialization">Component Initialization</a></li> <li><a href="#md:frontend-routes">Frontend routes</a></li> <li><a href="#md:backend-imports">Backend Imports</a></li> <li><a href="#md:utilizing-apiservice">Utilizing APIService</a></li> <li><a href="#md:notifier">Notifier</a></li> <li><a href="#md:example-webchat-component">Example: WebChat Component</a></li> </ol> <a id="md:overview" class="tsd-anchor"></a><h2><a href="#md:overview">Overview</a></h2>The RWS Frontend Framework is designed to create dynamic and responsive web applications. It integrates seamlessly with the backend and provides a robust set of tools for developing comprehensive web solutions. <a id="md:getting-started" class="tsd-anchor"></a><h2><a href="#md:getting-started">Getting Started</a></h2>To get started with the RWS Frontend Framework, ensure you have the necessary environment set up, including Node.js and any other dependencies specific to the framework. from your project dir do: <pre><code class="language-bash">yarn </code><button>Copy</button></pre> Initiate cfg files: <pre><code class="language-bash">rws-client init </code><button>Copy</button></pre> to install once and then to build after preparing compionents: <pre><code class="language-bash">yarn build </code><button>Copy</button></pre> or to watch for dev <pre><code class="language-bash">yarn watch </code><button>Copy</button></pre> then start engine in the site javascript (can be inline): <pre><code class="language-javascript">window.RWSClient.start(CFG); </code><button>Copy</button></pre> example config with interface: <pre><code class="language-javascript">const CFG = { backendUrl: 'http://localhost:1337', wsUrl: 'http://localhost:1338' } </code><button>Copy</button></pre> <pre><code class="language-typescript">export default interface IRWSConfig { defaultLayout?: typeof RWSViewComponent; backendUrl?: string, wsUrl?: string, backendRoutes?: any[] // routes from backend apiPrefix?: string // f.e /api after host routes?: IFrontRoutes, //override front routes transports?: string[], //ws transports setup user?: any, //user data if logged ignoreRWSComponents?: boolean //do not register base RWS components } </code><button>Copy</button></pre> <a id="md:key-components" class="tsd-anchor"></a><h2><a href="#md:key-components">Key Components</a></h2><a id="md:rwsclient" class="tsd-anchor"></a><h3><a href="#md:rwsclient">RWSClient</a></h3><a id="md:" class="tsd-anchor"></a><h2><a href="#md:"></a></h2><code>RWSClient</code> is the heart of the framework, managing configuration and initialization. It sets up routes, backend connections, and other essential framework services. <a id="md:routingservice" class="tsd-anchor"></a><h3><a href="#md:routingservice">RoutingService</a></h3><a id="md:-1" class="tsd-anchor"></a><h2><a href="#md:-1"></a></h2><code>RoutingService</code> handles the navigation and routing within your application. It ensures that URL changes reflect the correct component rendering. Implementing the Framework Main File: The main file (<code>index.ts</code>) is where you initialize the RWSClient. Here, you configure your routes, backend routes, and component initializations. Following is example of full usage of the framework <pre><code class="language-typescript">import RWSClient, { NotifyUiType, NotifyLogType } from 'rws-js-client'; //@ts-ignore import alertify from 'alertifyjs'; import './styles/main.scss'; import routes from './routing/routes'; import { backendRoutes } from './backendImport'; import initComponents from './application/_initComponents'; import { provideFASTDesignSystem, allComponents } from '@microsoft/fast-components'; async function initializeApp() { const theClient = new RWSClient(); theClient.setBackendRoutes(backendRoutes()); theClient.addRoutes(routes); theClient.onInit(async () => { initComponents(); provideFASTDesignSystem().register(allComponents); }); theClient.setNotifier((message: string, logType: NotifyLogType, uiType: NotifyUiType = 'notification', onConfirm: (params: any) => void) => { switch(uiType){ case 'notification': let notifType = 'success'; if(logType === 'error'){ notifType = 'error'; } if(logType === 'warning'){ notifType = 'warning'; } alertify.notify(message, notifType, 5, onConfirm); return; case 'alert': alertify.alert('Junction AI Notification', message, onConfirm); return; case 'silent': if(logType == 'warning'){ console.warn(message); }else if(logType == 'error'){ console.error(message); }else{ console.log(message); } return; } }); (window as any).RWSClient = theClient; } initializeApp().catch(console.error); </code><button>Copy</button></pre> <a id="md:component-initialization" class="tsd-anchor"></a><h2><a href="#md:component-initialization">Component Initialization</a></h2>In <code>application/_initComponents.ts</code>, you initialize the custom components used in your application. If components added in here will include other components they dont need to be listed here. A component imported in this mode needs to be imported once. <a id="md:default-component-structure" class="tsd-anchor"></a><h3><a href="#md:default-component-structure">Default component structure</a></h3><pre><code>component-dir/ component.ts template.html styles/ layout.scss </code><button>Copy</button></pre> WARNING All html templates refer to variable "T" as to FASTElement templating html scope. It contains all the functions FAST templates uses in html. F.e: T.html, T.when, T.repeat <pre><code class="language-html"><div class="convo-area-wrap"> <header> <div class="header-inner"></div> ${T.when(x => x.noChoose === 'false', (item, index) => T.html`<div> <chat-convo-models :chosenModel="${x => x.chosenModel}"></chat-convo-models> </div>`)} <div> <h2>${ x => x.chatContext ? x.chatContext.label : 'loading...' }</h2> <h3><strong>${ x => x.messageList.length }</strong> messages in total</h3> </div> <fast-divider></fast-divider> </header> <section> <div class="scroll-area"> <div class="scroll-content"> ${T.repeat(x => x.messageList, (item, index) => T.html` <chat-convo-message :contentReturn="${item => item}" :item="${item => item}"/> `)} ${T.when(x => !x.messageList.length, (item, index) => T.html` <p class="no-chat">No messages</p> `)} </div> </div> </section> </div> </code><button>Copy</button></pre> <a id="md:application_initcomponentsts" class="tsd-anchor"></a><h3><a href="#md:application_initcomponentsts">application/_initComponents.ts</a></h3><pre><code class="language-typescript">import { ChatNav } from '../components/chat-nav/component'; import { DefaultLayout } from '../components/default-layout/component'; import { RWSIcon } from '../components/rws-icon/component'; import { Loader } from '../components/loader/component'; import { LineSplitter } from '../components/line-splitter/component'; import { registerRWSComponents } from 'rws-js-client'; export default () => { LineSplitter; DefaultLayout; ChatNav; RWSIcon; Loader; registerRWSComponents(); //register rws components like <rws-uploader> and other comfy components } </code><button>Copy</button></pre> <pre><code class="language-typescript">//index.ts const theClient = new RWSClient(); theClient.addRoutes(routes); //routes are optional theClient.onInit(async () => { initComponents(); //user components from _initComponents.ts provideFASTDesignSystem().register(allComponents); // @microsoft/fast-components ready components init }); </code><button>Copy</button></pre> **Component needs to extend RWSViewComponent and use </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Protected</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Private</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Inherited</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>External</label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><ul><li><ul><li><a href="#md:rws-frontend-framework-readme">RWS Frontend Framework README</a></li><li><ul><li><a href="#md:table-of-contents">Table of Contents</a></li><li><a href="#md:overview">Overview</a></li><li><a href="#md:getting-started">Getting Started</a></li><li><a href="#md:key-components">Key Components</a></li><li><ul><li><a href="#md:rwsclient">RWSClient</a></li></ul></li><li><a href="#md:"></a></li><li><ul><li><a href="#md:routingservice">RoutingService</a></li></ul></li><li><a href="#md:-1"></a></li><li><a href="#md:component-initialization">Component Initialization</a></li><li><ul><li><a href="#md:default-component-structure">Default component structure</a></li><li><a href="#md:application_initcomponentsts">application/_initComponents.ts</a></li></ul></li></ul></li></ul></li></ul></div></details></div><div class="site-menu"><div class="tree"><div class="tree-config"><button class="tree-config__button tree-config__button--expand js-tree-expand" title="Expand All"><svg xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 490.72 490.72" fill="currentColor"><path d="M480.027,288.027H10.693c-5.867,0-10.667,4.8-10.667,10.667c0,5.867,4.8,10.667,10.667,10.667h213.333v144.96l-45.76-45.76c-4.267-4.053-10.987-3.947-15.04,0.213c-3.947,4.16-3.947,10.667,0,14.827l64,64c4.16,4.16,10.88,4.16,15.04,0l64-64c4.053-4.267,3.947-10.987-0.213-15.04c-4.16-3.947-10.667-3.947-14.827,0l-45.867,45.76V309.36h234.667c5.867,0,10.667-4.8,10.667-10.667C490.693,292.827,485.893,288.027,480.027,288.027z"></path><path d="M10.693,224.027h469.333c5.867,0,10.667-4.8,10.667-10.667c0-5.867-4.8-10.667-10.667-10.667H245.36V36.4l45.76,45.76c4.267,4.053,10.987,3.947,15.04-0.213c3.947-4.16,3.947-10.667,0-14.827l-64-64c-4.16-4.16-10.88-4.16-15.04,0l-64,64c-4.053,4.267-3.947,10.987,0.213,15.04c4.16,3.947,10.667,3.947,14.827,0l45.867-45.76v166.293H10.693c-5.867,0-10.667,4.8-10.667,10.667C0.027,219.227,4.827,224.027,10.693,224.027z"></path></svg></button><button class="tree-config__button tree-config__button--collapse js-tree-collapse" title="Collapse All"><svg viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg" fill="currentColor"><path fill-rule="evenodd" d="M1 8a.5.5 0 0 1 .5-.5h13a.5.5 0 0 1 0 1h-13A.5.5 0 0 1 1 8zm7-8a.5.5 0 0 1 .5.5v3.793l1.146-1.147a.5.5 0 0 1 .708.708l-2 2a.5.5 0 0 1-.708 0l-2-2a.5.5 0 1 1 .708-.708L7.5 4.293V.5A.5.5 0 0 1 8 0zm-.5 11.707-1.146 1.147a.5.5 0 0 1-.708-.708l2-2a.5.5 0 0 1 .708 0l2 2a.5.5 0 0 1-.708.708L8.5 11.707V15.5a.5.5 0 0 1-1 0v-3.793z"></path></svg></button><button class="tree-config__button tree-config__button--target js-tree-target" title="Scroll to current file"><svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" fill="currentColor"><circle cx="12" cy="12" r="3"></circle><path d="M13 4.069V2h-2v2.069A8.008 8.008 0 0 0 4.069 11H2v2h2.069A8.007 8.007 0 0 0 11 19.931V22h2v-2.069A8.007 8.007 0 0 0 19.931 13H22v-2h-2.069A8.008 8.008 0 0 0 13 4.069zM12 18c-3.309 0-6-2.691-6-6s2.691-6 6-6 6 2.691 6 6-2.691 6-6 6z"></path></svg></button></div><div class="tree-content"><ul class="js-category-list category" data-id="root"><li><div class="category__folder" data-id="root-src"></div>src<ul class="js-category-list category" data-id="root-src"><li><div class="category__folder" data-id="root-src-services"></div>services<ul class="js-category-list category" data-id="root-src-services"><li>ApiService.ts<ul><li><a class="category__link js-category-link" href="classes/ApiServiceInstance.html" data-id="/classes/ApiServiceInstance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ApiServiceInstance</a></li><li><a class="category__link js-category-link" href="interfaces/IRWSHttpRoute.html" data-id="/interfaces/IRWSHttpRoute.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IRWSHttpRoute</a></li><li><a class="category__link js-category-link" href="interfaces/IRWSPrefixedHTTProutes.html" data-id="/interfaces/IRWSPrefixedHTTProutes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IRWSPrefixedHTTProutes</a></li><li><a class="category__link js-category-link" href="types/IRWSBackendRoute.html" data-id="/types/IRWSBackendRoute.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>IRWSBackendRoute</a></li><li><a class="category__link js-category-link" href="variables/ApiService.html" data-id="/variables/ApiService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg>ApiService</a></li></ul></li><li>DOMService.ts<ul><li><a class="category__link js-category-link" href="classes/DOMServiceInstance.html" data-id="/classes/DOMServiceInstance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>DOMServiceInstance</a></li><li><a class="category__link js-category-link" href="types/DOMOutputType.html" data-id="/types/DOMOutputType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>DOMOutputType</a></li><li><a class="category__link js-category-link" href="variables/DOMService.html" data-id="/variables/DOMService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg>DOMService</a></li></ul></li><li>NotifyService.ts<ul><li><a class="category__link js-category-link" href="classes/NotifyServiceInstance.html" data-id="/classes/NotifyServiceInstance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>NotifyServiceInstance</a></li><li><a class="category__link js-category-link" href="variables/NotifyService.html" data-id="/variables/NotifyService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg>NotifyService</a></li></ul></li><li>RoutingService.ts<ul><li><a class="category__link js-category-link" href="classes/RWSRouter.html" data-id="/classes/RWSRouter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>RWSRouter</a></li><li><a class="category__link js-category-link" href="classes/RoutingServiceInstance.html" data-id="/classes/RoutingServiceInstance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>RoutingServiceInstance</a></li><li><a class="category__link js-category-link" href="interfaces/IRoutingEvent.html" data-id="/interfaces/IRoutingEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IRoutingEvent</a></li><li><a class="category__link js-category-link" href="types/IRWSFrontRoutes.html" data-id="/types/IRWSFrontRoutes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>IRWSFrontRoutes</a></li><li><a class="category__link js-category-link" href="types/IRWSRouteResult.html" data-id="/types/IRWSRouteResult.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>IRWSRouteResult</a></li><li><a class="category__link js-category-link" href="types/RouteReturn.html" data-id="/types/RouteReturn.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>RouteReturn</a></li><li><a class="category__link js-category-link" href="variables/RoutingService.html" data-id="/variables/RoutingService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg>RoutingService</a></li><li><a class="category__link js-category-link" href="variables/_ROUTING_EVENT_NAME.html" data-id="/variables/_ROUTING_EVENT_NAME.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg>_ROUTING_EVENT_NAME</a></li><li><a class="category__link js-category-link" href="functions/renderRouteComponent.html" data-id="/functions/renderRouteComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>renderRouteComponent</a></li></ul></li><li>_service.ts<ul><li><a class="category__link js-category-link" href="classes/RWSService.html" data-id="/classes/RWSService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>RWSService</a></li></ul></li><li>UtilsService.ts<ul><li><a class="category__link js-category-link" href="classes/UtilsServiceInstance.html" data-id="/classes/UtilsServiceInstance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>UtilsServiceInstance</a></li><li><a class="category__link js-category-link" href="variables/UtilsService.html" data-id="/variables/UtilsService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg>UtilsService</a></li></ul></li><li>WSService.ts<ul><li><a class="category__link js-category-link" href="classes/WSServiceInstance.html" data-id="/classes/WSServiceInstance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>WSServiceInstance</a></li><li><a class="category__link js-category-link" href="types/IRWSWebsocketStatus.html" data-id="/types/IRWSWebsocketStatus.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>IRWSWebsocketStatus</a></li><li><a class="category__link js-category-link" href="variables/WSService.html" data-id="/variables/WSService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg>WSService</a></li></ul></li></ul></li><li><div class="category__folder" data-id="root-src-components"></div>components<ul class="js-category-list category" data-id="root-src-components"><li><div class="category__folder" data-id="root-src-components-uploader"></div>uploader<ul class="js-category-list category" data-id="root-src-components-uploader"><li>component.ts<ul><li><a class="category__link js-category-link" href="classes/RWSUploader.html" data-id="/classes/RWSUploader.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>RWSUploader</a></li></ul></li></ul></li><li><div class="category__folder" data-id="root-src-components-router"></div>router<ul class="js-category-list category" data-id="root-src-components-router"><li>component.ts<ul><li><a class="category__link js-category-link" href="classes/RouterComponent.html" data-id="/classes/RouterComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>RouterComponent</a></li></ul></li></ul></li><li><div class="category__folder" data-id="root-src-components-_attrs"></div>_attrs<ul class="js-category-list category" data-id="root-src-components-_attrs"><li>angular-attr.ts<ul><li><a class="category__link js-category-link" href="functions/ngAttr.html" data-id="/functions/ngAttr.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>ngAttr</a></li></ul></li></ul></li><li>_component.ts<ul><li><a class="category__link js-category-link" href="classes/RWSViewComponent.html" data-id="/classes/RWSViewComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>RWSViewComponent</a></li><li><a class="category__link js-category-link" href="interfaces/IRWSAssetShowOptions.html" data-id="/interfaces/IRWSAssetShowOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IRWSAssetShowOptions</a></li></ul></li><li>_decorator.ts<ul><li><a class="category__link js-category-link" href="interfaces/IRWSDecoratorOptions.html" data-id="/interfaces/IRWSDecoratorOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IRWSDecoratorOptions</a></li><li><a class="category__link js-category-link" href="functions/RWSView.html" data-id="/functions/RWSView.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>RWSView</a></li></ul></li><li>index.ts<ul><li><a class="category__link js-category-link" href="functions/registerRWSComponents.html" data-id="/functions/registerRWSComponents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>registerRWSComponents</a></li></ul></li></ul></li><li><div class="category__folder" data-id="root-src-interfaces"></div>interfaces<ul class="js-category-list category" data-id="root-src-interfaces"><li>IRWSConfig.ts<ul><li><a class="category__link js-category-link" href="interfaces/IRWSConfig.html" data-id="/interfaces/IRWSConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IRWSConfig</a></li></ul></li></ul></li><li><div class="category__folder" data-id="root-src-types"></div>types<ul class="js-category-list category" data-id="root-src-types"><li>RWSNotify.ts<ul><li><a class="category__link js-category-link" href="types/NotifyLogType.html" data-id="/types/NotifyLogType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>NotifyLogType</a></li><li><a class="category__link js-category-link" href="types/NotifyUiType.html" data-id="/types/NotifyUiType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>NotifyUiType</a></li><li><a class="category__link js-category-link" href="types/RWSNotify.html" data-id="/types/RWSNotify.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>RWSNotify</a></li></ul></li></ul></li><li>index.ts<ul><li><a class="category__link js-category-link" href="classes/RWSClient.html" data-id="/classes/RWSClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>RWSClient</a></li></ul></li></ul></li></ul></div></div></div></div></div><div class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></div><div class="overlay"></div><svg style="display: none"><g id="icon-1"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-2"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8