inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-06-15 11:35:41 +00:00
Code Activity

rename 'renderContext' -> 'featureContext' as not all features may render something

Browse Source
This commit is contained in:
wolflu05
2024-09-18 11:17:56 +02:00
parent ca17a07322
commit 5ec5aa7264
4 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/backend/InvenTree/plugin/samples/static/plugin/sample_template_editor.js
View File

@ -1,11 +1,11 @@
export function getFeature({ renderContext, pluginContext }) { export function getFeature({ featureContext, pluginContext }) {
const { ref } = renderContext; const { ref } = featureContext;
console.log("Template editor feature was called with", renderContext, pluginContext); console.log("Template editor feature was called with", featureContext, pluginContext);
const t = document.createElement("textarea"); const t = document.createElement("textarea");
t.rows = 25; t.rows = 25;
t.cols = 60; t.cols = 60;
renderContext.registerHandlers({ featureContext.registerHandlers({
setCode: (code) => { setCode: (code) => {
t.value = code; t.value = code;
}, },

8
src/backend/InvenTree/plugin/samples/static/plugin/sample_template_preview.js
View File

@ -1,8 +1,8 @@
export function getFeature({ renderContext, pluginContext }) { export function getFeature({ featureContext, pluginContext }) {
const { ref } = renderContext; const { ref } = featureContext;
console.log("Template preview feature was called with", renderContext, pluginContext); console.log("Template preview feature was called with", featureContext, pluginContext);
renderContext.registerHandlers({ featureContext.registerHandlers({
updatePreview: (...args) => { updatePreview: (...args) => {
console.log("updatePreview", args); console.log("updatePreview", args);
} }

20
src/frontend/src/components/plugins/PluginUIFeatureTypes.ts
View File

@ -9,18 +9,18 @@ export type BaseUIFeature = {
featureType: string; featureType: string;
requestContext: Record<string, any>; requestContext: Record<string, any>;
responseOptions: Record<string, any>; responseOptions: Record<string, any>;
renderContext: Record<string, any>; featureContext: Record<string, any>;
renderReturnType: any; featureReturnType: any;
}; };
export type PluginUIGetFeatureType<T extends BaseUIFeature> = (params: { export type PluginUIGetFeatureType<T extends BaseUIFeature> = (params: {
renderContext: T['renderContext']; featureContext: T['featureContext'];
inventreeContext: InvenTreeContext; inventreeContext: InvenTreeContext;
}) => T['renderReturnType']; }) => T['featureReturnType'];
export type PluginUIFuncWithoutInvenTreeContextType<T extends BaseUIFeature> = ( export type PluginUIFuncWithoutInvenTreeContextType<T extends BaseUIFeature> = (
renderContext: T['renderContext'] featureContext: T['featureContext']
) => T['renderReturnType']; ) => T['featureReturnType'];
export type PluginUIFeatureAPIResponse<T extends BaseUIFeature> = { export type PluginUIFeatureAPIResponse<T extends BaseUIFeature> = {
feature_type: T['featureType']; feature_type: T['featureType'];
@ -40,7 +40,7 @@ export type TemplateEditorUIFeature = {
title: string; title: string;
icon: InvenTreeIconType; icon: InvenTreeIconType;
}; };
renderContext: { featureContext: {
ref: HTMLDivElement; ref: HTMLDivElement;
registerHandlers: (handlers: { registerHandlers: (handlers: {
setCode: (code: string) => void; setCode: (code: string) => void;
@ -48,7 +48,7 @@ export type TemplateEditorUIFeature = {
}) => void; }) => void;
template: TemplateI; template: TemplateI;
}; };
renderReturnType: void; featureReturnType: void;
}; };
export type TemplatePreviewUIFeature = { export type TemplatePreviewUIFeature = {
@ -62,7 +62,7 @@ export type TemplatePreviewUIFeature = {
title: string; title: string;
icon: InvenTreeIconType; icon: InvenTreeIconType;
}; };
renderContext: { featureContext: {
ref: HTMLDivElement; ref: HTMLDivElement;
template: TemplateI; template: TemplateI;
registerHandlers: (handlers: { registerHandlers: (handlers: {
@ -74,5 +74,5 @@ export type TemplatePreviewUIFeature = {
) => void | Promise<void>; ) => void | Promise<void>;
}) => void; }) => void;
}; };
renderReturnType: void; featureReturnType: void;
}; };

4
src/frontend/src/hooks/UsePluginUIFeature.tsx
View File

@ -72,7 +72,7 @@ export function usePluginUIFeature<UIFeatureT extends BaseUIFeature>({
return ( return (
pluginData?.map((feature) => ({ pluginData?.map((feature) => ({
options: feature.options, options: feature.options,
func: (async (renderContext) => { func: (async (featureContext) => {
const func = await findExternalPluginFunction( const func = await findExternalPluginFunction(
feature.source, feature.source,
'getFeature' 'getFeature'
@ -80,7 +80,7 @@ export function usePluginUIFeature<UIFeatureT extends BaseUIFeature>({
if (!func) return; if (!func) return;
return func({ return func({
renderContext, featureContext,
inventreeContext inventreeContext
}); });
}) as PluginUIFuncWithoutInvenTreeContextType<UIFeatureT> }) as PluginUIFuncWithoutInvenTreeContextType<UIFeatureT>