JS分層架構低代碼跨iframe拖拽示例詳解
低代碼引擎
低代碼引擎是低代碼分層架構中最復雜的部分,引擎的核心功能包含入料、設計、畫布渲染和出碼等,它們的含義如下:
- 入料:向引擎注入設置器、插件和組件。
- 設計:對組件進行布局設置、屬性設置以及增刪改操作后,形成符合頁面搭建協(xié)議的JSON Schema。
- 畫布渲染:將 JSON Schema 渲染成 UI 界面。
- 出碼:將 JSON Schema 轉化成手寫代碼,這通常發(fā)生在頁面發(fā)布的時候。
本文主要介紹拖拽定位,即:拖拽過程中探測組件的可插入點。為了給渲染器提供一個純凈的渲染環(huán)境,渲染器和設計器處于不同的 iframe 中,因此拖拽組件,不僅涉及在同一個 iframe 中拖拽組件,還涉及跨 iframe 拖拽組件。渲染器所在的 iframe 由設計器喚起,在正式介紹拖拽定位之前,先介紹如何喚起渲染器 iframe。
喚起渲染器 iframe
iframe 元素的常見用法是將它的 src 屬性設置成一個固定的網頁地址,讓它在當前網頁嵌入另一個已經存在的網頁,但渲染器沒有固定的網頁地址,所以在這里要使用一種不常見的用法,即調用 document.write 方法給 iframe 所在的文檔寫入它要加載的內容。設計器喚起渲染器 iframe 的流程如下圖所示:
設計器環(huán)境和渲染器環(huán)境通過 host 相互通信,SimulatorRenderer 給 host 提供了一些 API 幫助設計器完成交互,設計器給 host 提供了一些 API 幫助渲染器完成畫布渲染。
在設計器環(huán)境中與渲染器環(huán)境相關的只是一個 iframe 元素,如下:
<iframe name="SimulatorRenderer" className="vitis-simulator-frame" style={frameStyle} ref={this.mountContentFrame} />
往 iframe 寫入內容發(fā)生在 host.mountContentFrame 方法中,代碼片段如下:
this.frameDocument!.open() this.frameDocument!.write( `<!doctype html> <html class="engine-design-mode"> <head> <meta charset="utf-8"/> // 這里是渲染器環(huán)境要加載的css樣式腳本 ${styleTags} </head> <body> // 這里是渲染器環(huán)境要加載的js腳本 ${scriptTags} </body> </html>` ) this.frameDocument!.close() // 監(jiān)聽iframe加載成功和加載失敗的事件 this.frameWindow!.addEventListener('load', loaded); this.frameWindow!.addEventListener('error', errored);
用低代碼引擎設計界面時,為了讓渲染器環(huán)境能成功的顯示畫布,上述 scriptTags 中至少包含 react、react-dom 和 vitis-lowcode-simulator-renderer 的js 腳本,在開發(fā)階段 vitis-lowcode-simulator-renderer 的 js 腳本地址是 http://localhost:5555/js/simulator-renderer.js,等發(fā)布之后vitis-lowcode-simulator-renderer 的 js 腳本地址是其 npm 包的 js 地址。
拖拽定位
拖拽定位指的是當組件在畫布區(qū)域拖動時,界面實時的顯示組件最近的可放置位置,這是一個與設計器強相關的功能,所以與設計器處于同一個 iframe,相關的 DOM 元素被疊放在畫布區(qū)域的上面,如下圖所示:
上圖藍線所在的位置就是被拖動組件最近可放置的位置,實現(xiàn)該功能需用到 Element.getBoundingClientRect() 方法和 HTML5 的拖放事件。給渲染器中的低代碼組件設置 ref 屬性,當其裝載到界面上即可得到組件的 DOM 元素,從而計算出拖拽過程中鼠標經過的低代碼組件。
低代碼組件的拖拽能力由 Dragon 實例提供,與拖拽相關的概念有如下3個:
- DragObject:被拖拽的對象,它是畫布中的低代碼組件或組件面板上的低代碼組件。
- LocationEvent:攜帶了拖拽過程中產生的坐標信息和被拖拽的對象。
- DropLocation:被拖拽對象在畫布上最近的可放置點。
DragObject 是一個聯(lián)合類型,拖拽不同位置的低代碼組件,它的類型有所不同,其接口類型定義如下:
interface DragNodeObject { type: DragObjectType.Node; // 被拖拽的是畫布中的低代碼組件 node: Node; } interface DragNodeDataObject { type: DragObjectType.NodeData; // 被拖拽的是組件面板上的低代碼組件 data: ComponentSpec; } type DragObject = DragNodeObject | DragNodeDataObject
設計器用 LocationEvent 來計算被拖拽對象最近的可放置點,其接口類型定義如下:
interface LocationEvent { dragObject: DragObject, originalEvent: DragEvent, clientX: number, clientY: number }
上述接口中 clientY 和 clientX 來自于 DragEvent 對象,它們用來計算畫布中離鼠標最近的 Node。
DropLocation是拖拽操作要計算的結果,接口類型定義如下:
interface DropLocation { // 被拖拽對象可放置的容器 containerNode: Node; // 被拖拽對象在容器中的插入點 index: number; }
以拖拽組件面板中的低代碼組件為例,在畫布區(qū)域顯示組件最近的可放置點,總體而言,需經歷6個步驟。
1. 綁定拖放事件
iframe 和組件面板中的低代碼組件綁定拖放事件,得到 DragObject,代碼片段如下:
// 當組件面板中的組件開始拖動時 <div draggable={true} onDragStart={() => onDragStart(item.packageName)}>xxx</div> const onDragStart = (packageName: string) => { // 得到DragObject dragon.onNodeDataDragStart(packageName) } // 給 iframe 綁定dragover事件,當拖動操作進入畫布區(qū)域時觸發(fā)事件 this.frameDocument?.addEventListener('dragover', (e: DragEvent) => { e.preventDefault() this.project.designer.dragon.onDragOver(e) })
2. 獲取拖拽過程中的 LocationEvent
LocationEvent 將在 iframe 的 dragover 事件處理程序中實時獲取,代碼如下:
onDragOver = (e: DragEvent) => { // 獲取 locateEvent 只是簡單的取值 const locateEvent = this.createLocationEvent(e) } createLocationEvent = (e: DragEvent): LocationEvent => { return { dragObject: this.dragObject, originalEvent: e, clientX: e.clientX, clientY: e.clientY } }
3. 獲取離鼠標最近的 Node
Node 被裝載在渲染器環(huán)境中,只有 SimulatorRenderer 實例才知道每個 Node 的位置,因此這一步需要調用 SimulatorRenderer 給 host 提供的getClosestNodeIdByLocation 方法,getClosestNodeIdByLocation 的代碼如下:
getClosestNodeIdByLocation = (point: Point): string | undefined => { // 第一步:找出包含 point 的全部 dom 節(jié)點 const suitableContainer = new Map<string, DomNode>() for (const [id, domNode] of reactInstanceCollector.domNodeMap) { const rect = this.getNodeRect(id) if (!domNode || !rect) continue const { width, height, left, top } = rect if (left < point.clientX && top < point.clientY && width + left > point.clientX && height + top > point.clientY) { suitableContainer.set(id, domNode) } } // 第二步:找出離 point 最近的 dom 節(jié)點 const minGap: {id: string| undefined; minArea: number} = { id: undefined, minArea: Infinity } for (const [id, domNode] of suitableContainer) { const { width, height } = domNode.rect if (width * height < minGap.minArea) { minGap.id = id; minGap.minArea = width * height } } return minGap.id }
上述 reactInstanceCollector 對象中保存了畫布上全部低代碼組件的 DOM 節(jié)點,實現(xiàn)這個目的需借助 React 的 ref 屬性,在這里不展開介紹。
4. 獲取拖拽對象最近的可放置容器
每個低代碼組件都能設置嵌套規(guī)則,規(guī)定哪些組件能做為它的子元素和父元素,不符合規(guī)則的組件則不可放置,在這一步將使用組件的嵌套規(guī)則,代碼如下:
getDropContainer = (locateEvent: LocationEvent) => { // 從上一步得來的潛在容器 let containerNode = this.host.getClosestNodeByLocation({clientX: locateEvent.clientX, clientY: locateEvent.clientY}) const thisComponentSpec: ComponentSpec = locateEvent.dragObject.data while(containerNode) { if (containerNode.componentSpec.isCanInclude(thisComponentSpec)) { return containerNode } else { // 繼續(xù)往上找父級 containerNode = containerNode.parent } } }
5. 計算被拖動的對象在容器中的插入點
容器可能包含多個子元素,在這一步將利用鼠標位置計算被拖動的對象在容器中的插入點,得到最終的 DropLocation ,代碼如下:
// 初始值 const dropLocation: DropLocation = { index: 0, containerNode: container} const { childrenSize, lastChild } = container const { clientY } = locateEvent if (lastChild) { const lastChildRect = this.designer.getNodeRect(lastChild.id) // 判斷是否要插到容器的末尾 if (lastChildRect && clientY > lastChildRect.bottom) { dropLocation.index = childrenSize } else { let minDistance = Infinity // 容器中最近的插入點 let minIndex = 0 for (let index = 0 ; index < childrenSize; index ++) { const child = container.getChildAtIndex(index)! const rect = this.designer.getNodeRect(child.id) if (rect && Math.abs(rect.top - clientY) < minDistance) { minDistance = Math.abs(rect.top - clientY) minIndex = index } } dropLocation.index = minIndex } } return dropLocation
6. 在界面上提示最近的插入位置
經過前面的步驟已經得到了插入位置,現(xiàn)在需要在界面上給用戶顯示相應的提示,這里要用到狀態(tài)管理庫 MobX,在此之前需將 Dragon 實例變成一個可觀察對象,再在React組件中使用 mobx-react 導出的 observer,代碼如下:
import { observer } from 'mobx-react' observer(function InsertionView() { const [style, setStyle] = useState<React.CSSProperties>({}) useEffect(() => { const dropLocation = observableProject.designer.dragon.dropLocation if (!dropLocation) { setStyle({}) } else { const { width, left, top } = dropLocation.containerRect setStyle({ borderTopStyle: 'solid', width, left, top }) } }, [observableProject.designer.dragon.dropLocation]) return ( // 這個元素被絕對定位到畫布區(qū)域的上面 <div className='vitis-insertion-view' style={style}></div> ) })
當 dragon.dropLocation 的值發(fā)生變化時,InsertionView 組件將重新渲染,實時的給用戶提示拖拽對象對接的可插入點。
寫在后面
低代碼的拖拽定位遠不止本文介紹的這些功能,至少還包含懸停探測,詳情可查看開源項目。 該開源項目持續(xù)更新。
以上就是JS分層架構低代碼跨iframe拖拽示例詳解的詳細內容,更多關于JS分層架構跨iframe拖拽的資料請關注腳本之家其它相關文章!
相關文章
PerformanceObserver自動獲取首屏時間實現(xiàn)示例
今天給大家介紹一個非常好用的瀏覽器api:?PerformanceObserver?,?我們可以用它來獲取首屏、白屏的時間,就不用再麻煩地手動去計算了2022-07-07微信小程序 wx.uploadFile在安卓手機上面the same task is working問題解決
這篇文章主要介紹了微信小程序 wx.uploadFile在安卓手機上面the same task is working問題解決的相關資料,需要的朋友可以參考下2016-12-12微信小程序 Windows2008 R2服務器配置TLS1.2方法
微信小程序免費SSL證書https、TLS版本問題的解決方案《二十四》request:fail錯誤(含https解決方案)(真機預覽問題把下面的代碼復制到PowerShell里運行一下,然后重啟服務器。# Enables TLS 1.2 on ...,需要的朋友可以參考下2016-12-12Qiankun Sentry 監(jiān)控異常上報無法自動區(qū)分項目解決
這篇文章主要為大家介紹了Qiankun Sentry 監(jiān)控異常上報無法自動區(qū)分項目解決,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2022-11-11