gristlabs_grist-core/app/plugin/CustomSectionAPI-ti.ts
Jarosław Sadziński 85ef873ce5 (core) Widget options api
Summary:
Adding configuration options for CustomWidgets.

Custom widgets can now store options (in JSON) in viewSection metadata.

Changes in grist-plugin-api:
- Adding onOptions handler, that will be invoked when the widget is ready and when the configuration is changed
- Adding WidgetAPI - new API to read and save a configuration for widget.

Changes in Grist:
- Rewriting CustomView code, and extracting code that is responsible for showing the iframe and registering Rpc.
- Adding Open Configuration button to Widget section in the Creator panel and in the section menu.
- Custom Widgets can implement "configure" method, to show configuration screen when requested.

Test Plan: Browser tests.

Reviewers: paulfitz, dsagal

Reviewed By: paulfitz

Differential Revision: https://phab.getgrist.com/D3185
2022-01-13 11:10:17 +01:00

26 lines
675 B
TypeScript

/**
* This module was automatically generated by `ts-interface-builder`
*/
import * as t from "ts-interface-checker";
// tslint:disable:object-literal-key-quotes
export const RequestedInteractionOptions = t.iface([], {
"requiredAccess": t.opt("string"),
"hasCustomOptions": t.opt("boolean"),
});
export const InteractionOptions = t.iface([], {
"accessLevel": "string",
});
export const CustomSectionAPI = t.iface([], {
"configure": t.func("void", t.param("customOptions", "RequestedInteractionOptions")),
});
const exportedTypeSuite: t.ITypeSuite = {
RequestedInteractionOptions,
InteractionOptions,
CustomSectionAPI,
};
export default exportedTypeSuite;