GridCraft.WebView | GridCraft

GridCraft.WebView

The web view that displays the grid. Users won’t interact with this module directly, but it is used by the GridCraft module. We consider this an internal module and provide no stability guarantees between minor versions.

API Overview #

Constants - Useful values which cannot be changed
- css
- js
Functions - API calls offered directly by the extension
Constructors - API calls which return an object, typically one that offers API methods
- webView

API Documentation #

Constants #

css #

Signature	`GridCraft.WebView.css`
Type	Constant
Description	The CSS for the web view

js #

Signature	`GridCraft.WebView.js`
Type	Constant
Description	The JavaScript for the web view

Functions #

itemTableHtml #

Signature	`GridCraft.WebView.itemTableHtml(table) -> string`
Type	Function
Description	Generates an HTML table from a list of items.
Parameters	actionTable - A table of rows, each of which is a table of actions.
Returns	string containing the HTML for the item table

webViewHtml #

Signature	`GridCraft.WebView.webViewHtml(string, string) -> string`
Type	Function
Description	Generates the complete HTML for a web view, including the title, CSS, JS, and item table.
Parameters	title - The title of the web view itemTable - The HTML table generated from the actionTable config - A GridCraft.Configuration object containing the configuration for the grid
Returns	string containing the complete HTML for the web view

configuredScreen #

Signature	`GridCraft.WebView.configuredScreen(config) -> hs.screen object`
Type	Function
Description	Returns the screen that is configured for the web view.
Parameters	config - (table) A GridCraft.Configuration object containing the configuration for the grid
Returns	The configured screen object, or the primary screen if no specific configuration is set or if any screen is not found.

resizeCenter #

Signature	`GridCraft.WebView.resizeCenter(hs.webview.object, [number], [number]) -> hs.webview.object`
Type	Function
Description	Resizes and centers a web view on the main screen.
Parameters	wv - The web view to resize and center config - (table) A GridCraft.Configuration object
Returns	The resized and centered web view

Constructors #

webView #

Signature	`GridCraft.WebView.webView(string, table, number, number) -> hs.webview object`
Type	Constructor
Description	Creates a new web view intended for modal messages.
Parameters	title - (string) The title of the web view items - (table) A list of rows, each of which is a table of actions. config - (table) A GridCraft.Configuration object
Returns	A hs.webview object