mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-10-27 20:44:07 +00:00
4c25aa7d3d
Test Plan: Manual. Reviewers: jarek Reviewed By: jarek Differential Revision: https://phab.getgrist.com/D4036
96 lines
2.6 KiB
TypeScript
96 lines
2.6 KiB
TypeScript
/**
|
|
* API definitions for CustomSection plugins.
|
|
*/
|
|
|
|
export interface ColumnToMap {
|
|
/**
|
|
* Column name that Widget expects. Must be a valid JSON property name.
|
|
*/
|
|
name: string;
|
|
/**
|
|
* Title or short description of a column (used as a label in section mapping).
|
|
*/
|
|
title?: string|null,
|
|
/**
|
|
* Optional long description of a column (used as a help text in section mapping).
|
|
*/
|
|
description?: string|null,
|
|
/**
|
|
* Column type, by default ANY.
|
|
*/
|
|
type?: string, // GristType, TODO: ts-interface-checker doesn't know how to parse this
|
|
/**
|
|
* Mark column as optional all columns are required by default.
|
|
*/
|
|
optional?: boolean
|
|
/**
|
|
* Allow multiple column assignment, the result will be list of mapped table column names.
|
|
*/
|
|
allowMultiple?: boolean,
|
|
}
|
|
|
|
export type ColumnsToMap = (string|ColumnToMap)[];
|
|
|
|
/**
|
|
* Initial message sent by the CustomWidget with initial requirements.
|
|
*/
|
|
export interface InteractionOptionsRequest {
|
|
/**
|
|
* Required access level. If it wasn't granted already, Grist will prompt user to change the current access
|
|
* level.
|
|
*/
|
|
requiredAccess?: string,
|
|
/**
|
|
* Instructs Grist to show additional menu options that will trigger onEditOptions callback, that Widget
|
|
* can use to show custom options screen.
|
|
*/
|
|
hasCustomOptions?: boolean,
|
|
/**
|
|
* Tells Grist what columns Custom Widget expects and allows user to map between existing column names
|
|
* and those requested by Custom Widget.
|
|
*/
|
|
columns?: ColumnsToMap,
|
|
/**
|
|
* Show widget as linking source.
|
|
*/
|
|
allowSelectBy?: boolean,
|
|
}
|
|
|
|
/**
|
|
* Widget configuration set and approved by Grist, sent as part of ready message.
|
|
*/
|
|
export interface InteractionOptions{
|
|
/**
|
|
* Granted access level.
|
|
*/
|
|
accessLevel: string,
|
|
/**
|
|
* Information about the current Grist theme.
|
|
*
|
|
* Includes the theme appearance ("light" or "dark"), and a mapping of UI elements to
|
|
* CSS color values. The CSS values are also accessible within a widget via CSS variables
|
|
* prefixed with "--grist-theme-" (e.g. `var(--grist-theme-text)`).
|
|
*
|
|
* NOTE: the variables aren't yet finalized and may change in the future.
|
|
*/
|
|
theme: any;
|
|
}
|
|
|
|
/**
|
|
* Current columns mapping between viewFields in section and Custom widget.
|
|
*/
|
|
export interface WidgetColumnMap {
|
|
[key: string]: string|string[]|null
|
|
}
|
|
|
|
export interface CustomSectionAPI {
|
|
/**
|
|
* Initial request from a Custom Widget that wants to declare its requirements.
|
|
*/
|
|
configure(customOptions: InteractionOptionsRequest): Promise<void>;
|
|
/**
|
|
* Returns current widget configuration (if requested through configuration method).
|
|
*/
|
|
mappings(): Promise<WidgetColumnMap|null>;
|
|
}
|