hendrik/lens
1
0
Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

Allow extensions to control status bar item visibility.

Browse Source 
Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>
This commit is contained in:
Panu Horsmalahti 2022-09-06 10:36:02 +03:00
parent f461b85b66
commit 9eebb9f9fb
3 changed files with 34 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/features/status-bar/status-bar-items-originating-from-extensions.test.tsx
View File

@ -8,6 +8,7 @@ import type { ApplicationBuilder } from "../../renderer/components/test-utils/ge
import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
import getRandomIdInjectable from "../../common/utils/get-random-id.injectable";
import type { FakeExtensionOptions } from "../../renderer/components/test-utils/get-extension-fake";
import { computed } from "mobx";
describe("status-bar-items-originating-from-extensions", () => {
let applicationBuilder: ApplicationBuilder;
@ -65,7 +66,7 @@ describe("status-bar-items-originating-from-extensions", () => {
const rightSide = rendered.getByTestId("status-bar-right");
const actual = getTestStatusBarTexts(rightSide, [
const actual = getExpectedTestStatusBarTexts(rightSide, [
"extension1",
"extension2",
]);
@ -95,6 +96,13 @@ describe("status-bar-items-originating-from-extensions", () => {
position: "right" as const,
},
},
{
components: {
Item: () => <div data-testid="some-testId">right4</div>,
position: "right" as const,
visible: computed(() => false),
},
},
{
components: {
Item: () => <div data-testid="some-testId">left1</div>,
@ -121,7 +129,7 @@ describe("status-bar-items-originating-from-extensions", () => {
it("shows right side status bar items in the correct order", () => {
const rightSide = rendered.getByTestId("status-bar-right");
const actual = getTestStatusBarTexts(rightSide, [
const actual = getExpectedTestStatusBarTexts(rightSide, [
"right1",
"right2",
"right3",
@ -130,10 +138,16 @@ describe("status-bar-items-originating-from-extensions", () => {
expect(actual).toEqual(["right3", "right2", "right1"]);
});
it("doesn't show invisible status bar item", () => {
const rightSide = rendered.getByTestId("status-bar-right");
expect(getTestStatusBarTexts(rightSide)).not.toContain("right4");
});
it("shows left side status bar items in the correct order", () => {
const leftSide = rendered.getByTestId("status-bar-left");
const actual = getTestStatusBarTexts(leftSide, ["left2", "left1"]);
const actual = getExpectedTestStatusBarTexts(leftSide, ["left2", "left1"]);
expect(actual).toEqual(["left1", "left2"]);
});
@ -149,7 +163,9 @@ describe("status-bar-items-originating-from-extensions", () => {
});
});
const getTestStatusBarTexts = (actual: HTMLElement, expectedTexts: string[]) =>
const getTestStatusBarTexts = (actual: HTMLElement) =>
Array.from(actual.children)
.map((elem) => elem.textContent)
.filter((elem) => elem && expectedTexts.includes(elem));
.map((elem) => String(elem.textContent));
const getExpectedTestStatusBarTexts = (actual: HTMLElement, expectedTexts: string[]) =>
getTestStatusBarTexts(actual).filter((textContent) => textContent && expectedTexts.includes(textContent));

7
src/renderer/components/status-bar/status-bar-item-registrator.injectable.tsx
View File

@ -4,6 +4,7 @@
*/
import type { Injectable } from "@ogre-tools/injectable";
import { getInjectable } from "@ogre-tools/injectable";
import type { IComputedValue } from "mobx";
import { computed } from "mobx";
import { extensionRegistratorInjectionToken } from "../../../extensions/extension-loader/extension-registrator-injection-token";
import type { LensRendererExtension } from "../../../extensions/lens-renderer-extension";
@ -38,6 +39,7 @@ const toItemInjectableFor = (extension: LensRendererExtension, getRandomId: () =
const id = `${getRandomId()}-status-bar-item-for-extension-${extension.sanitizedExtensionId}`;
let component: React.ComponentType;
let position: "left" | "right";
let visible: IComputedValue<boolean> | undefined;
if (registration?.item) {
const { item } = registration;
@ -54,7 +56,7 @@ const toItemInjectableFor = (extension: LensRendererExtension, getRandomId: () =
</>
);
} else if (registration?.components) {
const { position: pos = "right", Item } = registration.components;
const { position: pos = "right", Item, visible: componentVisible } = registration.components;
if (pos !== "left" && pos !== "right") {
throw new TypeError("StatusBarRegistration.components.position must be either 'right' or 'left'");
@ -62,6 +64,7 @@ const toItemInjectableFor = (extension: LensRendererExtension, getRandomId: () =
position = pos;
component = Item;
visible = componentVisible;
} else {
logger.warn("StatusBarRegistration must have valid item or components field");
@ -74,7 +77,7 @@ const toItemInjectableFor = (extension: LensRendererExtension, getRandomId: () =
instantiate: () => ({
component,
position,
visible: computed(() => true),
visible: visible ?? computed(() => true),
}),
injectionToken: statusBarItemInjectionToken,

7
src/renderer/components/status-bar/status-bar-registration.ts
View File

@ -3,6 +3,8 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import type { IComputedValue } from "mobx";
/**
* The props for StatusBar item component
*/
@ -23,6 +25,11 @@ export interface StatusBarComponents {
* @default "right"
*/
position?: "left" | "right";
/**
* If specified, controls item visibility
*/
visible?: IComputedValue<boolean>;
}
/**