Static fromOptional Returns JsonValidationErrorOptional Readonly errorsReadonly targetReadonly valueAbstract toAbstractReturns string
Optional Private Readonly expressionPrivate Optional Readonly optionsPrivate posPrivate Readonly tokensPrivate movePrivate
Private parsePrivate
Private parsePrivate
Private parseRest ...opIds: string[]Rest Private parsePrivate
Private parsePrivate
Private parsePrivate
Private parsePrivate parsePrivate
Private parsePrivate parsePrivate
Private parsePrivate
Private parsePrivate
Private parsePrivate parsePrivate
Private parsePrivate
Private parsePrivate parsePrivate
Private parsePrivate parsePrivate
Private parseRest ...opIds: string[]Rest Private tokenPrivate
Static parseOptional Returns Node<unknown>
Readonly
Readonly expressionReadonly
Readonly lineReadonly
Readonly
Optional Readonly logRest Returns void
Optional Readonly styleOptional
Readonly valueReadonly
Static Readonly ALLStatic Static Readonly DEBUGStatic Static Private Readonly DEFAULTStatic Readonly ERRORStatic Static Readonly INFOStatic Static Private Readonly LEVELSStatic Readonly OFFStatic Static Readonly WARNStatic Static The log label or undefined if no such level exists.
Gets the log level for the given log label.
+The log label, "OFF", "ALL", "DEBUG", + "INFO", "WARN", or "ERROR".
+The log label or the given defaultLevel
+ if no such level exists.
Private
Private Optional logRest Returns void
Private Readonly namePrivate
Private seenStatic Private globalRest Returns void
Rest Returns void
Rest Returns void
Rest Returns void
+Log data with given level.
@@ -291,7 +291,7 @@Rest Returns void
+Rest Returns void
Rest Returns void
Static getStatic Static setRest Optional Optional Error - If the contribution point is unknown or if the contribution identifier is not registered
Optional Returns asserts condition
Optional Returns asserts value is NonNullable<T>
npm run dev,
see section Development below. It is a simple React
application that demonstrates how extensions are installed,
-activated, and how they contribute UI elements to the application.
+activated, and how they can contribute elements such as commands or
+UI components to an application.
npm install @forman2/extendit
or
@@ -120,8 +121,7 @@Such code contributions are loaded lazily. Only the first time a code contribution is needed by a consumer, the contributing extension will be -activated.
-Therefore, code contributions are loaded asynchronously using the
+activated. Therefore, code contributions are loaded asynchronously using the
loadCodeContribution
function:
import { loadCodeContribution } from "@forman2/extendit";
import { type Command } from "./command";
async function getCommand(commandId: string): Promise<Command> {
return await loadCodeContribution<Command>("commands", commandId);
}
@@ -131,7 +131,7 @@ @forman2/extendit
import { useLoadCodeContribution } from "@forman2/extendit/react";
import { type Command } from "./command";
interface CommandButtonProps {
command: Command;
}
export default function CommandButton({ command }: CommandButtonProps) {
const commandCode = useLoadCodeContribution("commands", command.id);
if (!commandCode) { // Happens on first render only
return null;
}
return (
<button
onClick={commandCode.data}
disabled={commandCode.loading || commandCode.error}
>
{command.title}
</button>
);
}
We currently only have this file, the +
We currently only have this file and the API docs, sorry.
Get sources and install dependencies first:
$ git clone https://github.com/forman/extendit
$ cd extendit
$ npm install
diff --git a/docs/interfaces/contrib.Command.html b/docs/interfaces/contrib.Command.html
index 8ab39b5..4b5b085 100644
--- a/docs/interfaces/contrib.Command.html
+++ b/docs/interfaces/contrib.Command.html
@@ -23,7 +23,7 @@ Hierarchy
- Command
+Defined in src/framework/contrib/commands.ts:35
@@ -46,41 +46,41 @@ Optionalcategory?: string
Optional checkedOptional enablementOptional iconOptional titleOptional tooltipOptionalcategory?: stringOptional checkedOptional enablementOptional iconOptional titleOptional tooltipOptionalargs?: (null | string | number | boolean)[]Optional checkedOptional disabledOptional iconOptional keybindingOptional orderOptional childrenOptional iconOptionalicon?: stringOptionalargs?: (null | string | number | boolean)[]Optional macOptional whenOptionalargs?: (null | string | number | boolean)[]Optional macOptional whenOptionalargs?: (null | string | number | boolean)[]Optional checkedOptional commandOptional disabledOptional iconOptional keybindingOptional submenuOptionalargs?: (null | string | number | boolean)[]Optional commandOptional groupOptional iconOptional labelOptional submenuOptional whenOptional orderOptional titleOptionalicon?: stringOptional titleOptional whenOptional
Optional errorOptional
Optional
Optional idOptional
Optional
Optional descriptionOptional
Optional manifestOptional
Readonly
Readonly idReadonly
Readonly manifestReadonly
Optional Readonly reasonsOptional
Readonly statusReadonly
Readonly
Readonly moduleReadonly
Readonly subscriptionsReadonly
Optional onOptional onOptional contributesOptional descriptionOptional displayOptional extensionOptional mainOptional versionRest Optional deactivateOptional
Optional pathOptional
Optional
Optionalconst?: booleanOptional defaultOptional descriptionOptional enumOptional enumOptional enumOptional hiddenOptional markdownOptional markdownOptional orderOptional constOptional defaultOptional descriptionOptional enumOptional enumOptional enumOptional hiddenOptional markdownOptional markdownOptional maxOptional minOptional orderOptionalconst?: numberOptional defaultOptional descriptionOptional enumOptional enumOptional enumOptional exclusiveOptional exclusiveOptional formatOptional hiddenOptional markdownOptional markdownOptional maximumOptional minimumOptional multipleOptional orderOptional constOptional defaultOptional descriptionOptional enumOptional enumOptional enumOptional hiddenOptional markdownOptional markdownOptional orderOptional requiredOptionalconst?: stringOptional defaultOptional descriptionOptional editOptional enumOptional enumOptional enumOptional formatOptional hiddenOptional markdownOptional markdownOptional maxOptional minOptional orderOptional patternOptional constOptional defaultOptional descriptionOptional enumOptional enumOptional enumOptional hiddenOptional markdownOptional markdownOptional orderOptional tupleOptional defaultOptional descriptionOptional enumOptional enumOptional enumOptional hiddenOptional markdownOptional markdownOptional orderOptional
Rest ...args: ARest Const Const <
Const Const
Const Const
Const Const Const
Gets the log level for the given log label.
+