-
Notifications
You must be signed in to change notification settings - Fork 8.6k
Allow editing actions in the settings UI #18917
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: dev/pabhoj/settings_model_reflection
Are you sure you want to change the base?
Allow editing actions in the settings UI #18917
Conversation
…ettings_actions_editor
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
…ettings_actions_editor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other feedback:
- "Clear buffer" action is being shown as "Clear mark" (binding to ctrl+shift+k shown correctly)
<!-- Key Chord Text --> | ||
<Border Grid.Column="1" | ||
Padding="2,0,2,0" | ||
HorizontalAlignment="Right" | ||
VerticalAlignment="Center" | ||
Style="{ThemeResource KeyChordBorderStyle}" | ||
Visibility="{x:Bind mtu:Converters.InvertedBooleanToVisibility(IsInEditMode), Mode=OneWay}"> | ||
|
||
<TextBlock FontSize="14" | ||
Style="{ThemeResource KeyChordTextBlockStyle}" | ||
Text="{x:Bind KeyChordText, Mode=OneWay}" | ||
TextWrapping="WrapWholeWords" /> | ||
</Border> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Key bindings aren't shown anymore
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is intentional for now since some commands can have multiple keybindings bound to them. As a follow up we can convert these list view items into expanders that show 1-3 of the associated keybindings
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It'd be really nice if you added a comment by each of the ArgWrapper data templates saying what's a good action type and arg combo to test this out. I've been manually going through ActionArgs.h to figure this out. Not the end of the world, but it'd be a nice QOL improvement 😁
Almost done reviewing this. Just need to go over ActionsViewModel
Grid.Row="3" | ||
Grid.Column="0" | ||
VerticalAlignment="Center" /> | ||
<ListView Grid.Row="3" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider ItemsRepeater instead of ListView. We're not using the functionality of the ListView, really. We just want a stack panel layout of our own controls.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ItemsControl
works too. I used it over in my extensions page:
<ItemsControl x:Name="ActiveExtensionsList" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We do use ListView.Header
which neither ItemsRepeater
nor ItemsControl
have, we could mimic it with a Grid or something but might as well just use ListView.Header
I think
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright! Finally finished reviewing everything. Left a bunch of comments all around. Tried to test things out with the bug bash build as I went and did some accessibility testing too. I recommend that after you get the accessibility stuff in, you run it through Accessibility Insights' FastPass to check for common issues. That said, I think once you fix the comments I added in, you should be pretty much good to go there.
There's a bit more cacheing that can be done. I think it's worth it since we've got A TON of commands/actions. There was also a concern I had about null-checking somewhere in there so we probably want to fix that.
The ArgsWrapper stuff is really cool. Good work all-around dude 😊. Excited to see this land when you make the changes. We're close!
@@ -18,383 +24,1194 @@ using namespace winrt::Windows::UI::Xaml::Data; | |||
using namespace winrt::Windows::UI::Xaml::Navigation; | |||
using namespace winrt::Microsoft::Terminal::Settings::Model; | |||
|
|||
// todo: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair. We should file an issue and link it here for tracking.
I wonder if in the near term, we could add support for them, but just expose a text box. It wouldn't be ideal, but we'd still show the actions in the main list and users would be able to view/modify them. Then a cleaner UI could be added in later (possibly even by the community).
std::vector<winrt::Microsoft::Terminal::Settings::Editor::EnumEntry> enumList; \ | ||
const auto mappings = winrt::Microsoft::Terminal::Settings::Model::EnumMappings::enumMappingsName(); \ | ||
enumType unboxedValue; \ | ||
auto nullEntry = winrt::make<winrt::Microsoft::Terminal::Settings::Editor::implementation::EnumEntry>(RS_(L"Actions_NullEnumValue"), nullptr); \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Somewhere I mentioned that we should provide a more specific string for the null value. Looks like this is the spot to do it. You can probably just move the resource ID into the macro definition
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are only two nullable args here that this applies to - CopyFormatting
(in CopyText
) and TabSwitcherMode
(in PrevTab
/NextTab
) and setting those args to null means the same for both of them: follow the global setting. Any ideas for the more specific string for either?
// unboxing functions | ||
winrt::hstring UnboxString(const Windows::Foundation::IInspectable& value); | ||
winrt::hstring UnboxGuid(const Windows::Foundation::IInspectable& value); | ||
int32_t UnboxInt32(const Windows::Foundation::IInspectable& value); | ||
float UnboxInt32Optional(const Windows::Foundation::IInspectable& value); | ||
uint32_t UnboxUInt32(const Windows::Foundation::IInspectable& value); | ||
float UnboxUInt32Optional(const Windows::Foundation::IInspectable& value); | ||
float UnboxUInt64(const Windows::Foundation::IInspectable& value); | ||
float UnboxFloat(const Windows::Foundation::IInspectable& value); | ||
bool UnboxBool(const Windows::Foundation::IInspectable& value); | ||
winrt::Windows::Foundation::IReference<bool> UnboxBoolOptional(const Windows::Foundation::IInspectable& value); | ||
winrt::Windows::Foundation::IReference<Microsoft::Terminal::Core::Color> UnboxTerminalCoreColorOptional(const Windows::Foundation::IInspectable& value); | ||
winrt::Windows::Foundation::IReference<Microsoft::Terminal::Core::Color> UnboxWindowsUIColorOptional(const Windows::Foundation::IInspectable& value); | ||
|
||
// bind back functions | ||
void StringBindBack(const winrt::hstring& newValue); | ||
void GuidBindBack(const winrt::hstring& newValue); | ||
void Int32BindBack(const double newValue); | ||
void Int32OptionalBindBack(const double newValue); | ||
void UInt32BindBack(const double newValue); | ||
void UInt32OptionalBindBack(const double newValue); | ||
void UInt64BindBack(const double newValue); | ||
void FloatBindBack(const double newValue); | ||
void BoolOptionalBindBack(const Windows::Foundation::IReference<bool> newValue); | ||
void TerminalCoreColorBindBack(const winrt::Windows::Foundation::IReference<Microsoft::Terminal::Core::Color> newValue); | ||
void WindowsUIColorBindBack(const winrt::Windows::Foundation::IReference<Microsoft::Terminal::Core::Color> newValue); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are all pretty simple functions, and that's great. Would there be any benefit to moving these over to be converters so they can be used throughout the project? Or am I overengineering it? 😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The BindBack
functions all need to stay here since it involves modifying the underlying data, so I figured it would be cleaner if we just leave the Unbox
functions here too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to move just the unbox ones over to converters if we feel strongly about it though
…ettings_actions_editor
Oh! Also add in the "New" badge. You should be able to add it like the same way I did for the Extensions page. Just look at |
Summary of the Pull Request
Targets #18915
The actions page now has a list of all the commands (default, user, fragments etc) and clicking a command from that page brings you to an "Edit action" page where you can fully view and edit both the action type and any additional arguments.
One todo remaining that shouldn't block reviews:
Detailed Description of the Pull Request / Additional comments
Actions View Model
CommandViewModel
(view model for aCommand
), a list of these is created and managed byActionsViewModel
ActionArgsViewModel
(view model for anActionArgs
), created and managed byCommandViewModel
ArgWrapper
(view model for each individual argument inside anActionArgs
), created and managed byActionArgsViewModel
Actions page
EditAction page
CommandViewModel
Validation Steps Performed
Bug bashed
PR Checklist