diff --git a/README.md b/README.md index 7871a41..9d12aae 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,8 @@ To see the API in action, you can run the using `npm run dev`, see section [Development](#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. # Installation @@ -279,9 +280,7 @@ export function activate() { 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`](https://forman.github.io/extendit/functions/core.loadCodeContribution.html) function: @@ -324,7 +323,7 @@ export default function CommandButton({ command }: CommandButtonProps) { # Documentation -We currently only have this file, the +We currently only have this file and the [API docs](https://forman.github.io/extendit/), sorry. # Development diff --git a/TODO.md b/TODO.md index 98142f0..b0ca231 100644 --- a/TODO.md +++ b/TODO.md @@ -2,7 +2,6 @@ ## For first stable version -* Find out how to test React hooks using `vitest`. * Make `contrib` an own toplevel subpackage - Every contribution point should go into a separate submodule. - Every submodule should be exported, so points can diff --git a/index.html b/index.html index 54b52a0..534036a 100644 --- a/index.html +++ b/index.html @@ -12,62 +12,6 @@
- Click to install an extension. Installing means registering an extension
- in the application using the
Shows all available commands of the{" "}
+ This is a simple React application that demonstrates how extensions are
+ installed, activated, and how they can contribute to an application.
+ Contributions may be anything. Here they are commands,{" "}
+ menus, and views. Commands are named JS functions,
+ menus contains menu items that refer to commands, and views are React
+ components. The "Show X" commands select a given given view,
+ while the "Print X" commands output a message to the Developer
+ Tools console (press CTRL SHIFT I to
+ open). Note, this page is best viewed using your browser's dark
+ mode.
+
- Extensions will be auto-activated when you click a corresponding command
- below. Already activated extensions are disabled. Click to activate
- manually using the
Shows the contributions made to the
Shows a selected view (UI component) of the{" "}
ExtendIt.js Demo
+ Installed Extensions
+ Installed Extensions
Main Menu
+ Main Menu
main
menu of the{" "}
+
+
Current View: {selectedView ? selectedView.title : "No view selected"}
-