@deephaven/embed-grid 0.49.1-beta.1 → 0.49.1-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -12,6 +12,24 @@ This project uses [Vite](https://vitejs.dev/). It is to provide an example React
12
12
 
13
13
  - `name`: Required. The name of the table to load
14
14
 
15
+ ## Usage
16
+
17
+ You simply need to provide the URL to embed the iframe. Also add the `clipboard-write` permission to allow copying when embedded, e.g.:
18
+
19
+ ```
20
+ <html>
21
+ <body>
22
+ <h1>Dev</h1>
23
+ <iframe
24
+ src="http://localhost:4010/?name=t"
25
+ width="800"
26
+ height="500"
27
+ allow="clipboard-write"
28
+ ></iframe>
29
+ </body>
30
+ </html>
31
+ ```
32
+
15
33
  ## API
16
34
 
17
35
  The iframe provides an API to perform some basic actions with the table loaded. Use by posting the command/value as a [postMessage](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) to the `contentWindow` of the iframe element, e.g. `document.getElementById('my-iframe').contentWindow.postMessage({ command, value }, 'http://localhost:4010')`