-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make preference node rendering customizable and provide file selection (
#10766) - Introduce preference node render registry to support contributions -- Convert previous renderer factory content to default contribution -- Let new renderer factory implementation use service -- Contributions are ranked similar to open handlers - Add 'typeDetails' as generic optional property to preference schema -- Contributions may use type details for further properties - Provide base for leaf node contributions and render hints - Implement concrete string renderer for single file selection -- Usage Example: Windows terminal (external and internal)
- Loading branch information
1 parent
ed8aa41
commit 7b8d3b7
Showing
17 changed files
with
456 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 32 additions & 0 deletions
32
packages/preferences/src/browser/style/preference-file.css
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /******************************************************************************** | ||
| * Copyright (C) 2022 EclipseSource and others. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License v. 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0. | ||
| * | ||
| * This Source Code may also be made available under the following Secondary | ||
| * Licenses when the conditions for such availability set forth in the Eclipse | ||
| * Public License v. 2.0 are satisfied: GNU General Public License, version 2 | ||
| * with the GNU Classpath Exception which is available at | ||
| * https://www.gnu.org/software/classpath/license.html. | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 | ||
| ********************************************************************************/ | ||
|
|
||
| .theia-settings-container .preference-file-container { | ||
| position: relative; | ||
| display: flex; | ||
| align-items: center; | ||
| } | ||
|
|
||
| .theia-settings-container .preference-file-input { | ||
| flex: 1; | ||
| padding-right: 4px; | ||
| } | ||
|
|
||
| .theia-settings-container .preference-file-button { | ||
| position: absolute; | ||
| padding: 2px 9px; | ||
| right: 4px; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
104 changes: 104 additions & 0 deletions
104
packages/preferences/src/browser/views/components/preference-file-input.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| // ***************************************************************************** | ||
| // Copyright (C) 2022 EclipseSource and others. | ||
| // | ||
| // This program and the accompanying materials are made available under the | ||
| // terms of the Eclipse Public License v. 2.0 which is available at | ||
| // http://www.eclipse.org/legal/epl-2.0. | ||
| // | ||
| // This Source Code may also be made available under the following Secondary | ||
| // Licenses when the conditions for such availability set forth in the Eclipse | ||
| // Public License v. 2.0 are satisfied: GNU General Public License, version 2 | ||
| // with the GNU Classpath Exception which is available at | ||
| // https://www.gnu.org/software/classpath/license.html. | ||
| // | ||
| // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 | ||
| // ***************************************************************************** | ||
|
|
||
| import { nls } from '@theia/core/lib/common/nls'; | ||
| import { inject, injectable, interfaces } from '@theia/core/shared/inversify'; | ||
| import { OpenFileDialogProps } from '@theia/filesystem/lib/browser'; | ||
| import { FileDialogService } from '@theia/filesystem/lib/browser/file-dialog/file-dialog-service'; | ||
| import { WorkspaceCommands } from '@theia/workspace/lib/browser'; | ||
| import { Preference } from '../../util/preference-types'; | ||
| import { PreferenceNodeRenderer } from './preference-node-renderer'; | ||
| import { PreferenceLeafNodeRendererContribution } from './preference-node-renderer-creator'; | ||
| import { PreferenceStringInputRenderer } from './preference-string-input'; | ||
|
|
||
| export interface FileNodeTypeDetails { | ||
| isFilepath: boolean; | ||
| selectionProps?: Partial<OpenFileDialogProps>; | ||
| } | ||
|
|
||
| export namespace FileNodeTypeDetails { | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| export function is(typeDetails?: any): typeDetails is FileNodeTypeDetails { | ||
| return !!typeDetails && !!typeDetails.isFilepath; | ||
| } | ||
| } | ||
|
|
||
| @injectable() | ||
| export class PreferenceSingleFilePathInputRendererContribution extends PreferenceLeafNodeRendererContribution { | ||
| static ID = 'preference-single-file-path-input-renderer'; | ||
| id = PreferenceSingleFilePathInputRendererContribution.ID; | ||
|
|
||
| canHandleLeafNode(node: Preference.LeafNode): number { | ||
| const typeDetails = node.preference.data.typeDetails; | ||
| return FileNodeTypeDetails.is(typeDetails) && !typeDetails.selectionProps?.canSelectMany ? 5 : 0; | ||
| } | ||
|
|
||
| createLeafNodeRenderer(container: interfaces.Container): PreferenceNodeRenderer { | ||
| return container.get(PreferenceSingleFilePathInputRenderer); | ||
| } | ||
| } | ||
|
|
||
| @injectable() | ||
| export class PreferenceSingleFilePathInputRenderer extends PreferenceStringInputRenderer { | ||
| @inject(FileDialogService) fileDialogService: FileDialogService; | ||
|
|
||
| get typeDetails(): FileNodeTypeDetails { | ||
| return this.preferenceNode.preference.data.typeDetails as FileNodeTypeDetails; | ||
| } | ||
|
|
||
| protected createInputWrapper(): HTMLElement { | ||
| const inputWrapper = document.createElement('div'); | ||
| inputWrapper.classList.add('preference-file-container'); | ||
| return inputWrapper; | ||
| } | ||
|
|
||
| protected override createInteractable(parent: HTMLElement): void { | ||
| const inputWrapper = this.createInputWrapper(); | ||
|
|
||
| super.createInteractable(inputWrapper); | ||
| this.interactable.classList.add('preference-file-input'); | ||
|
|
||
| this.createBrowseButton(inputWrapper); | ||
|
|
||
| parent.appendChild(inputWrapper); | ||
| } | ||
|
|
||
| protected createBrowseButton(parent: HTMLElement): void { | ||
| const button = document.createElement('button'); | ||
| button.classList.add('theia-button', 'main', 'preference-file-button'); | ||
| button.textContent = nls.localize('theia/core/file/browse', 'Browse'); | ||
| const handler = this.browse.bind(this); | ||
| button.onclick = handler; | ||
| button.onkeydown = handler; | ||
| button.tabIndex = 0; | ||
| button.setAttribute('aria-label', 'Submit Preference Input'); | ||
| parent.appendChild(button); | ||
| } | ||
|
|
||
| protected async browse(): Promise<void> { | ||
| const selectionProps = this.typeDetails.selectionProps; | ||
| const title = selectionProps?.title ?? selectionProps?.canSelectFolders ? WorkspaceCommands.OPEN_FOLDER.dialogLabel : WorkspaceCommands.OPEN_FILE.dialogLabel; | ||
| const selection = await this.fileDialogService.showOpenDialog({ title, ...selectionProps }); | ||
| if (selection) { | ||
| this.setPreferenceImmediately(selection.path.toString()); | ||
| } | ||
| } | ||
|
|
||
| protected override setPreferenceImmediately(value: string): Promise<void> { | ||
| this.interactable.value = value; | ||
| return super.setPreferenceImmediately(value); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.