Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
// Scripts build their vnodes with core's `h`, so compat's `options.vnode` hook is what gives their
// components `defaultProps` and their numeric styles a `px` unit.
import "preact/compat";
import { createContext, Fragment, h, VNode } from "preact";
import * as hooks from "preact/hooks";
import NoteColorPicker from "../menus/custom-items/NoteColorPicker";
import Calendar from "../widgets/collections/calendar/calendar";
import Table from "../widgets/collections/table/tabulator";
import ActionButton from "../widgets/react/ActionButton";
import Admonition from "../widgets/react/Admonition";
import Button from "../widgets/react/Button";
import CKEditor from "../widgets/react/CKEditor";
import Collapsible, { ExternallyControlledCollapsible } from "../widgets/react/Collapsible";
import ColorPicker from "../widgets/react/ColorPicker";
import Dropdown, { DropdownPanel } from "../widgets/react/Dropdown";
import FormCheckbox from "../widgets/react/FormCheckbox";
import FormDropdownList from "../widgets/react/FormDropdownList";
import { FormFileUploadActionButton, FormFileUploadButton } from "../widgets/react/FormFileUpload";
import FormGroup from "../widgets/react/FormGroup";
import { FormDropdownDivider, FormDropdownSubmenu, FormListItem } from "../widgets/react/FormList";
import FormRadioGroup from "../widgets/react/FormRadioGroup";
import FormText from "../widgets/react/FormText";
import FormTextArea from "../widgets/react/FormTextArea";
import FormTextBox from "../widgets/react/FormTextBox";
import FormToggle from "../widgets/react/FormToggle";
import * as triliumHooks from "../widgets/react/hooks";
import Icon from "../widgets/react/Icon";
import LinkButton from "../widgets/react/LinkButton";
import LoadingSpinner from "../widgets/react/LoadingSpinner";
import { ScriptModal } from "../widgets/react/Modal";
import NoteAutocomplete from "../widgets/react/NoteAutocomplete";
import NoteLink from "../widgets/react/NoteLink";
import RawHtml from "../widgets/react/RawHtml";
import Slider from "../widgets/react/Slider";
import { SortableCard } from "../widgets/react/SortableCard";
import RightPanelWidget from "../widgets/sidebar/RightPanelWidget";
export interface WidgetDefinition {
parent: "left-pane" | "center-pane" | "note-detail-pane" | "right-pane",
render: () => VNode,
position?: number,
}
export interface WidgetDefinitionWithType extends WidgetDefinition {
type: "preact-widget"
}
export interface LauncherWidgetDefinitionWithType {
type: "preact-launcher-widget"
render: () => VNode
}
export const preactAPI = Object.freeze({
// Core
h,
Fragment,
createContext,
/**
* Method that must be run for widget scripts that run on Preact, using JSX. The method just returns the same definition, reserved for future typechecking and perhaps validation purposes.
*
* @param definition the widget definition.
*/
defineWidget(definition: WidgetDefinition) {
return {
type: "preact-widget",
...definition
};
},
defineLauncherWidget(definition: Omit<LauncherWidgetDefinitionWithType, "type">) {
return {
type: "preact-launcher-widget",
...definition
};
},
// Basic widgets
ActionButton,
Admonition,
Button,
Calendar,
CKEditor,
Collapsible, ExternallyControlledCollapsible,
ColorPicker,
Dropdown, DropdownPanel,
FormCheckbox,
FormDropdownList,
FormFileUploadButton, FormFileUploadActionButton,
FormGroup,
FormListItem, FormDropdownDivider, FormDropdownSubmenu,
FormRadioGroup,
FormText,
FormTextArea,
FormTextBox,
FormToggle,
Icon,
LinkButton,
LoadingSpinner,
Modal: ScriptModal,
NoteAutocomplete,
NoteColorPicker,
NoteLink,
RawHtml,
Slider,
SortableCard,
Table,
// Specialized widgets
RightPanelWidget,
...hooks,
...triliumHooks
});
// --- Drift guard ------------------------------------------------------------
// The shared `trilium:preact` component surface lives in @triliumnext/commons
// (self-contained, consumed by the in-editor language service and the
// script-deployer). This fails to compile — naming the offending member — if
// that surface declares a component/helper that's no longer exposed by the real
// `preactAPI` here. (Preact core + hooks are re-exported straight from `preact`,
// so they aren't part of the shared surface and aren't checked.)
type _PublicPreactExports = keyof typeof import("@triliumnext/commons/src/lib/script_api_preact.js");
type _MissingPreactMembers = Exclude<_PublicPreactExports, keyof typeof preactAPI>;
const _preactDriftGuard: [_MissingPreactMembers] extends [never] ? true : _MissingPreactMembers = true;