polotno-node 2.0.1 → 2.0.3

package/README.md

@@ -133,7 +133,9 @@ res.json({ url });
 
 ### `instance.run()`
 
-Run any Polotno store API directly inside web-page context
+Run any Polotno store API directly inside web-page context.
+
+**Warning: by default every `run` and every export function will create a new page with its own editor and context.** If you want to make and export after you use `instance.run()` you must do it inside the same `run` function.
 
 ```js
 // we can't directly use "json" variable inside the run function
@@ -152,6 +154,40 @@ const url = await instance.run(async (json) => {
 }, json);
 ```
 
+### `window.config` usage
+
+`window.config` is a global object that has some functions from `polotno/config` module. You can use it to add custom fonts and customize some settings.
+Not all options are supported yet. If you see anything missing, please create an issue. You can see all available options in `client.js` file.
+
+You should be able to change config before you call `store.loadJSON` function and do you export.
+
+```js
+const url = await instance.run(async (json) => {
+  // you can use global "config" object that has some functions from "polotno/config" module
+  window.config.unstable_setTextVerticalResizeEnabled(true);
+  // you can use global "store" object
+  store.loadJSON(json);
+  return store.toDataURL();
+}, json);
+```
+
+## Your own client
+
+By default `polotno-node` ships with the default Polotno Editor with its (hopefully) last version. If you use experimental API such as `unstable_registerShapeModel` and `unstable_registerShapeComponent`, the rendering may fail if you use unknow elements types.
+
+In that case you can use your own client editor. You need to create a public html page with `store` as global variable and mount just `<Workspace />` component from `polotno/canvas` module. Take a look into `client.html` file and `client.js` file in this repo as a demo. In your own version of the Editor you can use experimental API to define custom components.
+
+Pass `url` option to `createInstance` function with public url of your client editor.
+
+```js
+const { createInstance } = require('polotno-node');
+
+const instance = await createInstance({
+  key: 'KEY',
+  url: 'https://yourappdomain.com/client',
+});
+```
+
 ## Browserless usage
 
 By default `polotno-node` will import browser bundle using `chrome-aws-lambda`. But you can use `browserless` instead, to keep your cloud function smaller.