mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

fix: touch bar functionality on BaseWindow (#43421)

Browse source 
* fix: touch bar functionality on BaseWindow

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

* test: add test for BaseWindow.setTouchBar

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

---------

Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>
This commit is contained in:
trop[bot] 2024-08-22 14:14:51 -04:00 • committed by GitHub
parent a159afc2e9
commit a9a117ed71
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 96 additions and 90 deletions
Download patch file Download diff file Expand all files Collapse all files

152
spec/api-touch-bar-spec.ts
View file

@ -1,5 +1,5 @@
import * as path from 'node:path';
import { BrowserWindow, TouchBar } from 'electron/main';
import { BaseWindow, BrowserWindow, TouchBar } from 'electron/main';
import { closeWindow } from './lib/window-helpers';
import { expect } from 'chai';
@ -47,82 +47,86 @@ describe('TouchBar module', () => {
}).to.throw('Cannot add a single instance of TouchBarItem multiple times in a TouchBar');
});
describe('BrowserWindow behavior', () => {
let window: BrowserWindow;
describe('Window behavior', () => {
for (const WindowType of [BrowserWindow, BaseWindow]) {
describe(`in ${WindowType.name}`, () => {
let window: BaseWindow | BrowserWindow;
beforeEach(() => {
window = new BrowserWindow({ show: false });
});
beforeEach(() => {
window = new WindowType({ show: false });
});
afterEach(async () => {
window.setTouchBar(null);
await closeWindow(window);
window = null as unknown as BrowserWindow;
});
afterEach(async () => {
window.setTouchBar(null);
await closeWindow(window);
window = null as unknown as BaseWindow | BrowserWindow;
});
it('can be added to and removed from a window', () => {
const label = new TouchBarLabel({ label: 'bar' });
const touchBar = new TouchBar({
items: [
new TouchBarButton({ label: 'foo', backgroundColor: '#F00', click: () => { } }),
new TouchBarButton({
icon: path.join(__dirname, 'fixtures', 'assets', 'logo.png'),
iconPosition: 'right',
click: () => { }
}),
new TouchBarColorPicker({ selectedColor: '#F00', change: () => { } }),
new TouchBarGroup({ items: new TouchBar({ items: [new TouchBarLabel({ label: 'hello' })] }) }),
label,
new TouchBarOtherItemsProxy(),
new TouchBarPopover({ items: new TouchBar({ items: [new TouchBarButton({ label: 'pop' })] }) }),
new TouchBarSlider({ label: 'slide', value: 5, minValue: 2, maxValue: 75, change: () => { } }),
new TouchBarSpacer({ size: 'large' }),
new TouchBarSegmentedControl({
segmentStyle: 'capsule',
segments: [{ label: 'baz', enabled: false }],
selectedIndex: 5
}),
new TouchBarSegmentedControl({ segments: [] }),
new TouchBarScrubber({
items: [{ label: 'foo' }, { label: 'bar' }, { label: 'baz' }],
selectedStyle: 'outline',
mode: 'fixed',
showArrowButtons: true
})
]
it('can be added to and removed from a window', () => {
const label = new TouchBarLabel({ label: 'bar' });
const touchBar = new TouchBar({
items: [
new TouchBarButton({ label: 'foo', backgroundColor: '#F00', click: () => { } }),
new TouchBarButton({
icon: path.join(__dirname, 'fixtures', 'assets', 'logo.png'),
iconPosition: 'right',
click: () => { }
}),
new TouchBarColorPicker({ selectedColor: '#F00', change: () => { } }),
new TouchBarGroup({ items: new TouchBar({ items: [new TouchBarLabel({ label: 'hello' })] }) }),
label,
new TouchBarOtherItemsProxy(),
new TouchBarPopover({ items: new TouchBar({ items: [new TouchBarButton({ label: 'pop' })] }) }),
new TouchBarSlider({ label: 'slide', value: 5, minValue: 2, maxValue: 75, change: () => { } }),
new TouchBarSpacer({ size: 'large' }),
new TouchBarSegmentedControl({
segmentStyle: 'capsule',
segments: [{ label: 'baz', enabled: false }],
selectedIndex: 5
}),
new TouchBarSegmentedControl({ segments: [] }),
new TouchBarScrubber({
items: [{ label: 'foo' }, { label: 'bar' }, { label: 'baz' }],
selectedStyle: 'outline',
mode: 'fixed',
showArrowButtons: true
})
]
});
const escapeButton = new TouchBarButton({ label: 'foo' });
window.setTouchBar(touchBar);
touchBar.escapeItem = escapeButton;
label.label = 'baz';
escapeButton.label = 'hello';
window.setTouchBar(null);
window.setTouchBar(new TouchBar({ items: [new TouchBarLabel({ label: 'two' })] }));
touchBar.escapeItem = null;
});
it('calls the callback on the items when a window interaction event fires', (done) => {
const button = new TouchBarButton({
label: 'bar',
click: () => {
done();
}
});
const touchBar = new TouchBar({ items: [button] });
window.setTouchBar(touchBar);
window.emit('-touch-bar-interaction', {}, (button as any).id);
});
it('calls the callback on the escape item when a window interaction event fires', (done) => {
const button = new TouchBarButton({
label: 'bar',
click: () => {
done();
}
});
const touchBar = new TouchBar({ escapeItem: button });
window.setTouchBar(touchBar);
window.emit('-touch-bar-interaction', {}, (button as any).id);
});
});
const escapeButton = new TouchBarButton({ label: 'foo' });
window.setTouchBar(touchBar);
touchBar.escapeItem = escapeButton;
label.label = 'baz';
escapeButton.label = 'hello';
window.setTouchBar(null);
window.setTouchBar(new TouchBar({ items: [new TouchBarLabel({ label: 'two' })] }));
touchBar.escapeItem = null;
});
it('calls the callback on the items when a window interaction event fires', (done) => {
const button = new TouchBarButton({
label: 'bar',
click: () => {
done();
}
});
const touchBar = new TouchBar({ items: [button] });
window.setTouchBar(touchBar);
window.emit('-touch-bar-interaction', {}, (button as any).id);
});
it('calls the callback on the escape item when a window interaction event fires', (done) => {
const button = new TouchBarButton({
label: 'bar',
click: () => {
done();
}
});
const touchBar = new TouchBar({ escapeItem: button });
window.setTouchBar(touchBar);
window.emit('-touch-bar-interaction', {}, (button as any).id);
});
};
});
});