100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
UI updates: moved edit mode toggle into asset viewer and added config to control adding of assets
Rich Turner1cea100c1d36
diff --git a/ui/app/main/src/index.ts b/ui/app/main/src/index.tsindex a40710c02..cda0dc8c0 100644--- a/ui/app/main/src/index.ts+++ b/ui/app/main/src/index.ts@@ -19,7 +19,7 @@ import {import "@openremote/or-app/dist/pages/page-map";import {pageMapReducer, pageMapProvider} from "@openremote/or-app/dist/pages/page-map";import "@openremote/or-app/dist/pages/page-assets";-import {pageAssetsProvider} from "@openremote/or-app/dist/pages/page-assets";+import {pageAssetsProvider, PageAssetsConfig} from "@openremote/or-app/dist/pages/page-assets";import "@openremote/or-app/dist/pages/page-gateway";import {pageGatewayProvider} from "@openremote/or-app/dist/pages/page-gateway";import "@openremote/or-app/dist/pages/page-insights";diff --git a/ui/app/or-app/src/pages/page-assets.ts b/ui/app/or-app/src/pages/page-assets.tsindex e6f0c03b9..67b495443 100644--- a/ui/app/or-app/src/pages/page-assets.ts+++ b/ui/app/or-app/src/pages/page-assets.ts@@ -1,8 +1,8 @@import {css, customElement, html, property, TemplateResult, unsafeCSS, query} from "lit-element";import "@openremote/or-asset-tree";import "@openremote/or-asset-viewer";-import {ViewerConfig, OrAssetViewer} from "@openremote/or-asset-viewer";-import {AssetTreeConfig, OrAssetTreeSelectionChangedEvent, OrAssetTreeRequestSelectEvent, OrAssetTreeRequestEditToggleEvent, OrAssetTreeEditChangedEvent} from "@openremote/or-asset-tree";+import {ViewerConfig, OrAssetViewer, OrAssetViewerRequestEditToggleEvent} from "@openremote/or-asset-viewer";+import {AssetTreeConfig, OrAssetTreeSelectionChangedEvent, OrAssetTreeRequestSelectEvent, OrAssetTreeEditChangedEvent} from "@openremote/or-asset-tree";import {DefaultBoxShadow} from "@openremote/core";import {AppStateKeyed} from "../app";import {Page, router} from "../types";@@ -11,7 +11,7 @@ import { showDialog } from "@openremote/or-mwc-components/dist/or-mwc-dialog";import i18next from "i18next";export interface PageAssetsConfig {- viewer: ViewerConfig;+ viewer?: ViewerConfig;tree?: AssetTreeConfig;}@@ -105,7 +105,7 @@ class PageAssets<S extends AppStateKeyed> extends Page<S> {super.connectedCallback();this.addEventListener(OrAssetTreeSelectionChangedEvent.NAME, this._onTreeSelectionChanged);this.addEventListener(OrAssetTreeRequestSelectEvent.NAME, this._onTreeSelectionRequested);- this.addEventListener(OrAssetTreeRequestEditToggleEvent.NAME, this._onTreeEditToggleRequested);+ this.addEventListener(OrAssetViewerRequestEditToggleEvent.NAME, this._onTreeEditToggleRequested);this.addEventListener(OrAssetTreeEditChangedEvent.NAME, this._onTreeEditChanged);}@@ -118,7 +118,7 @@ class PageAssets<S extends AppStateKeyed> extends Page<S> {protected render(): TemplateResult | void {const selectedIds = this._assetId ? [this._assetId] : undefined;return html`- <or-asset-tree id="tree" .editMode="${!!this._editMode}" .config="${this.config && this.config.tree ? this.config.tree : null}" class="${this._assetId ? "hideMobile" : ""}" .selectedIds="${selectedIds}"></or-asset-tree>+ <or-asset-tree id="tree" .config="${this.config && this.config.tree ? this.config.tree : null}" class="${this._assetId ? "hideMobile" : ""}" .selectedIds="${selectedIds}"></or-asset-tree><or-asset-viewer id="viewer" .editMode="${!!this._editMode}" class="${!this._assetId ? "hideMobile" : ""}" .config="${this.config && this.config.viewer ? this.config.viewer : undefined}"></or-asset-viewer>`;}@@ -154,7 +154,7 @@ class PageAssets<S extends AppStateKeyed> extends Page<S> {this._updateRoute();}- protected _onTreeEditToggleRequested(event: OrAssetTreeRequestEditToggleEvent) {+ protected _onTreeEditToggleRequested(event: OrAssetViewerRequestEditToggleEvent) {// Block the request and show dialog then toggleevent.detail.allow = false;const editMode = event.detail.detail;diff --git a/ui/component/core/src/util.ts b/ui/component/core/src/util.tsindex 2d4234ff8..48aa23966 100644--- a/ui/component/core/src/util.ts+++ b/ui/component/core/src/util.ts@@ -454,3 +454,17 @@ export function sortByString<T>(valueExtractor: (item: T) => string): (a: T, b:return 0;};}++export interface RequestEventDetail<T> {+ allow: boolean;+ detail: T;+}++export function dispatchCancellableEvent<T>(target: EventTarget, event: CustomEvent<RequestEventDetail<T>>, handler: (detail: T) => void) {+ target.dispatchEvent(event);+ window.setTimeout(() => {+ if (event.detail.allow) {+ handler(event.detail.detail);+ }+ });+}diff --git a/ui/component/or-asset-tree/src/index.ts b/ui/component/or-asset-tree/src/index.tsindex f27722b1a..33aded2e5 100644--- a/ui/component/or-asset-tree/src/index.ts+++ b/ui/component/or-asset-tree/src/index.ts@@ -23,8 +23,14 @@ export interface AssetTreeTypeConfig {}export interface AssetTreeConfig {- default?: AssetTreeTypeConfig;- addAssetTypes?: AssetTreeTypeConfig;+ addAsset?: {+ typesProvider?: (parent: UiAssetTreeNode | undefined) => AssetDescriptor[] | undefined;+ typesParent?: {+ default?: AssetTreeTypeConfig;+ none?: AssetTreeTypeConfig;+ assetTypes?: { [assetType: string]: AssetTreeTypeConfig }+ };+ };}export interface UiAssetTreeNode extends AssetTreeNode {@@ -35,11 +41,6 @@ export interface UiAssetTreeNode extends AssetTreeNode {children: UiAssetTreeNode[];}-interface RequestEventDetail<T> {- allow: boolean;- detail: T;-}-interface NodeClickEventDetail {node: UiAssetTreeNode;clickEvent: MouseEvent;@@ -47,7 +48,7 @@ interface NodeClickEventDetail {export {style};-export class OrAssetTreeRequestSelectEvent extends CustomEvent<RequestEventDetail<NodeClickEventDetail>> {+export class OrAssetTreeRequestSelectEvent extends CustomEvent<Util.RequestEventDetail<NodeClickEventDetail>> {public static readonly NAME = "or-asset-tree-request-select";@@ -63,22 +64,6 @@ export class OrAssetTreeRequestSelectEvent extends CustomEvent<RequestEventDetai}}-export class OrAssetTreeRequestEditToggleEvent extends CustomEvent<RequestEventDetail<boolean>> {-- public static readonly NAME = "or-asset-tree-request-edit-toggle";-- constructor(edit: boolean) {- super(OrAssetTreeRequestEditToggleEvent.NAME, {- bubbles: true,- composed: true,- detail: {- allow: true,- detail: edit- }- });- }-}-export class OrAssetTreeEditChangedEvent extends CustomEvent<boolean> {public static readonly NAME = "or-asset-tree-edit-changed";@@ -92,7 +77,7 @@ export class OrAssetTreeEditChangedEvent extends CustomEvent<boolean> {}}-export class OrAssetTreeRequestAddEvent extends CustomEvent<RequestEventDetail<Asset>> {+export class OrAssetTreeRequestAddEvent extends CustomEvent<Util.RequestEventDetail<Asset>> {public static readonly NAME = "or-asset-tree-request-add";@@ -121,7 +106,7 @@ export class OrAssetTreeAssetAddedEvent extends CustomEvent<Asset> {}}-export class OrAssetTreeRequestDeleteEvent extends CustomEvent<RequestEventDetail<UiAssetTreeNode[]>> {+export class OrAssetTreeRequestDeleteEvent extends CustomEvent<Util.RequestEventDetail<UiAssetTreeNode[]>> {public static readonly NAME = "or-asset-tree-request-delete";@@ -137,7 +122,7 @@ export class OrAssetTreeRequestDeleteEvent extends CustomEvent<RequestEventDetai}}-export class OrAssetTreeRequestCopyEvent extends CustomEvent<RequestEventDetail<UiAssetTreeNode>> {+export class OrAssetTreeRequestCopyEvent extends CustomEvent<Util.RequestEventDetail<UiAssetTreeNode>> {public static readonly NAME = "or-asset-tree-request-copy";@@ -173,7 +158,6 @@ declare global {[OrAssetTreeRequestDeleteEvent.NAME]: OrAssetTreeRequestDeleteEvent;[OrAssetTreeRequestCopyEvent.NAME]: OrAssetTreeRequestCopyEvent;[OrAssetTreeSelectionChangedEvent.NAME]: OrAssetTreeSelectionChangedEvent;- [OrAssetTreeRequestEditToggleEvent.NAME]: OrAssetTreeRequestEditToggleEvent;[OrAssetTreeEditChangedEvent.NAME]: OrAssetTreeEditChangedEvent;}}@@ -241,9 +225,6 @@ export class OrAssetTree extends subscribe(manager)(LitElement) {@property({type: Boolean})public multiSelect?: boolean = true;- @property({type: Boolean})- public editMode?: boolean = false;-@property({type: Function, noAccessor: true, attribute: false})public selector?: (node: UiAssetTreeNode) => boolean;@@ -297,7 +278,6 @@ export class OrAssetTree extends subscribe(manager)(LitElement) {}protected render() {- const editMode = this.editMode;return html`<div id="header">@@ -306,10 +286,10 @@ export class OrAssetTree extends subscribe(manager)(LitElement) {</div><div id="header-btns">- <or-input style="display: none;" ?hidden="${this._isReadonly() || !editMode || !this.selectedIds || this.selectedIds.length === 0}" type="${InputType.BUTTON}" icon="content-copy" @click="${() => this._onCopyClicked()}"></or-input>- <or-input ?hidden="${this._isReadonly() || !editMode || !this.selectedIds || this.selectedIds.length === 0}" type="${InputType.BUTTON}" icon="delete" @click="${() => this._onDeleteClicked()}"></or-input>- <or-input ?hidden="${this._isReadonly() || !editMode}" type="${InputType.BUTTON}" icon="plus" @click="${() => this._onAddClicked()}"></or-input>- <or-input ?hidden="${this._isReadonly()}" type="${InputType.BUTTON_TOGGLE}" icon="eye" .value="${this.editMode}" iconOn="pencil" @or-input-changed="${(ev: OrInputChangedEvent) => this._onEditToggled(ev.detail.value)}"></or-input>+ <or-input ?hidden="${!this.selectedIds || this.selectedIds.length === 0}" type="${InputType.BUTTON}" icon="close" @click="${() => this._onDeselectClicked()}"></or-input>+ <or-input ?hidden="${this._isReadonly() || !this.selectedIds || this.selectedIds.length === 0}" type="${InputType.BUTTON}" icon="content-copy" @click="${() => this._onCopyClicked()}"></or-input>+ <or-input ?hidden="${this._isReadonly() || !this.selectedIds || this.selectedIds.length === 0}" type="${InputType.BUTTON}" icon="delete" @click="${() => this._onDeleteClicked()}"></or-input>+ <or-input ?hidden="${this._isReadonly() || !this._canAdd()}" type="${InputType.BUTTON}" icon="plus" @click="${() => this._onAddClicked()}"></or-input><or-input hidden type="${InputType.BUTTON}" icon="magnify" @click="${() => this._onSearchClicked()}"></or-input>${getContentWithMenuTemplate(@@ -343,10 +323,6 @@ export class OrAssetTree extends subscribe(manager)(LitElement) {}protected shouldUpdate(_changedProperties: PropertyValues): boolean {- if (this.editMode && this._isReadonly()) {- this.editMode = false;- }-const result = super.shouldUpdate(_changedProperties);if (_changedProperties.has("_assetIdsOverride")|| _changedProperties.has("assets")@@ -437,7 +413,7 @@ export class OrAssetTree extends subscribe(manager)(LitElement) {}if (canSelect) {- this._doRequest(new OrAssetTreeRequestSelectEvent({+ Util.dispatchCancellableEvent(this, new OrAssetTreeRequestSelectEvent({node: node,clickEvent: evt}), (detail) => this._doSelect(detail));@@ -445,24 +421,23 @@ export class OrAssetTree extends subscribe(manager)(LitElement) {}}+ protected _onDeselectClicked() {+ this.selectedIds = [];+ }+protected _onCopyClicked() {if (this._selectedNodes.length > 0) {- this._doRequest(new OrAssetTreeRequestCopyEvent(this._selectedNodes[0]), (node) => this._doCopy(node));+ Util.dispatchCancellableEvent(this, new OrAssetTreeRequestCopyEvent(this._selectedNodes[0]), (node) => this._doCopy(node));}}protected _onDeleteClicked() {- this._doRequest(new OrAssetTreeRequestDeleteEvent(this._selectedNodes), (nodes) => this._doDelete());+ Util.dispatchCancellableEvent(this, new OrAssetTreeRequestDeleteEvent(this._selectedNodes), (nodes) => this._doDelete());}protected _onAddClicked() {- const includedAssetTypes = this.config && this.config.addAssetTypes && this.config.addAssetTypes.include ? this.config.addAssetTypes.include : undefined;- const excludedAssetTypes = this.config && this.config.addAssetTypes && this.config.addAssetTypes.exclude ? this.config.addAssetTypes.exclude : undefined;-- const listItems: ListItem[] = AssetModelUtil.getAssetDescriptors()- .filter((descriptor) => (!includedAssetTypes || includedAssetTypes.some((inc) => Util.stringMatch(inc, descriptor.type!)))- && (!excludedAssetTypes || !excludedAssetTypes.some((exc) => Util.stringMatch(exc, descriptor.type!))))+ const listItems: ListItem[] = this._getAllowedChildTypes(this._selectedNodes[0]).sort(Util.sortByString((descriptor) => descriptor.name!)).map((descriptor) => {return {@@ -522,7 +497,7 @@ export class OrAssetTree extends subscribe(manager)(LitElement) {if(this.selectedIds) {asset['parentId'] = this.selectedIds[0];}- this._doRequest(new OrAssetTreeRequestAddEvent(asset), () => this._doAdd(asset));+ Util.dispatchCancellableEvent(this, new OrAssetTreeRequestAddEvent(asset), () => this._doAdd(asset));}}],@@ -553,14 +528,6 @@ export class OrAssetTree extends subscribe(manager)(LitElement) {)}- protected _onEditToggled(edit: boolean) {- this._doRequest(new OrAssetTreeRequestEditToggleEvent(edit), () => this._doEditToggle(edit));- }-- protected _doEditToggle(edit: boolean) {- this.editMode = edit;- }-protected _onSearchClicked() {}@@ -656,6 +623,51 @@ export class OrAssetTree extends subscribe(manager)(LitElement) {});}+ protected _canAdd(): boolean {+ if (this._selectedNodes && this._selectedNodes.length > 1) {+ return false;+ }+ const selectedNode = this._selectedNodes ? this._selectedNodes[0] : undefined;+ return this._getAllowedChildTypes(selectedNode).length > 0;+ }++ protected _getAllowedChildTypes(selectedNode: UiAssetTreeNode | undefined): AssetDescriptor[] {+ let includedAssetTypes: string[] | undefined;+ let excludedAssetTypes: string[];++ if (this.config && this.config.addAsset) {+ if (this.config.addAsset.typesProvider) {+ const allowedTypes = this.config.addAsset.typesProvider(selectedNode);+ if (allowedTypes) {+ return allowedTypes;+ }+ }++ if (this.config.addAsset.typesParent) {+ let config: AssetTreeTypeConfig | undefined;++ if (!selectedNode && this.config.addAsset.typesParent.none) {+ config = this.config.addAsset.typesParent.none;+ } else if (selectedNode && this.config.addAsset.typesParent.assetTypes) {+ config = this.config.addAsset.typesParent.assetTypes[selectedNode.asset!.type!];+ }++ if (!config) {+ config = this.config.addAsset.typesParent.default;+ }++ if (config) {+ includedAssetTypes = config.include;+ excludedAssetTypes = config.exclude || [];+ }+ }+ }++ return AssetModelUtil.getAssetDescriptors()+ .filter((descriptor) => (!includedAssetTypes || includedAssetTypes.some((inc) => Util.stringMatch(inc, descriptor.type!)))+ && (!excludedAssetTypes || !excludedAssetTypes.some((exc) => Util.stringMatch(exc, descriptor.type!))));+ }+protected async _doAdd(asset: Asset) {const response = await manager.rest.api.AssetResource.create(asset);this._addedAssetId = response.data.id!;@@ -856,13 +868,4 @@ export class OrAssetTree extends subscribe(manager)(LitElement) {this._forEachNodeRecursive(node.children, fn);});}-- protected _doRequest<T>(event: CustomEvent<RequestEventDetail<T>>, handler: (detail: T) => void) {- this.dispatchEvent(event);- window.setTimeout(() => {- if (event.detail.allow) {- handler(event.detail.detail);- }- });- }}diff --git a/ui/component/or-asset-viewer/src/index.ts b/ui/component/or-asset-viewer/src/index.tsindex 062a40540..ae3a3020b 100644--- a/ui/component/or-asset-viewer/src/index.ts+++ b/ui/component/or-asset-viewer/src/index.ts@@ -193,10 +193,27 @@ export class OrAssetViewerSaveResultEvent extends CustomEvent<SaveResult> {}}+export class OrAssetViewerRequestEditToggleEvent extends CustomEvent<Util.RequestEventDetail<boolean>> {++ public static readonly NAME = "or-asset-viewer-request-edit-toggle";++ constructor(edit: boolean) {+ super(OrAssetViewerRequestEditToggleEvent.NAME, {+ bubbles: true,+ composed: true,+ detail: {+ allow: true,+ detail: edit+ }+ });+ }+}+declare global {export interface HTMLElementEventMap {[OrAssetViewerComputeGridEvent.NAME]: OrAssetViewerComputeGridEvent;[OrAssetViewerSaveResultEvent.NAME]: OrAssetViewerSaveResultEvent;+ [OrAssetViewerRequestEditToggleEvent.NAME]: OrAssetViewerRequestEditToggleEvent;}}@@ -864,10 +881,18 @@ export class OrAssetViewer extends subscribe(manager)(translate(i18next)(LitElem</a><div id="title"><or-icon title="${descriptor && descriptor.type ? descriptor.type : "unset"}" style="--or-icon-fill: ${descriptor && descriptor.color ? "#" + descriptor.color : "unset"}" icon="${descriptor && descriptor.icon ? descriptor.icon : AssetType.THING.icon}"></or-icon>- ${editMode ? html`<or-input id="name-input" .type="${InputType.TEXT}" min="1" max="1023" required outlined .label="${i18next.t("name")}" .value="${this.asset.name}" @or-input-changed="${(e: OrInputChangedEvent) => {this.asset!.name = e.detail.value; this._onAssetModified();}}"></or-input>` : html`<span>${this.asset.name}</span>`}+ ${editMode ? html`<or-input id="name-input" .type="${InputType.TEXT}" min="1" max="1023" comfortable required outlined .label="${i18next.t("name")}" .value="${this.asset.name}" @or-input-changed="${(e: OrInputChangedEvent) => {this.asset!.name = e.detail.value; this._onAssetModified();}}"></or-input>` : html`<span>${this.asset.name}</span>`}+ </div>+ ${!this._isReadonly() ? html`+ <span id="edit-wrapper">+ <or-translate value="editAsset"></or-translate>+ <or-input .type="${InputType.SWITCH}" .value="${this.editMode}" @or-input-changed="${(ev: OrInputChangedEvent) => this._onEditToggled(ev.detail.value)}"></or-input>+ </span>+ `: ``}+ <div id="right-wrapper">+ <or-translate id="created-time" class="mobileHidden" value="createdOnWithDate" .options="${{ date: new Date(this.asset!.createdOn!) } as i18next.TOptions<i18next.InitOptions>}"></or-translate>+ ${editMode ? html`<or-input id="save-btn" .disabled="${!this.isModified()}" raised .type="${InputType.BUTTON}" .label="${i18next.t("save")}" @or-input-changed="${() => this._saveAsset()}"></or-input>` : ``}</div>- <div id="created-time" class="mobileHidden"><or-translate value="createdOnWithDate" .options="${{ date: new Date(this.asset!.createdOn!) } as i18next.TOptions<i18next.InitOptions>}"></or-translate></div>- ${editMode ? html`<or-input id="save-btn" .disabled="${!this.isModified()}" raised .type="${InputType.BUTTON}" .label="${i18next.t("save")}" @or-input-changed="${() => this._saveAsset()}"></or-input>` : ``}</div>${content}</div>@@ -914,6 +939,10 @@ export class OrAssetViewer extends subscribe(manager)(translate(i18next)(LitElemawait this.updateComplete;}+ protected _onEditToggled(edit: boolean) {+ Util.dispatchCancellableEvent(this, new OrAssetViewerRequestEditToggleEvent(edit), () => this.editMode = edit);+ }+protected async _saveAsset() {if (!this.asset) {return;diff --git a/ui/component/or-asset-viewer/src/style.ts b/ui/component/or-asset-viewer/src/style.tsindex 2d1613a63..87e42ef8f 100644--- a/ui/component/or-asset-viewer/src/style.ts+++ b/ui/component/or-asset-viewer/src/style.ts@@ -83,9 +83,15 @@ export const style = css`opacity: 0.5;pointer-events: none;}++ #view-container, #edit-container {+ flex: 0 1 auto;+ margin-top: 10px;+ overflow: auto;+ }#view-container {- flex: 1 0 auto;+ margin-top: 0;box-sizing: border-box;display: grid;padding: 20px 20px;@@ -100,12 +106,6 @@ export const style = css`animation: fadein 0.3s;}- #edit-container {- flex: 0 1 auto;- margin-top: 10px;- overflow: auto;- }-#name-input {width: 300px;}@@ -156,7 +156,7 @@ export const style = css`}#title {- flex: 1 0 auto;+ flex: 1 1 0%;font-size: 18px;font-weight: bold;}@@ -166,9 +166,21 @@ export const style = css`}#created-time {- flex: 0 0 auto;font-size: 12px;}++ #right-wrapper {+ flex: 1 1 0%;+ text-align: right;+ }++ #edit-wrapper {+ flex: 0 0 auto;+ }++ #edit-wrapper > or-translate {+ margin-right: 10px;+ }#save-btn {margin-left: 20px;@@ -194,12 +206,7 @@ export const style = css`display: none;cursor: pointer;}-- #edit-container {- grid-column-start: 1;- grid-column-end: 3;- }-+@media screen and (max-width: 769px) {#wrapper {position: absolute;diff --git a/ui/component/or-input/src/index.ts b/ui/component/or-input/src/index.tsindex 6708bad66..355248c00 100644--- a/ui/component/or-input/src/index.ts+++ b/ui/component/or-input/src/index.ts@@ -677,17 +677,12 @@ export class OrInput extends LitElement {let label = this.label;let type = this.type;let componentId = "component";- let denseComfortable = this.comfortable;- let denseCompact = !this.comfortable && this.compact;- let rounded = false;if (this.type === InputType.RANGE) {// Change vars so number input can be included alongside the sliderlabel = undefined;outlined = false;hasHelper = false;- denseComfortable = true;- rounded = true;type = InputType.NUMBER;componentId = "number";}@@ -700,9 +695,8 @@ export class OrInput extends LitElement {"mdc-text-field--textarea": type === InputType.TEXTAREA || type === InputType.JSON,"mdc-text-field--disabled": this.disabled,"mdc-text-field--fullwidth": this.fullWidth && !outlined,- "dense-comfortable": denseComfortable,- "dense-compact": denseCompact,- "is-rounded": rounded,+ "dense-comfortable": this.comfortable,+ "dense-compact": !this.comfortable && this.compact,"mdc-text-field--label-floating": hasValue,"mdc-text-field--no-label": !this.label,"mdc-text-field--with-leading-icon": !!this.icon,