@nextcloud/files 4.0.0-beta.9 → 4.0.0-rc.1

package/dist/sidebar/SidebarTab.d.ts

@@ -20,14 +20,17 @@ export interface ISidebarContext {
  * @see https://developer.mozilla.org/en-US/docs/Web/API/Web_components
  * @see https://vuejs.org/guide/extras/web-components#building-custom-elements-with-vue
  */
-export interface SidebarComponent extends HTMLElement, ISidebarContext {
+export interface SidebarTabComponent extends ISidebarContext {
     /**
-     * This method is called by the files app if the sidebar tab state changes.
-     *
-     * @param active - The new active state
+     * The active state of the sidebar tab.
+     * It will be set to true if this component is the currently active tab.
      */
-    setActive(active: boolean): Promise<void>;
+    active: boolean;
 }
+/**
+ * The instance type of a sidebar tab web component.
+ */
+export type SidebarTabComponentInstance = SidebarTabComponent & HTMLElement;
 /**
  * Implementation of a custom sidebar tab within the files app.
  */
@@ -52,7 +55,10 @@ export interface ISidebarTab {
     order: number;
     /**
      * The tag name of the web component.
-     * The web component must already be registered under that tag name with `CustomElementRegistry.define()`.
+     *
+     * The web component must be defined using this name with `CustomElementRegistry.define()`,
+     * either on initialization or within the `onInit` callback (preferred).
+     * When rendering the sidebar tab, the files app will wait for the component to be defined in the registry (`customElements.whenDefined()`).
      *
      * To avoid name clashes the name has to start with your appid (e.g. `your_app`).
      * So in addition with the web component naming rules a good name would be `your_app-files-sidebar-tab`.
@@ -61,9 +67,19 @@ export interface ISidebarTab {
     /**
      * Callback to check if the sidebar tab should be shown for the selected node.
      *
+     * If not provided, the tab will always be shown.
+     *
      * @param context - The current context of the files app
      */
-    enabled: (context: ISidebarContext) => boolean;
+    enabled?: (context: ISidebarContext) => boolean;
+    /**
+     * Called when the sidebar tab is active and rendered the first time in the sidebar.
+     * This should be used to register the web componen (`CustomElementRegistry.define()`).
+     *
+     * The sidebar itself will anyways wait for the component to be defined in the registry (`customElements.whenDefined()`).
+     * But also will wait for the promise returned by this method to resolve before rendering the tab.
+     */
+    onInit?: () => Promise<void>;
 }
 /**
  * Register a new sidebar tab for the files app.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nextcloud/files",
-  "version": "4.0.0-beta.9",
+  "version": "4.0.0-rc.1",
   "description": "Nextcloud files utils",
   "keywords": [
     "nextcloud",
@@ -62,17 +62,16 @@
   },
   "devDependencies": {
     "@codecov/vite-plugin": "^1.9.1",
-    "@nextcloud/eslint-config": "^9.0.0-rc.5",
-    "@nextcloud/event-bus": "^3.3.3",
+    "@nextcloud/eslint-config": "^9.0.0-rc.8",
     "@nextcloud/typings": "^1.10.0",
     "@nextcloud/vite-config": "^2.5.2",
-    "@types/node": "^25.0.5",
-    "@vitest/coverage-istanbul": "^4.0.16",
+    "@types/node": "^25.1.0",
+    "@vitest/coverage-istanbul": "^4.0.18",
     "css.escape": "^1.5.1",
     "fast-xml-parser": "^5.3.3",
     "jsdom": "^27.4.0",
     "tslib": "^2.8.1",
-    "typedoc": "^0.28.15",
+    "typedoc": "^0.28.16",
     "typedoc-plugin-missing-exports": "^4.1.2",
     "typescript": "^5.9.3",
     "vite": "^7.3.1",