vim-webgl-component
Version:
A demonstration app built on top of the vim-webgl-viewer
28 lines (27 loc) • 775 B
TypeScript
/**
* @module public-api
*/
/**
* Basic HTML structure that the webgl component expects
*/
export type VimComponentContainer = {
/**
* Root of the viewer, all component ui should have this as an acestor.
*/
root: HTMLElement;
/**
* Div where to instantiate ui elements.
*/
ui: HTMLDivElement;
/**
* Div to hold viewer canvases and ui
*/
gfx: HTMLDivElement;
dispose: () => void;
};
/**
* Creates a default container for the vim component around a vim viewer
* The element is created if not provided. The element will be made position:absolute.
* @element optional HTML element to use as root
*/
export declare function createContainer(element?: HTMLElement): VimComponentContainer;